Struct Compass

pub struct Compass<T> { /* private fields */ }

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

Implementations

impl<T> Compass<T>

pub const fn new_heading( angle: Angle, direction: RotationDirection, reference: CompassReference, ) -> Compass<HeadingType>

Creates a new heading type - see HeadingType for details.

pub const fn new_track( angle: Angle, direction: RotationDirection, reference: CompassReference, ) -> Compass<TrackType>

Creates a new track type - see Track for details.

pub const fn new_bearing( angle: Angle, direction: RotationDirection, reference: CompassReference, ) -> Compass<BearingType>

Creates a new bearing type - see Bearing for details.

pub const fn new_course( angle: Angle, direction: RotationDirection, reference: CompassReference, ) -> Compass<CourseType>

Creates a new course type - see Course for details.

pub const fn new_azimuth( angle: Angle, direction: RotationDirection, reference: CompassReference, ) -> Compass<AzimuthType>

Creates a new azimuth type - see Azimuth for details.

pub const fn angle(&self) -> &Angle

pub const fn direction(&self) -> &RotationDirection

pub const fn reference(&self) -> &CompassReference

pub fn as_direction_reference( &self, direction: RotationDirection, reference: CompassReference, ) -> Compass<T>

impl Compass<HeadingType>

pub fn relative_bearing( self, direction: RotationDirection, offset: Angle, ) -> RelativeBearing

Converts this heading into a relative bearing using the specified offset and direction

Trait Implementations

impl<T: Clone> Clone for Compass<T>

fn clone(&self) -> Compass<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Compass<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default> Default for Compass<T>

fn default() -> Compass<T>

Returns the “default value” for a type.

impl<T> Display for Compass<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Compass<T>

fn eq(&self, other: &Compass<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy> Copy for Compass<T>

impl<T> StructuralPartialEq for Compass<T>