Enum fj_kernel::objects::CurveKind

pub enum CurveKind<const D: usize> {
    Circle(Circle<D>),
    Line(Line<D>),
}

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.

The D parameter defines the dimensions in which the curve is defined. Typically, only 2 or 3 make sense, which means the curve is defined on a surface or in a space, respectively.

Variants

Circle(Circle<D>)

A circle

Line(Line<D>)

A line

Implementations

impl<const D: usize> CurveKind<D>

pub fn line_from_points(points: [impl Into<Point<D>>; 2]) -> Self

Construct a line from two points

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

Access the origin of the curve’s coordinate system

pub fn reverse(self) -> Self

Create a new instance that is reversed

pub fn point_from_curve_coords(&self, point: impl Into<Point<1>>) -> Point<D>

Convert a point on the curve into model coordinates

pub fn vector_from_curve_coords(&self, point: impl Into<Vector<1>>) -> Vector<D>

Convert a vector on the curve into model coordinates

impl CurveKind<3>

pub fn x_axis() -> Self

Construct a Curve that represents the x-axis

pub fn y_axis() -> Self

Construct a Curve that represents the y-axis

pub fn z_axis() -> Self

Construct a Curve that represents the z-axis

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

Transform the surface

Trait Implementations

impl<const D: usize> Clone for CurveKind<D>

fn clone(&self) -> CurveKind<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for CurveKind<D>

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

Formats the value using the given formatter.

impl<const D: usize> Hash for CurveKind<D>

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<const D: usize> Ord for CurveKind<D>

fn cmp(&self, other: &CurveKind<D>) -> 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 where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl<const D: usize> PartialEq<CurveKind<D>> for CurveKind<D>

fn eq(&self, other: &CurveKind<D>) -> bool

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

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

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

impl<const D: usize> PartialOrd<CurveKind<D>> for CurveKind<D>

fn partial_cmp(&self, other: &CurveKind<D>) -> 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<const D: usize> Copy for CurveKind<D>

impl<const D: usize> Eq for CurveKind<D>

impl<const D: usize> StructuralEq for CurveKind<D>

impl<const D: usize> StructuralPartialEq for CurveKind<D>