Struct PathPiece 

#[non_exhaustive]
pub struct PathPiece {
    pub curve: PathCurve,
    pub start: f64,
    pub end: f64,
    pub reversed: bool,
    pub placement: Option<DAffine3>,
    pub placement_exact: bool,
    pub open_end: bool,
    pub start_bound: Option<PathBound>,
    pub end_bound: Option<PathBound>,
}

One piece of a CurvePath: the span [start, end] of a curve in its station measure, traversed forwards or backwards, optionally carried by a rigid placement; see the module documentation.

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.

curve: PathCurve

The curve.

start: f64

Where the span starts, in the curve’s station measure from its start (negative only on a line).

end: f64

Where the span ends; a measurable piece has end > start. Not read where the end is open (Self::open_end).

reversed: bool

Whether the path runs from end to start.

placement: Option<DAffine3>

The rigid motion carrying the curve, if it is placed.

placement_exact: bool

Whether that placement is exact, rounding aside (true with no placement).

open_end: bool

Whether the span runs to the curve’s end, which the evaluator resolves with its own length (#298; see the module documentation); end is then not read.

start_bound: Option<PathBound>

Where the span starts when that is given as a parameter or a point rather than a distance (#304; see the module documentation); start is then not read.

end_bound: Option<PathBound>

Where the span ends when that is given as a parameter or a point (#304); end is then not read. An end is bounded or open, not both: an evaluator refuses a piece whose end is both.

Implementations

impl PathPiece

pub fn new(curve: PathCurve, start: f64, end: f64) -> PathPiece

The span [start, end] of curve, forwards and unplaced.

Nothing is checked here: an evaluator refuses a span that is empty, not finite or outside its curve when it reads the path.

pub fn to_end(curve: PathCurve, start: f64) -> PathPiece

The span of curve from start to its end, forwards and unplaced, the end left to the evaluator (#298; see the module documentation).

Nothing is checked here: an evaluator refuses a start that is not finite, or not before the curve’s end, when it reads the path.

pub fn from_start(curve: PathCurve, end: f64) -> PathPiece

The span of curve from its start to end: [0, end], the station measure starting at 0 on every curve.

pub fn whole(curve: PathCurve) -> PathPiece

The whole of curve, from its start to its end, no length stated (#298): Self::to_end from 0. An unbounded line is its parameter domain, from its origin to origin + direction.

pub fn between_parameters(curve: PathCurve, t0: f64, t1: f64) -> PathPiece

The span of curve from its native parameter t0 to t1, t0 < t1 (except on a closed conic, below), forwards and unplaced, no distance stated (#304; see the module documentation). A closed conic’s angle runs round: its span runs from t0 forwards to t1 within one turn, across its parameter seam where t1 comes before t0, as a trim of it in its sense does.

Nothing is checked here: an evaluator refuses parameters that are not finite, not increasing or outside the curve when it reads the path.

pub fn bounded(curve: PathCurve, start: PathBound, end: PathBound) -> PathPiece

The span of curve from start to end, each a parameter or a point, forwards and unplaced, no distance stated (#304). Both lie in the curve’s direction; on a closed conic the span runs from the start forwards to the end within one turn.

Nothing is checked here: an evaluator refuses a point off the curve or named by several parameters, and an empty span, when it reads the path.

pub fn with_start(self, bound: PathBound) -> PathPiece

The same piece starting at bound rather than at a stated distance (#304): start then holds -Scalar::INFINITY, which nothing reads.

pub fn with_end(self, bound: PathBound) -> PathPiece

The same piece ending at bound rather than at a stated distance or at its curve’s end (#304): end then holds Scalar::INFINITY, which nothing reads, and the end is no longer open.

pub fn reversed(self) -> PathPiece

The same span traversed the other way.

pub fn placed(self, rigid: DAffine3, exact: bool) -> PathPiece

The same piece carried further by the rigid motion rigid, applied after any placement it already has; exact when that motion is.

pub fn length(&self) -> f64

The span’s length in its curve’s station measure, end - start; infinite where the end is open or an end is bounded by a parameter or a point, which only an evaluator resolves.

pub fn is_stated(&self) -> bool

Whether every length the piece spans is stated: its own ends (not open, #298, nor bounded by a parameter or a point, #304), and its offset’s base piece’s.

pub fn frame_is_exact(&self) -> bool

Whether a frame read on this piece is exact, rounding aside: a line (an offset of a line by a constant law included), placed, if at all, exactly.

Trait Implementations

impl Clone for PathPiece

fn clone(&self) -> PathPiece

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathPiece

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

Formats the value using the given formatter.

impl Extend<PathPiece> for CurvePath

fn extend<I>(&mut self, pieces: I)

where I: IntoIterator<Item = PathPiece>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<PathPiece> for CurvePath

fn from(piece: PathPiece) -> CurvePath

Converts to this type from the input type.

impl From<StationPiece<'_>> for PathPiece

fn from(piece: StationPiece<'_>) -> PathPiece

The piece, its curve copied.

impl FromIterator<PathPiece> for CurvePath

fn from_iter<I>(pieces: I) -> CurvePath

where I: IntoIterator<Item = PathPiece>,

Creates a value from an iterator.

impl PartialEq for PathPiece

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PathPiece