Struct fj_math::Point

#[repr(C)]
pub struct Point<const D: usize> {
    pub coords: Vector<D>,
}

An n-dimensional point

The dimensionality of the point is defined by the const generic D parameter.

Fields

coords: Vector<D>

The coordinates of the point

Implementations

impl<const D: usize> Point<D>

pub fn origin() -> Self

Construct a Point at the origin of the coordinate system

pub fn from_array(array: [f64; D]) -> Self

Construct a Point from an array

pub fn from_na(point: Point<f64, D>) -> Self

Construct a Point from an nalgebra vector

pub fn to_na(self) -> Point<f64, D>

Convert the point into an nalgebra point

pub fn to_t(self) -> Point<1>

Convert to a 1-dimensional point

pub fn to_xyz(self) -> Point<3>

Convert to a 3-dimensional point

See Vector::to_xyz for details. This method follows the same rules.

pub fn distance(p1: &Point<D>, p2: &Point<D>) -> Scalar

Gives the distance between two points.

Trait Implementations

impl<const D: usize> AbsDiffEq<Point<D>> for Point<D>

type Epsilon = <Vector<D> as AbsDiffEq<Vector<D>>>::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<V, const D: usize> Add<V> for Point<D>where
    V: Into<Vector<D>>,

type Output = Point<D>

The resulting type after applying the + operator.

fn add(self, rhs: V) -> Self::Output

Performs the + operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<const D: usize> Default for Point<D>

fn default() -> Point<D>

Returns the “default value” for a type.

impl Deref for Point<1>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for Point<2>

type Target = Uv

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for Point<3>

type Target = Xyz

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Point<1>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for Point<2>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DerefMut for Point<3>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<const D: usize> From<[Scalar; D]> for Point<D>

fn from(array: [Scalar; D]) -> Self

Converts to this type from the input type.

impl<const D: usize> From<[f64; D]> for Point<D>

fn from(array: [f64; D]) -> Self

Converts to this type from the input type.

impl<const D: usize> From<OPoint<f64, Const<D>>> for Point<D>

fn from(point: Point<f64, D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Point<D>> for [Scalar; D]

fn from(point: Point<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Point<D>> for [f32; D]

fn from(point: Point<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Point<D>> for [f64; D]

fn from(point: Point<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> Hash for Point<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> Mul<f64> for Point<D>

type Output = Point<D>

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl<const D: usize> Neg for Point<D>

type Output = Point<D>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const D: usize> Ord for Point<D>

fn cmp(&self, other: &Point<D>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

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

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

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

const 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<Point<D>> for Point<D>

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

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

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

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

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

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

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

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

const 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> Sub<Point<D>> for &Point<D>

type Output = Vector<D>

The resulting type after applying the - operator.

fn sub(self, rhs: Point<D>) -> Self::Output

Performs the - operation.

impl<const D: usize> Sub<Point<D>> for Point<D>

type Output = Vector<D>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<V, const D: usize> Sub<V> for Point<D>where
    V: Into<Vector<D>>,

type Output = Point<D>

The resulting type after applying the - operator.

fn sub(self, rhs: V) -> Self::Output

Performs the - operation.

impl<const D: usize> Copy for Point<D>

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

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

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