Struct euclid::Point3D

#[repr(C)]
pub struct Point3D<T, U> {
    pub x: T,
    pub y: T,
    pub z: T,
    /* private fields */
}

A 3d Point tagged with a unit.

Fields

x: T

y: T

z: T

Implementations

impl<T, U> Point3D<T, U>

pub fn origin() -> Self

where T: Zero,

Constructor, setting all components to zero.

pub fn zero() -> Self

where T: Zero,

The same as origin().

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

Constructor taking scalar values directly.

pub fn from_lengths(x: Length<T, U>, y: Length<T, U>, z: Length<T, U>) -> Self

Constructor taking properly Lengths instead of scalar values.

pub fn splat(v: T) -> Self

where T: Clone,

Constructor setting all components to the same value.

pub fn from_untyped(p: Point3D<T, UnknownUnit>) -> Self

Tag a unitless value with units.

impl<T: Copy, U> Point3D<T, U>

pub fn to_vector(self) -> Vector3D<T, U>

Cast this point into a vector.

Equivalent to subtracting the origin to this point.

pub fn xy(self) -> Point2D<T, U>

Returns a 2d point using this point’s x and y coordinates

pub fn xz(self) -> Point2D<T, U>

Returns a 2d point using this point’s x and z coordinates

pub fn yz(self) -> Point2D<T, U>

Returns a 2d point using this point’s x and z coordinates

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

Cast into an array with x, y and z.

Example

enum Mm {}

let point: Point3D<_, Mm> = point3(1, -8, 0);

assert_eq!(point.to_array(), [1, -8, 0]);

pub fn to_array_4d(self) -> [T; 4]

where T: One,

pub fn to_tuple(self) -> (T, T, T)

Cast into a tuple with x, y and z.

Example

enum Mm {}

let point: Point3D<_, Mm> = point3(1, -8, 0);

assert_eq!(point.to_tuple(), (1, -8, 0));

pub fn to_tuple_4d(self) -> (T, T, T, T)

where T: One,

pub fn to_untyped(self) -> Point3D<T, UnknownUnit>

Drop the units, preserving only the numeric value.

Example

enum Mm {}

let point: Point3D<_, Mm> = point3(1, -8, 0);

assert_eq!(point.x, point.to_untyped().x);
assert_eq!(point.y, point.to_untyped().y);
assert_eq!(point.z, point.to_untyped().z);

pub fn cast_unit<V>(self) -> Point3D<T, V>

Cast the unit, preserving the numeric value.

Example

enum Mm {}
enum Cm {}

let point: Point3D<_, Mm> = point3(1, -8, 0);

assert_eq!(point.x, point.cast_unit::<Cm>().x);
assert_eq!(point.y, point.cast_unit::<Cm>().y);
assert_eq!(point.z, point.cast_unit::<Cm>().z);

pub fn to_2d(self) -> Point2D<T, U>

Convert into a 2d point.

pub fn round(self) -> Self

where T: Round,

Rounds each component to the nearest integer value.

This behavior is preserved for negative values (unlike the basic cast).

enum Mm {}

assert_eq!(point3::<_, Mm>(-0.1, -0.8, 0.4).round(), point3::<_, Mm>(0.0, -1.0, 0.0))

pub fn ceil(self) -> Self

where T: Ceil,

Rounds each component to the smallest integer equal or greater than the original value.

This behavior is preserved for negative values (unlike the basic cast).

enum Mm {}

assert_eq!(point3::<_, Mm>(-0.1, -0.8, 0.4).ceil(), point3::<_, Mm>(0.0, 0.0, 1.0))

pub fn floor(self) -> Self

where T: Floor,

Rounds each component to the biggest integer equal or lower than the original value.

This behavior is preserved for negative values (unlike the basic cast).

enum Mm {}

assert_eq!(point3::<_, Mm>(-0.1, -0.8, 0.4).floor(), point3::<_, Mm>(-1.0, -1.0, 0.0))

pub fn lerp(self, other: Self, t: T) -> Self

where T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>,

Linearly interpolate between this point and another point.

Example

use euclid::point3;
use euclid::default::Point3D;

let from: Point3D<_> = point3(0.0, 10.0, -1.0);
let to:  Point3D<_> = point3(8.0, -4.0,  0.0);

assert_eq!(from.lerp(to, -1.0), point3(-8.0,  24.0, -2.0));
assert_eq!(from.lerp(to,  0.0), point3( 0.0,  10.0, -1.0));
assert_eq!(from.lerp(to,  0.5), point3( 4.0,   3.0, -0.5));
assert_eq!(from.lerp(to,  1.0), point3( 8.0,  -4.0,  0.0));
assert_eq!(from.lerp(to,  2.0), point3(16.0, -18.0,  1.0));

impl<T: PartialOrd, U> Point3D<T, U>

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

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

pub fn clamp(self, start: Self, end: Self) -> Self

where T: Copy,

Returns the point each component of which clamped by corresponding components of start and end.

Shortcut for self.max(start).min(end).

impl<T: NumCast + Copy, U> Point3D<T, U>

pub fn cast<NewT: NumCast>(self) -> Point3D<NewT, U>

Cast from one numeric representation to another, preserving the units.

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn try_cast<NewT: NumCast>(self) -> Option<Point3D<NewT, U>>

Fallible cast from one numeric representation to another, preserving the units.

When casting from floating point to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn to_f32(self) -> Point3D<f32, U>

Cast into an f32 point.

pub fn to_f64(self) -> Point3D<f64, U>

Cast into an f64 point.

pub fn to_usize(self) -> Point3D<usize, U>

Cast into an usize point, truncating decimals if any.

When casting from floating point points, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_u32(self) -> Point3D<u32, U>

Cast into an u32 point, truncating decimals if any.

When casting from floating point points, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i32(self) -> Point3D<i32, U>

Cast into an i32 point, truncating decimals if any.

When casting from floating point points, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i64(self) -> Point3D<i64, U>

Cast into an i64 point, truncating decimals if any.

When casting from floating point points, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

impl<T: Float, U> Point3D<T, U>

pub fn is_finite(self) -> bool

Returns true if all members are finite.

impl<T: Copy + Add<T, Output = T>, U> Point3D<T, U>

pub fn add_size(self, other: Size3D<T, U>) -> Self

impl<T: Real + Sub<T, Output = T>, U> Point3D<T, U>

pub fn distance_to(self, other: Self) -> T

impl<T: Euclid, U> Point3D<T, U>

pub fn rem_euclid(&self, other: &Size3D<T, U>) -> Self

Calculates the least nonnegative remainder of self (mod other).

Example

use euclid::point3;
use euclid::default::{Point3D, Size3D};

let p = Point3D::new(7.0, -7.0, 0.0);
let s = Size3D::new(4.0, -4.0, 12.0);
assert_eq!(p.rem_euclid(&s), point3(3.0, 1.0, 0.0));
assert_eq!((-p).rem_euclid(&s), point3(1.0, 3.0, 0.0));
assert_eq!(p.rem_euclid(&-s), point3(3.0, 1.0, 0.0));

pub fn div_euclid(&self, other: &Size3D<T, U>) -> Self

Calculates Euclidean division, the matching method for rem_euclid.

Example

use euclid::point3;
use euclid::default::{Point3D, Size3D};

let p = Point3D::new(7.0, -7.0, 0.0);
let s = Size3D::new(4.0, -4.0, 12.0);

assert_eq!(p.div_euclid(&s), point3(1.0, 2.0, 0.0));
assert_eq!((-p).div_euclid(&s), point3(-2.0, -1.0, 0.0));
assert_eq!(p.div_euclid(&-s), point3(-1.0, -2.0, 0.0));

Trait Implementations

impl<T: Add, U> Add<Size3D<T, U>> for Point3D<T, U>

type Output = Point3D<<T as Add>::Output, U>

The resulting type after applying the + operator.

fn add(self, other: Size3D<T, U>) -> Self::Output

Performs the + operation.

impl<T: Add, U> Add<Vector3D<T, U>> for Point3D<T, U>

type Output = Point3D<<T as Add>::Output, U>

The resulting type after applying the + operator.

fn add(self, other: Vector3D<T, U>) -> Self::Output

Performs the + operation.

impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>

fn add_assign(&mut self, other: Size3D<T, U>)

Performs the += operation.

impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>

fn add_assign(&mut self, other: Vector3D<T, U>)

Performs the += operation.

impl<T: ApproxEq<T>, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>

fn approx_epsilon() -> Self

Default epsilon value

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

Returns true is this object is approximately equal to the other one, using a provided epsilon value.

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

Returns true is this object is approximately equal to the other one, using the approx_epsilon() epsilon value.

impl<T: Ceil, U> Ceil for Point3D<T, U>

fn ceil(self) -> Self

See Point3D::ceil()

impl<T: Clone, U> Clone for Point3D<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, U> Debug for Point3D<T, U>

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

Formats the value using the given formatter.

impl<T: Default, U> Default for Point3D<T, U>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy + Div, U1, U2> Div<Scale<T, U1, U2>> for Point3D<T, U2>

type Output = Point3D<<T as Div>::Output, U1>

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the / operation.

impl<T: Copy + Div, U> Div<T> for Point3D<T, U>

type Output = Point3D<<T as Div>::Output, U>

The resulting type after applying the / operator.

fn div(self, scale: T) -> Self::Output

Performs the / operation.

impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>

fn div_assign(&mut self, scale: Scale<T, U, U>)

Performs the /= operation.

impl<T: Copy + DivAssign, U> DivAssign<T> for Point3D<T, U>

fn div_assign(&mut self, scale: T)

Performs the /= operation.

impl<T: Floor, U> Floor for Point3D<T, U>

fn floor(self) -> Self

See Point3D::floor()

impl<T, U> From<[T; 3]> for Point3D<T, U>

fn from([x, y, z]: [T; 3]) -> Self

Converts to this type from the input type.

impl<T, U> From<(T, T, T)> for Point3D<T, U>

fn from(tuple: (T, T, T)) -> Self

Converts to this type from the input type.

impl<T: One, U> From<Point3D<T, U>> for HomogeneousVector<T, U>

fn from(p: Point3D<T, U>) -> Self

Converts to this type from the input type.

impl<T, U> Hash for Point3D<T, U>

where T: Hash,

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, U> Into<[T; 3]> for Point3D<T, U>

fn into(self) -> [T; 3]

Converts this type into the (usually inferred) input type.

impl<T, U> Into<(T, T, T)> for Point3D<T, U>

fn into(self) -> (T, T, T)

Converts this type into the (usually inferred) input type.

impl<T: Copy + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Point3D<T, U1>

type Output = Point3D<<T as Mul>::Output, U2>

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the * operation.

impl<T: Copy + Mul, U> Mul<T> for Point3D<T, U>

type Output = Point3D<<T as Mul>::Output, U>

The resulting type after applying the * operator.

fn mul(self, scale: T) -> Self::Output

Performs the * operation.

impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>

fn mul_assign(&mut self, scale: Scale<T, U, U>)

Performs the *= operation.

impl<T: Copy + MulAssign, U> MulAssign<T> for Point3D<T, U>

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

impl<T: Neg, U> Neg for Point3D<T, U>

type Output = Point3D<<T as Neg>::Output, U>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T, U> PartialEq for Point3D<T, U>

where T: PartialEq,

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

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

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<T: Round, U> Round for Point3D<T, U>

fn round(self) -> Self

See Point3D::round()

impl<T: Sub, U> Sub<Size3D<T, U>> for Point3D<T, U>

type Output = Point3D<<T as Sub>::Output, U>

The resulting type after applying the - operator.

fn sub(self, other: Size3D<T, U>) -> Self::Output

Performs the - operation.

impl<T: Sub, U> Sub<Vector3D<T, U>> for Point3D<T, U>

type Output = Point3D<<T as Sub>::Output, U>

The resulting type after applying the - operator.

fn sub(self, other: Vector3D<T, U>) -> Self::Output

Performs the - operation.

impl<T: Sub, U> Sub for Point3D<T, U>

type Output = Vector3D<<T as Sub>::Output, U>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>

fn sub_assign(&mut self, other: Size3D<T, U>)

Performs the -= operation.

impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>

fn sub_assign(&mut self, other: Vector3D<T, U>)

Performs the -= operation.

impl<T: Zero, U> Zero for Point3D<T, U>

fn zero() -> Self

impl<T: Copy, U> Copy for Point3D<T, U>

impl<T, U> Eq for Point3D<T, U>

where T: Eq,