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);

Tuple Fields

0: N

Implementations

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

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

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

pub fn axis_component_mut(&mut self, axis: Axis2) -> &mut T

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

pub fn axis_component(self, axis: Axis2) -> T

pub fn x(self) -> T

pub fn y(self) -> T

pub fn yx(self) -> Self

impl PointN<[i32; 2]>

pub const SQUARE_CORNER_OFFSETS: [Self; 4]

pub const VON_NEUMANN_OFFSETS: [Self; 4]

pub const MOORE_OFFSETS: [Self; 8]

impl PointN<[f32; 2]>

pub fn in_pixel(self) -> Point2i

Returns the coordinates of the pixel containing self.

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

pub fn axis_component_mut(&mut self, axis: Axis3) -> &mut T

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

pub fn axis_component(self, axis: Axis3) -> T

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) -> Self

pub fn zxy(self) -> Self

pub fn zyx(self) -> Self

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

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

impl PointN<[i32; 3]>

pub const CUBE_CORNER_OFFSETS: [Self; 8]

pub const VON_NEUMANN_OFFSETS: [Self; 6]

pub const MOORE_OFFSETS: [Self; 26]

impl PointN<[f32; 3]>

pub fn in_voxel(self) -> Point3i

Returns the coordinates of the voxel containing self.

impl<N> PointN<N> where
    Self: MapComponents, 

pub fn signum(self) -> Self where
    <Self as MapComponents>::Scalar: Signed, 

Trait Implementations

impl<N> Abs for PointN<N> where
    Self: MapComponents,
    <Self as MapComponents>::Scalar: Signed, 

fn abs(self) -> Self

impl<N, T> Add<PointN<N>> for PointN<N> where
    Self: MapComponents<Scalar = T>,
    T: Add<Output = T>, 

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
    Self: Copy + 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 BitAnd<PointN<[i32; 2]>> for Point2i

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

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

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

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

type Output = Self

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

type Output = Self

The resulting type after applying the ^ operator.

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

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: 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: Self) -> 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: Self) -> Self

Performs the / operation.

impl<N> FloatPoint<N> for PointN<N> where
    Self: IntoIntegerPoint + Point<Scalar = f32>, 

fn round(self) -> Self

fn floor(self) -> Self

fn ceil(self) -> Self

fn fract(self) -> Self

fn floor_int(self) -> Self::IntPoint

Ensures that you floor before casting to integers, since this is not the default behavior for negative integers.

impl<T> From<PointN<[T; 2]>> for Point2<T> where
    T: Clone, 

fn from(p: Point2<T>) -> Self

Performs the conversion.

impl<T> From<PointN<[T; 2]>> for Vector2<T> where
    T: Clone, 

fn from(p: Point2<T>) -> Self

Performs the conversion.

impl<T> From<PointN<[T; 3]>> for Point3<T> where
    T: Clone, 

fn from(p: Point3<T>) -> Self

Performs the conversion.

impl<T> From<PointN<[T; 3]>> for Vector3<T> where
    T: Clone, 

fn from(p: Point3<T>) -> Self

Performs the conversion.

impl From<PointN<[f32; 2]>> for Vec2

fn from(p: Point2f) -> Self

Performs the conversion.

impl From<PointN<[f32; 2]>> for Point2<f32>

fn from(p: Point2f) -> Self

Performs the conversion.

impl From<PointN<[f32; 2]>> for Vector2<f32>

fn from(p: Point2f) -> Self

Performs the conversion.

impl From<PointN<[f32; 3]>> for Vec3

fn from(p: Point3f) -> Self

Performs the conversion.

impl From<PointN<[f32; 3]>> for Vec3A

fn from(p: Point3f) -> Self

Performs the conversion.

impl From<PointN<[f32; 3]>> for Point3<f32>

fn from(p: Point3f) -> Self

Performs the conversion.

impl From<PointN<[f32; 3]>> for Vector3<f32>

fn from(p: Point3f) -> Self

Performs the conversion.

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

fn from(p: Point2i) -> Self

Performs the conversion.

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

fn from(p: Point2i) -> Self

Performs the conversion.

impl From<PointN<[i32; 2]>> for Point2<f32>

fn from(p: Point2i) -> Self

Performs the conversion.

impl From<PointN<[i32; 2]>> for Vector2<f32>

fn from(p: Point2i) -> Self

Performs the conversion.

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

fn from(p: Point2i) -> Self

Performs the conversion.

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

fn from(p: Point3i) -> Self

Performs the conversion.

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

fn from(p: Point3i) -> Self

Performs the conversion.

impl From<PointN<[i32; 3]>> for Point3<f32>

fn from(p: Point3i) -> Self

Performs the conversion.

impl From<PointN<[i32; 3]>> for Vector3<f32>

fn from(p: Point3i) -> 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 Mul<PointN<[f32; 2]>> for f32

type Output = Point2f

The resulting type after applying the * operator.

fn mul(self, rhs: Point2f) -> Point2f

Performs the * operation.

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<PointN<[f32; 3]>> for f32

type Output = Point3f

The resulting type after applying the * operator.

fn mul(self, rhs: Point3f) -> Point3f

Performs the * operation.

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<PointN<[i32; 2]>> for i32

type Output = Point2i

The resulting type after applying the * operator.

fn mul(self, rhs: Point2i) -> Point2i

Performs the * operation.

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<PointN<[i32; 3]>> for i32

type Output = Point3i

The resulting type after applying the * operator.

fn mul(self, rhs: Point3i) -> Point3i

Performs the * operation.

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<PointN<T>> for ExtentN<T> where
    PointN<T>: Copy + Mul<Output = PointN<T>>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<N> Neg for PointN<N> where
    Self: Copy + 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 Rem<PointN<[i32; 2]>> for Point2i

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

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

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

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 Shl<PointN<[i32; 2]>> for Point2i

type Output = Self

The resulting type after applying the << operator.

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

Performs the << operation.

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

type Output = Self

The resulting type after applying the << operator.

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

Performs the << operation.

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

type Output = Self

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

type Output = Self

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<N, T> Sub<PointN<N>> for PointN<N> where
    Self: MapComponents<Scalar = T>,
    T: Sub<Output = T>, 

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
    Self: Copy + 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 + ConstZero, 

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.

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

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

impl<N> StructuralEq for PointN<N>

impl<N> StructuralPartialEq for PointN<N>