Struct Point3 

pub struct Point3<T> {
    pub x: T,
    pub y: T,
    pub z: T,
}

A point with three coordinates x, y, and z.

Fields

x: T

The first coordinate.

y: T

The second coordinate.

z: T

The third coordinate.

Implementations

impl<T> Point3<T>

pub const fn new(x: T, y: T, z: T) -> Self

Constructs a point from its three coordinates.

pub fn from_array(array: [T; 3]) -> Self

Constructs a point from an array [x, y, z].

pub fn to_array(self) -> [T; 3]

Returns the coordinates as an array [x, y, z].

pub fn with_x(self, x: T) -> Self

Returns a copy of self with the x coordinate replaced.

pub fn with_y(self, y: T) -> Self

Returns a copy of self with the y coordinate replaced.

pub fn with_z(self, z: T) -> Self

Returns a copy of self with the z coordinate replaced.

pub fn from_vector(vector: Vector3<T>) -> Self

Reinterprets a displacement from the origin as a point.

pub fn to_vector(self) -> Vector3<T>

Returns the position vector of self relative to the origin.

pub fn map<U, F: FnMut(T) -> U>(self, f: F) -> Point3<U>

Applies f to every coordinate, returning the resulting point.

pub fn zip_map<U, R, F: FnMut(T, U) -> R>( self, rhs: Point3<U>, f: F, ) -> Point3<R>

Combines self and rhs coordinate-wise through f.

impl<T: Copy> Point3<T>

pub const fn splat(value: T) -> Self

Constructs a point with all three coordinates set to value.

pub fn from_slice(slice: &[T]) -> Self

Constructs a point from the first three elements of a slice.

Panics

Panics if slice has fewer than three elements.

impl<T: Add<Output = T> + Sub<Output = T> + Copy> Point3<T>

pub fn lerp<S: Scalar>(self, rhs: Self, t: S) -> Self

where T: Mul<S, Output = T>,

Linearly interpolates from self toward rhs by the factor t.

t == 0 yields self, t == 1 yields rhs.

impl<V: Scalar> Point3<V>

pub const ORIGIN: Self

The origin, (0, 0, 0).

pub fn distance_squared(self, rhs: Self) -> V

Returns the squared Euclidean distance between self and rhs.

Cheaper than distance and sufficient whenever only relative distances are compared.

pub fn distance(self, rhs: Self) -> V

Returns the Euclidean distance between self and rhs.

pub fn midpoint(self, rhs: Self) -> Self

Returns the midpoint of the segment between self and rhs.

pub fn centroid(points: &[Self]) -> Self

Returns the centroid (arithmetic mean) of points, or the ORIGIN when points is empty.

pub fn min(self, rhs: Self) -> Self

Returns the component-wise minimum of self and rhs.

pub fn max(self, rhs: Self) -> Self

Returns the component-wise maximum of self and rhs.

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

Restricts every coordinate to the interval [min, max], confining the point to an axis-aligned bounding box.

Panics

Panics if any coordinate of min exceeds the corresponding coordinate of max.

pub fn floor(self) -> Self

Returns the component-wise floor (largest integer not exceeding each coordinate).

pub fn ceil(self) -> Self

Returns the component-wise ceiling (smallest integer not less than each coordinate).

pub fn round(self) -> Self

Returns the component-wise nearest integer, rounding halves away from zero.

pub fn round_ties_even(self) -> Self

Returns the component-wise nearest integer, rounding halves to even.

pub fn trunc(self) -> Self

Returns the component-wise truncation toward zero.

pub fn fract(self) -> Self

Returns the component-wise fractional part, i.e. the position of self within the unit-grid cell it occupies.

pub fn is_finite(self) -> bool

Returns true if every coordinate is finite.

pub fn is_infinite(self) -> bool

Returns true if any coordinate is positive or negative infinity.

pub fn is_nan(self) -> bool

Returns true if any coordinate is NaN.

Trait Implementations

impl<T: Add<Output = T>> Add<Vector3<T>> for Point3<T>

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

Translates the point by the displacement rhs.

type Output = Point3<T>

The resulting type after applying the + operator.

impl<T: AddAssign> AddAssign<Vector3<T>> for Point3<T>

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

Performs the += operation.

impl<T: Clone> Clone for Point3<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Point3<T>

impl<T: Debug> Debug for Point3<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Point3<T>

fn default() -> Self

Returns the origin.

impl<T> Index<usize> for Point3<T>

fn index(&self, index: usize) -> &T

Returns the coordinate at index, where 0, 1, and 2 map to x, y, and z.

Panics

Panics if index is greater than 2.

type Output = T

The returned type after indexing.

impl<T> IndexMut<usize> for Point3<T>

fn index_mut(&mut self, index: usize) -> &mut T

Returns the coordinate at index, where 0, 1, and 2 map to x, y, and z.

Panics

Panics if index is greater than 2.

impl<T: PartialEq> PartialEq for Point3<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Sub<Output = T>> Sub for Point3<T>

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

Returns the displacement from rhs to self.

type Output = Vector3<T>

The resulting type after applying the - operator.

impl<T: Sub<Output = T>> Sub<Vector3<T>> for Point3<T>

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

Translates the point by the negated displacement rhs.

type Output = Point3<T>

The resulting type after applying the - operator.

impl<T: SubAssign> SubAssign<Vector3<T>> for Point3<T>

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

Performs the -= operation.