Struct Intrinsic3

Source
pub struct Intrinsic3 {
    pub start: Frame3,
    pub curvature: CurvatureLaw,
    pub torsion: CurvatureLaw,
    pub length: Scalar,
}
Expand description

A space curve given by its natural equations.

curvature is k(s) >= 0 by the Frenet convention; a signed law is storable, because dirty imported data stays representable here as everywhere else in this crate, and naming it is a validator’s job.

torsion is tau(s), signed: positive is a right-handed screw. Torsion identically zero is a plane curve, and the plane is the one spanned by the start frame’s x and y axes.

Both laws reuse CurvatureLaw, which is the general “scalar function of arc length” in this crate: constant, polynomial, sinusoid, their sum, and piecewise combinations. Nothing about it is curvature-specific, and a second near-identical enum for torsion would be duplication with a different name.

Fields§

§start: Frame3

Start frame: origin at the curve start, x along the start tangent, y along the start normal, z along the start binormal.

§curvature: CurvatureLaw

Curvature as a function of arc length from start.

§torsion: CurvatureLaw

Torsion as a function of arc length from start.

§length: Scalar

Arc length the laws are defined over.

Implementations§

Source§

impl Intrinsic3

Source

pub const fn new( start: Frame3, curvature: CurvatureLaw, torsion: CurvatureLaw, length: Scalar, ) -> Self

Anchor a curvature and a torsion law to a start frame over an arc length.

Source

pub fn is_planar(&self) -> bool

Whether the curve is planar: torsion identically zero.

A planar space curve is exactly a 2D curve embedded in the start frame’s plane, so this is the predicate that decides whether the cheaper 2D path applies.

Source

pub fn is_helical(&self) -> bool

Whether the curve is a helix: curvature and torsion both constant.

This is the case where the Frenet generators commute at every arc length, so the product integral collapses to a single matrix exponential and the curve has an elementary closed form. Worth naming because it is both the classical example and the exactly-solvable case.

Source

pub fn total_turning(&self) -> Option<Scalar>

Total tangent turning over the curve, in radians, in closed form.

The integral of k – exact, as in 2D. Note this is NOT enough to recover the frame in space, only the amount the tangent has swung.

Source

pub fn total_torsion(&self) -> Option<Scalar>

Total torsion over the curve, in radians, in closed form.

The integral of tau. For a helix this is the angle the binormal has swung about the axis.

Trait Implementations§

Source§

impl Clone for Intrinsic3

Source§

fn clone(&self) -> Intrinsic3

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Intrinsic3

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Intrinsic3

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for Intrinsic3

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.