Struct TreadFlight 

pub struct TreadFlight { /* private fields */ }

A stair flight measured from its body.

The flight rises from base, its body’s lowest point, through its treads in ascending order, to top, its body’s highest point. The first riser runs from the base to the first tread: the flight is taken to stand on the level it starts from. When the top lies above the last tread, the flight ends in a riser from the last tread to the top, meeting the upper floor; when it lies no higher than the last tread’s surface, the last tread is the top step. A top the intervals cannot place either way is refused.

Implementations

impl TreadFlight

pub fn try_new( request: TreadFlightRequest, walking_line: WalkingLine, base: ElevationInterval, top: ElevationInterval, treads: Vec<Tread>, evidence: Evidence, ) -> Result<Self, WalkingSurfaceError>

The flight answering request, climbing along walking_line.

Treads must be given bottom to top, strictly ascending in elevation and in front position; the base must lie below the first tread and the top at or above the last, decidably. A straight line must be horizontal, a turning one at least two distinct plan points. The evidence is exact exactly when every position is a point.

pub fn with_final_riser(self, riser: RiserClosure) -> Self

The flight with whether its final riser, from the last tread to the top, closes the step; ignored when the flight ends on its last tread.

pub fn request(&self) -> &TreadFlightRequest

The request this answers.

pub fn object(&self) -> &ObjectId

The measured object.

pub fn walking_line(&self) -> &WalkingLine

The line the flight climbs along.

pub fn base(&self) -> ElevationInterval

Elevation of the body’s lowest point, where the first riser starts.

pub fn top(&self) -> ElevationInterval

Elevation of the body’s highest point.

pub fn treads(&self) -> &[Tread]

The treads, bottom to top.

pub fn ends_in_riser(&self) -> bool

Whether the flight ends in a riser above its last tread.

pub fn risers(&self) -> Vec<MeasuredInterval>

Riser heights, bottom to top: from the base to the first tread, between consecutive treads, and from the last tread to the top when the flight ends in a riser. Their number is the flight’s number of risers (steps).

pub fn riser_closures(&self) -> Vec<RiserClosure>

Whether each riser closes its step, in the order of Self::risers: the riser below each tread, then the final riser when the flight ends in one.

pub fn goings(&self) -> Vec<MeasuredInterval>

Goings, bottom to top: the distance along the walking line from each tread’s nosing to the next one’s. A flight of n treads has n - 1 goings.

pub fn nosings(&self) -> Vec<MeasuredInterval>

Nosing projections, bottom to top: how far each tread above the first reaches over the tread below it, the lower tread’s back less the upper tread’s front. Zero or less where it does not overhang.

pub fn winder_angles(&self) -> Vec<Option<MeasuredInterval>>

Winder angles, bottom to top: for each tread below the last, the plan angle between its nosing and the next tread’s, 0 for a straight tread. None where a nosing is not measured or too short for its uncertainty to fix a direction.

pub fn rise(&self) -> MeasuredInterval

The flight’s rise: from the base to the top of its last riser.

pub fn width(&self) -> Option<MeasuredInterval>

The flight’s width: its narrowest tread’s, when every tread’s sides were measured.

pub fn is_exact(&self) -> bool

Whether every position is known exactly.

pub fn evidence(&self) -> &Evidence

Reviewable provenance of the measurement.

Trait Implementations

impl Clone for TreadFlight

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreadFlight

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

Formats the value using the given formatter.

impl PartialEq for TreadFlight

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TreadFlight