gucoordinates
Public Attributes | List of all members
gu_relative_coordinate Struct Reference

A coordinate that is relative to some other coordinate. More...

#include <relative_coordinate.h>

Inheritance diagram for gu_relative_coordinate:
Inheritance graph
Collaboration diagram for gu_relative_coordinate:
Collaboration graph

Public Attributes

degrees_d direction
 The heading towards the coordinate. More...
 
millimetres_u distance
 The distance to the coordinate. More...
 

Detailed Description

A coordinate that is relative to some other coordinate.

This coordinate describes the distance and direction that one coordinate is from another. This means that the relative_coordinate is a polar coordinate in the form of phi, r where phi is the direction and r is the distance to the coordinate.

Definition at line 77 of file relative_coordinate.h.

Member Data Documentation

◆ direction

degrees_d gu_relative_coordinate::direction

The heading towards the coordinate.

A positive value for direction indicates that the coordinate is on the left. A negative value indicates that the coordinate is on the right. A value of zero indicates that the coordinate is pointing straight ahead.

Definition at line 87 of file relative_coordinate.h.

Referenced by CGTEST::RelativeCoordinateCPPTests::cchange(), GU::RelativeCoordinate::direction(), field_coord_to_rr_coord_to_target(), gu_camera_pivot_can_see_object(), gu_relative_coordinate_equals(), rr_coord_to_cartesian_coord(), rr_coord_to_cartesian_coord_from_field(), rr_coord_to_field_coord_from_source(), rr_coord_to_pct_coord(), GU::RelativeCoordinate::set_direction(), and CGTEST::TEST_F().

◆ distance

millimetres_u gu_relative_coordinate::distance

The documentation for this struct was generated from the following file: