Struct CantLaw 

pub struct CantLaw {
    pub pieces: Vec<CantPiece>,
}

A scalar law over plan distance: pieces laid end to end from zero.

Piece i spans [sum of earlier lengths, + length_i); a seam belongs to the piece that starts there, and the last piece is closed at its far end. A distance before zero or past the last piece has no value: the law is not extrapolated, because an extrapolated transition is not a cant anyone authored.

Fields

pieces: Vec<CantPiece>

Pieces in order of plan distance.

Implementations

impl CantLaw

pub const fn new(pieces: Vec<CantPiece>) -> Self

A law from its pieces.

pub fn zero(length: Scalar) -> Self

Zero over length: the pivot law of a rotation about the centreline.

pub fn length(&self) -> Scalar

Total plan length the law covers.

pub fn seams(&self) -> Vec<Scalar>

Interior seams, in plan distance, ascending.

pub fn is_well_formed(&self) -> bool

Whether every piece has a positive finite length and finite coefficients, and there is at least one piece.

pub fn has_angle_pieces(&self) -> bool

Whether any piece gives a bank angle rather than a height.

pub fn has_rail_pieces(&self) -> bool

Whether any piece rotates about a held rail (CantForm::AboutRail), a pivot derived from the cant law.

pub fn value_at(&self, distance: Scalar) -> Option<CantValue>

Value at plan distance distance.

None when the law is malformed, distance is outside it, or the piece there is a held-rail pivot (CantForm::AboutRail), whose value comes from the cant law (Banked3::pivot_at).

pub fn rate_at(&self, distance: Scalar) -> Option<CantValue>

Rate of change per unit plan distance at distance, from the piece that owns it (the one starting there, at a seam).

Trait Implementations

impl Clone for CantLaw

fn clone(&self) -> CantLaw

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CantLaw

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

Formats the value using the given formatter.

impl Default for CantLaw

fn default() -> CantLaw

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CantLaw

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CantLaw

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CantLaw

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 CantLaw