Enum OffsetLaw 

#[non_exhaustive]
pub enum OffsetLaw {
    Planar {
        distance: f64,
    },
    Directed {
        distance: f64,
        reference_direction: DVec3,
    },
    Linear {
        start: PathOffsets,
        end: PathOffsets,
        frame: OffsetFrame,
    },
}

How far, and which way, an offset lies from its base piece.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Planar

A constant offset in the plane of a 2D base: distance along its left normal (an offset curve 2D, positive to the left).

Fields

distance: f64

The offset distance, positive to the left.

Directed

A constant 3D offset: distance along normalise(V x T), V the fixed reference_direction and T the base’s unit tangent (an offset curve 3D). T must nowhere be parallel to V.

Fields

distance: f64

The offset distance.

reference_direction: DVec3

The fixed reference direction V.

Linear

A displacement in the base’s frame, linear in the base’s measure from start at the base piece’s start to end at its end: one interval of an offset by distances at stations.

Fields

start: PathOffsets

The displacement at the base piece’s start.

end: PathOffsets

The displacement at the base piece’s end.

frame: OffsetFrame

The frame it is read in.

Implementations

impl OffsetLaw

pub fn is_constant(&self) -> bool

Whether the displacement is the same all along the base.

Trait Implementations

impl Clone for OffsetLaw

fn clone(&self) -> OffsetLaw

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OffsetLaw

impl Debug for OffsetLaw

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

Formats the value using the given formatter.

impl PartialEq for OffsetLaw

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OffsetLaw