Struct Deflection 

pub struct Deflection {
    pub chord: f64,
    pub angular: f64,
    pub min_segments: usize,
    pub max_segments: usize,
}

How finely to approximate a curve.

Fields

chord: f64

The greatest allowed distance from the polyline to the curve.

angular: f64

The greatest allowed turn in the tangent across one segment, in radians.

min_segments: usize

A floor on the number of segments for a curve that bends.

A closed curve needs at least three to enclose anything, and a nearly straight arc of one would otherwise collapse to a chord that misses the bulge entirely: the midpoint test is a sample, and one sample can be placed exactly where the curve happens to cross its own chord.

It does not apply to a straight curve, which is exactly represented by its endpoints. Splitting a line adds points that no tolerance asked for, and every one of them becomes a vertex in every face the edge bounds.

max_segments: usize

A ceiling, so a pathological curve cannot exhaust memory.

Reaching it is reported rather than passed off as success; see Polyline::deflection_met.

Implementations

impl Deflection

pub fn with_chord(chord: f64) -> OgeomResult<Self>

A deflection with a given chord tolerance and the default angular one.

Errors

OgeomError::Construction if chord is not finite and positive.

pub fn relative(size: f64, fraction: f64) -> OgeomResult<Self>

A deflection scaled to a model of the given size.

Relative tolerances are what a caller usually means: “a thousandth of the part” is a statement that survives the part being modelled in metres rather than millimetres, and an absolute default does not.

Errors

OgeomError::Construction if size or fraction is not finite and positive.

pub fn validate(&self) -> OgeomResult<()>

Check that the settings are usable.

Errors

OgeomError::Construction if a tolerance is not positive, or the segment bounds are inconsistent.

Trait Implementations

impl Clone for Deflection

fn clone(&self) -> Deflection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Deflection

impl Debug for Deflection

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

Formats the value using the given formatter.

impl Default for Deflection

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Deflection

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Deflection