Struct fj_kernel::geometry::Line

pub struct Line {
    pub origin: Point<3>,
    pub direction: Vector<3>,
}

A line, defined by a point and a vector

Fields

origin: Point<3>

The origin of the line’s coordinate system

direction: Vector<3>

The direction of the line

The length of this vector defines the unit of the line’s curve coordinate system. The coordinate 1. is always were the direction vector points, from origin.

Implementations

impl Line

pub fn from_points([a, b]: [Point<3>; 2]) -> Self

Create a line from two points

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 line 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 line, 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, vector: &Vector<1>) -> Vector<3>

Convert a vector on the curve into model coordinates

Trait Implementations

impl AbsDiffEq<Line> for Line

type Epsilon = <f64 as AbsDiffEq<f64>>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Clone for Line

fn clone(&self) -> Line

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Line

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

Formats the value using the given formatter.

impl Hash for Line

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 Line

fn cmp(&self, other: &Line) -> 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<Line> for Line

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

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

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

This method tests for !=.

impl PartialOrd<Line> for Line

fn partial_cmp(&self, other: &Line) -> 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 Line

impl Eq for Line

impl StructuralEq for Line

impl StructuralPartialEq for Line