Struct SectionFrame 

#[non_exhaustive]
pub struct SectionFrame {
    pub point: DVec3,
    pub tangent: DVec3,
    pub lateral: DVec3,
    pub up: DVec3,
}

A point on a curve and the section axes there: tangent, left lateral and up, unit and right-handed (up = tangent x lateral).

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.

point: DVec3

The curve point.

tangent: DVec3

Unit tangent, in the direction of increasing distance.

lateral: DVec3

Unit lateral axis, to the left of the tangent.

up: DVec3

Unit section up, tangent x lateral.

Implementations

impl SectionFrame

pub fn place(&self, lateral: f64, vertical: f64, longitudinal: f64) -> DVec3

The point offset from this frame’s point: lateral along the lateral axis (positive to the left), vertical along up and longitudinal along the tangent.

pub fn plan(&self) -> Result<SectionFrame, GeomError>

The same point framed vertically: the tangent’s horizontal projection, the horizontal left normal and +Z. Grade and bank are dropped.

Errors

A vertical tangent, which has no horizontal projection.

pub fn oriented( &self, axis: Option<DVec3>, ref_direction: Option<DVec3>, ) -> Result<SectionFrame, GeomError>

The same point with its axes turned by an explicit orientation (#246): axis and ref_direction are components in THIS frame, (tangent, lateral, up), defaulting to (0, 0, 1) and (1, 0, 0).

Gram-Schmidt with the axis primary: up' = axis / |axis|, tangent' = normalise(r - (r . up') up') for the unit reference direction r, lateral' = up' x tangent'. This is the reading of a linear placement’s Axis and RefDirection relative to the curve (see the module documentation).

Errors

A zero or non-finite vector, or an axis and reference direction parallel or anti-parallel within ORIENTATION_TOLERANCE, by name.

pub fn placement(&self) -> DAffine3

The rigid placement this frame stands for (#264): local x onto the tangent, y onto the lateral (to the left), z onto up, the local origin onto the point.

This is how a linear placement maps its local axes (buildingSMART IFC 4.3, IfcAxis2PlacementLinear: X the tangent, Y the left lateral, Z up), and how a node placed at a station is moved. It is not Self::frame’s provider layout (y up, z right).

pub fn moved(&self, rigid: DAffine3) -> SectionFrame

This frame carried by a rigid motion: the point by rigid, the axes by its linear part.

A section frame on a curve moved rigidly is the moved curve’s own only where its convention does not depend on the world: always for its tangent, and for the reference-up and plan frames only when rigid keeps +Z; checking that is the caller’s.

pub fn carried( &self, rigid: DAffine3, measure: DistanceConvention, ) -> Result<SectionFrame, GeomError>

This frame, read on a curve, as the section frame of that curve carried by the rigid motion rigid (#264, #285): the frame a station on the placed curve has, measure the convention the source curve is measured in.

Where rigid keeps +Z (within KEEPS_UP_TOLERANCE) this is Self::moved: the moved reference-up, planar or banked frame is the placed curve’s own, and plan distance is kept. Where it tilts +Z, an arc-length-measured curve (arc length is kept by any rigid motion) gets the reference-up frame against +Z of its moved point and tangent, which is the placed 3D curve’s own section frame; the moved frame would not be.

Errors

A plan-measured curve (elevated or banked) under a motion that tilts +Z, whose plan distance and section frame are not the placed curve’s, by a typed GeomError::UnsupportedInput; and a moved tangent with no reference-up frame (vertical), by name.

pub fn frame(&self) -> Frame3

The frame in the curve-evaluation provider’s layout: x the tangent, y up, z = x x y, which is -lateral (to the right).

Trait Implementations

impl Clone for SectionFrame

fn clone(&self) -> SectionFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SectionFrame

impl Debug for SectionFrame

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

Formats the value using the given formatter.

impl PartialEq for SectionFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SectionFrame