Struct fj_math::Point

source · [−]

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

Expand description

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. Read more

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. Read more

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. Read more

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

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

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

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

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

Formats the value using the given formatter. Read more

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. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

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. Read more

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. Read more

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

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

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 ==. Read more

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

This method tests for !=.

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. Read more

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

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. Read more

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. Read more

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. Read more

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>

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> ClosedNeg for T where
T: Neg<Output = T>,

impl<T> Scalar for T where
T: 'static + Clone + PartialEq<T> + Debug,