Module compass

Contains Compass and CompassReference, ways of measuring physical angles on a Sphere or Ellipse.

Structs

AzimuthType

AzimuthType is used as a compile-time check for Azimuth = Compass<AzimuthType>

BearingType

BearingType is used as a compile-time check for Bearing = Compass<BearingType>

Compass

Represents a compass needle and the direction that it’s pointing

CompassOffset

Represents a relative angle from a particular zero point that’s not a standard reference like North or East. Used for “relative bearings” and the like where the angle is referenced to the heading of an entity (like, 10 degrees to the right)

CourseType

CourseType is used as a compile-time check for Course = Compass<CourseType>

HeadingType

HeadingType is used as a compile-time check for Heading = Compass<HeadingType>

TrackType

TrackType is used as a compile-time check for Track = Compass<TrackType>

Enums

CompassDirection

Represents a generic compass direction, any one of Heading, Track, Bearing, Course or Azimuth

CompassReference

The “zero” reference point for a compass needle

RotationDirection

The direction that a compass needle moves for “positive” increases

Type Aliases

Azimuth

Represents a azimuth - the compass direction of a generic pointing angle

Bearing

Represents a bearing - the compass direction of your desired destination

Course

Represents a course - the compass direction of your desired track

Heading

Represents a heading - the compass direction that the entity is pointing

RelativeBearing

Represents the relative angle from a particular entities heading

Track

Represents a track - the compass direction that the entity is travelling