Enum fj_kernel::geometry::Curve

pub enum Curve {
    Circle(Circle),
    Line(Line),
}

A one-dimensional shape

The word “curve” is used as an umbrella term for all one-dimensional shapes, and doesn’t imply that those shapes need to be curved. Straight lines are included.

The nomenclature is inspired by Boundary Representation Modelling Techniques by Ian Stroud. “Curve” refers to unbounded one-dimensional geometry, while while edges are bounded portions of curves.

Variants

Circle(Circle)

A circle

Line(Line)

A line

Implementations

impl Curve

pub fn x_axis() -> Self

Construct a Curve that represents the x-axis

pub fn origin(&self) -> Point<3>

Access the origin of the curve’s coordinate system

pub fn reverse(self) -> Self

Create a new instance that is reversed

pub fn transform(self, transform: &Transform) -> Self

Create a new instance that is transformed by transform

pub fn point_model_to_curve(&self, point: &Point<3>) -> Point<1>

Convert a point in model coordinates to curve coordinates

Projects the point onto the curve before computing curve coordinate. This is done to make this method robust against floating point accuracy issues.

Callers are advised to be careful about the points they pass, as the point not being on the curve, intentional or not, will never result in an error.

pub fn point_curve_to_model(&self, point: &Point<1>) -> Point<3>

Convert a point on the curve into model coordinates

pub fn vector_curve_to_model(&self, point: &Vector<1>) -> Vector<3>

Convert a vector on the curve into model coordinates

Trait Implementations

impl Clone for Curve

fn clone(&self) -> Curve

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Curve

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

Formats the value using the given formatter.

impl Hash for Curve

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Curve

fn cmp(&self, other: &Curve) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Curve> for Curve

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Curve> for Curve

fn partial_cmp(&self, other: &Curve) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Curve

impl Eq for Curve

impl Object for Curve

impl StructuralEq for Curve

impl StructuralPartialEq for Curve