Struct building_blocks_core::point::PointN

pub struct PointN<N>(pub N);

An N-dimensional point (where N=2 or N=3), which is usually just a primitive array like [i32; 2] or [i32; 3]. It is most convenient to construct points of any dimension as:

use building_blocks_core::PointN;

let p2 = PointN([1, 2]); // 2D
let p3 = PointN([1, 2, 3]); // 3D

Points support basic linear algebraic operations such as addition, subtraction, scalar multiplication, and scalar division.

let p1 = PointN([1, 2]);
let p2 = PointN([3, 4]);

assert_eq!(p1 + p2, PointN([4, 6]));
assert_eq!(p1 - p2, PointN([-2, -2]));

assert_eq!(p1 * 2, PointN([2, 4]));
assert_eq!(p1 / 2, PointN([0, 1]));

// Also some component-wise operations.
assert_eq!(p1 * p2, PointN([3, 8]));
assert_eq!(p1 / p2, PointN([0, 0]));
assert_eq!(p2 / p1, PointN([3, 2]));

There is also a partial order defined on points which says that a point A is greater than a point B if and only if all of the components of point A are greater than point B. This is useful for easily checking is a point is inside of the extent between two other points:

let min = PointN([0, 0, 0]);
let least_upper_bound = PointN([3, 3, 3]);

let p = PointN([0, 1, 2]);
assert!(min <= p && p < least_upper_bound);

Implementations

impl<T> PointN<[T; 2]>

pub fn x_mut(&mut self) -> &mut T

pub fn y_mut(&mut self) -> &mut T

impl<T> PointN<[T; 2]> where
    T: Copy, 

pub fn x(&self) -> T

pub fn y(&self) -> T

pub fn yx(&self) -> Self

impl<T> PointN<[T; 2]> where
    T: Copy + Integer, 

pub fn vector_div_floor(&self, rhs: &Self) -> Self

pub fn scalar_div_floor(&self, rhs: T) -> Self

impl PointN<[f32; 2]>

pub fn round(&self) -> Self

pub fn floor(&self) -> Self

impl PointN<[f32; 2]>

pub fn as_2i(&self) -> Point2i

pub fn in_pixel(&self) -> Point2i

impl<T> PointN<[T; 3]>

pub fn x_mut(&mut self) -> &mut T

pub fn y_mut(&mut self) -> &mut T

pub fn z_mut(&mut self) -> &mut T

impl<T> PointN<[T; 3]> where
    T: Copy, 

pub fn x(&self) -> T

pub fn y(&self) -> T

pub fn z(&self) -> T

pub fn xy(&self) -> Point2<T>

pub fn yx(&self) -> Point2<T>

pub fn yz(&self) -> Point2<T>

pub fn zy(&self) -> Point2<T>

pub fn zx(&self) -> Point2<T>

pub fn xz(&self) -> Point2<T>

pub fn yzx(&self) -> Point3<T>

pub fn zxy(&self) -> Point3<T>

pub fn zyx(&self) -> Point3<T>

impl<T> PointN<[T; 3]> where
    T: Copy + Mul<Output = T> + Sub<Output = T>, 

pub fn cross(&self, other: &Self) -> Self

impl<T> PointN<[T; 3]> where
    T: Copy + Integer, 

pub fn vector_div_floor(&self, rhs: &Self) -> Self

pub fn scalar_div_floor(&self, rhs: T) -> Self

impl PointN<[f32; 3]>

pub fn round(&self) -> Self

pub fn floor(&self) -> Self

impl PointN<[f32; 3]>

pub fn as_3i(&self) -> Point3i

pub fn in_voxel(&self) -> Point3i

Trait Implementations

impl<T> Add<PointN<[T; 2]>> for Point2<T> where
    T: Copy + AddAssign, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<PointN<[T; 3]>> for PointN<[T; 3]> where
    T: AddAssign + Copy, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<PointN<T>> for ExtentN<T> where
    PointN<T>: Add<Output = PointN<T>>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: PointN<T>) -> Self::Output

Performs the + operation.

impl<N> AddAssign<PointN<N>> for PointN<N> where
    N: Copy,
    PointN<N>: Add<Output = Self>, 

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T> AddAssign<PointN<T>> for ExtentN<T> where
    Self: Copy + Add<PointN<T>, Output = ExtentN<T>>, 

fn add_assign(&mut self, rhs: PointN<T>)

Performs the += operation.

impl<N: Clone> Clone for PointN<N>

fn clone(&self) -> PointN<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Copy> Copy for PointN<N>

impl<N: Debug> Debug for PointN<N>

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

Formats the value using the given formatter.

impl<N: Default> Default for PointN<N>

fn default() -> PointN<N>

Returns the "default value" for a type.

impl<'de, N> Deserialize<'de> for PointN<N> where
    N: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Div<PointN<[f32; 2]>> for Point2f

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl Div<PointN<[f32; 3]>> for Point3f

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl Div<PointN<[i32; 2]>> for Point2i

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Point2i) -> Self

Performs the / operation.

impl Div<PointN<[i32; 3]>> for Point3i

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Point3i) -> Self

Performs the / operation.

impl<N: Eq> Eq for PointN<N>

impl From<PointN<[i32; 2]>> for Point2f

fn from(p: Point2i) -> Self

Performs the conversion.

impl From<PointN<[i32; 3]>> for Point3f

fn from(p: Point3i) -> Self

Performs the conversion.

impl<N: Hash> Hash for PointN<N>

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<T> Mul<PointN<[T; 2]>> for Point2<T> where
    T: Copy + Mul<Output = T>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<PointN<[T; 3]>> for Point3<T> where
    T: Copy + Mul<Output = T>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<N> Neg for PointN<N> where
    N: Copy,
    PointN<N>: Sub<Output = Self> + Zero, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<N: PartialEq> PartialEq<PointN<N>> for PointN<N>

fn eq(&self, other: &PointN<N>) -> bool

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

fn ne(&self, other: &PointN<N>) -> bool

This method tests for !=.

impl<T> PartialOrd<PointN<[T; 2]>> for Point2<T> where
    T: Copy + PartialOrd, 

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

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

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

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

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

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

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

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

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

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

impl<T> PartialOrd<PointN<[T; 3]>> for Point3<T> where
    T: Copy + PartialOrd, 

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

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

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

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

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

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

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

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

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

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

impl<N> Serialize for PointN<N> where
    N: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<N> StructuralEq for PointN<N>

impl<N> StructuralPartialEq for PointN<N>

impl<T> Sub<PointN<[T; 2]>> for Point2<T> where
    T: Copy + SubAssign, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<PointN<[T; 3]>> for PointN<[T; 3]> where
    T: SubAssign + Copy, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<PointN<T>> for ExtentN<T> where
    PointN<T>: Sub<Output = PointN<T>>, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<N> SubAssign<PointN<N>> for PointN<N> where
    N: Copy,
    PointN<N>: Sub<Output = Self>, 

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T> SubAssign<PointN<T>> for ExtentN<T> where
    Self: Copy + Sub<PointN<T>, Output = ExtentN<T>>, 

fn sub_assign(&mut self, rhs: PointN<T>)

Performs the -= operation.

impl<N> Zero for PointN<N> where
    Self: Point + SmallZero, 

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.