Struct Direction 

pub struct Direction<F: Frame> { /* private fields */ }

Direction in [0°, 360°), tagged with its reference frame.

Courses and bearings share this type: within a frame they are the same quantity. The type prevents mixing frames.

Implementations

impl<F: Frame> Direction<F>

pub const NORTH: Self

Due north, 000°.

pub const EAST: Self

Due east, 090°.

pub const SOUTH: Self

Due south, 180°.

pub const WEST: Self

Due west, 270°.

pub fn new(degrees: f64) -> Result<Self>

Direction from a value in [0.0, 360.0]; 360.0 maps to 0.0.

Out-of-range values are rejected, not wrapped: 400° is more likely a typo or unit error than 040°. Use Direction::wrap to wrap.

Errors

KernelError::NotFinite for NaN or infinity; KernelError::OutOfRange outside [0.0, 360.0].

pub fn wrap(degrees: f64) -> Result<Self>

Direction from any finite value, normalised into [0.0, 360.0).

Errors

KernelError::NotFinite for NaN or infinity.

pub const fn degrees(self) -> f64

Degrees, in [0.0, 360.0).

pub fn radians(self) -> f64

Radians, in [0.0, 2π).

pub fn reciprocal(self) -> Self

Reciprocal direction.

pub fn components(self, magnitude: f64) -> (f64, f64)

North and east components of a vector of magnitude in this direction, in the magnitude’s unit.

The single place where velocity triangles (current triangle, relative motion, drift) resolve their sides.

pub fn offset(self, delta: f64) -> Result<Self>

Rotates by delta degrees, wrapping.

Errors

KernelError::NotFinite if delta is not finite.

pub fn signed_difference(self, other: Self) -> f64

Signed shortest angle from self to other, in [-180.0, 180.0); positive clockwise.

pub fn angular_distance(self, other: Self) -> f64

Unsigned shortest angle between two directions, in [0.0, 180.0].

Trait Implementations

impl<F: Clone + Frame> Clone for Direction<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Copy + Frame> Copy for Direction<F>

impl<F: Frame> Debug for Direction<F>

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

Formats the value using the given formatter.

impl<F: Default + Frame> Default for Direction<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Frame> Display for Direction<F>

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

Formats as 045.0°T.

impl<F: Frame> From<CardinalPoint> for Direction<F>

fn from(point: CardinalPoint) -> Self

The point as a direction in any frame; the point itself has no frame.

impl<F: PartialEq + Frame> PartialEq for Direction<F>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<F: PartialOrd + Frame> PartialOrd for Direction<F>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<F: PartialEq + Frame> StructuralPartialEq for Direction<F>