Struct StationOrientation 

#[non_exhaustive]
pub struct StationOrientation {
    pub axis: Option<Vec3>,
    pub ref_direction: Option<Vec3>,
}

An explicit in-section orientation at a station (#246).

Both vectors are components in the station’s base frame, (tangent, lateral, up); see the module documentation for their meaning, defaults and orthonormalisation. Both absent is the base frame itself, the Default.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

axis: Option<Vec3>

The oriented frame’s up (local Z), exact; None for (0, 0, 1).

ref_direction: Option<Vec3>

The direction the oriented frame’s tangent role (local X) is taken from, made perpendicular to the axis; None for (1, 0, 0).

Implementations

impl StationOrientation

pub const fn new(axis: Option<Vec3>, ref_direction: Option<Vec3>) -> Self

An orientation from an optional axis and reference direction, both in the base frame.

pub const fn is_base(&self) -> bool

Whether neither vector is given, so the base frame is used as is.

pub fn unit_axes(&self) -> Result<(Vec3, Vec3), &'static str>

The unit axis and unit reference direction, defaults filled in.

Errors

Why there are none, worded for GraphError::InvalidStation: a zero or non-finite vector, or the two parallel or anti-parallel within ORIENTATION_TOLERANCE.

Trait Implementations

impl Clone for StationOrientation

fn clone(&self) -> StationOrientation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StationOrientation

impl Debug for StationOrientation

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

Formats the value using the given formatter.

impl Default for StationOrientation

fn default() -> StationOrientation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StationOrientation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StationOrientation

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StationOrientation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StationOrientation