Struct CantFrame 

#[non_exhaustive]
pub struct CantFrame {
    pub distance_along: f64,
    pub left: f64,
    pub right: f64,
    pub cant: f64,
    pub axis_elevation: f64,
    pub bank_angle: f64,
    pub lateral: Vec2,
    pub up: Vec2,
}

The cant cross-section at one station.

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.

distance_along: f64

Absolute distance along the horizontal alignment, in metres.

left: f64

Left rail head above the vertical profile, in metres.

right: f64

Right rail head above the vertical profile, in metres.

cant: f64

Cant D = left - right, positive when the left rail is higher.

axis_elevation: f64

Elevation of the section’s rotation point above the vertical profile: (left + right) / 2.

bank_angle: f64

Bank angle psi = arcsin(D / b) in radians, positive raising the left rail (counter-clockwise looking along the tangent).

lateral: Vec2

Rail-to-rail axis (towards the left rail) as (n, u) components.

up: Vec2

Section up axis as (n, u) components.

Implementations

impl CantFrame

pub fn orient(&self, point: Point3, tangent: Vec3) -> AlignmentResult<Frame3>

The section frame in world coordinates.

point and tangent are the gradient curve’s point and 3D tangent at this frame’s station, from the caller’s evaluator. The origin is point raised by Self::axis_elevation along world up (the cant is measured vertically from the profile); x is the unit tangent, y the rail-to-rail axis and z the section up axis.

Errors

Refuses a non-finite point or tangent, and a vertical or zero tangent, which has no horizontal left normal.

Trait Implementations

impl Clone for CantFrame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CantFrame

impl Debug for CantFrame

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

Formats the value using the given formatter.

impl PartialEq for CantFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CantFrame