#[repr(C)]pub struct Point3D<T, U> {
pub x: T,
pub y: T,
pub z: T,
/* private fields */
}
Expand description
A 3d Point tagged with a unit.
Fields§
§x: T
§y: T
§z: T
Implementations§
Source§impl<T, U> Point3D<T, U>
impl<T, U> Point3D<T, U>
Sourcepub fn from_lengths(x: Length<T, U>, y: Length<T, U>, z: Length<T, U>) -> Self
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.
Sourcepub fn from_untyped(p: Point3D<T, UnknownUnit>) -> Self
pub fn from_untyped(p: Point3D<T, UnknownUnit>) -> Self
Tag a unitless value with units.
Source§impl<T: Copy, U> Point3D<T, U>
impl<T: Copy, U> Point3D<T, U>
Sourcepub fn to_vector(self) -> Vector3D<T, U>
pub fn to_vector(self) -> Vector3D<T, U>
Cast this point into a vector.
Equivalent to subtracting the origin to this point.
Sourcepub fn to_array(self) -> [T; 3]
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,
Sourcepub fn to_tuple(self) -> (T, T, T)
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,
Sourcepub fn to_untyped(self) -> Point3D<T, UnknownUnit>
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);
Sourcepub fn cast_unit<V>(self) -> Point3D<T, V>
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);
Sourcepub fn round(self) -> Selfwhere
T: Round,
pub fn round(self) -> Selfwhere
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))
Sourcepub fn ceil(self) -> Selfwhere
T: Ceil,
pub fn ceil(self) -> Selfwhere
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))
Sourcepub fn floor(self) -> Selfwhere
T: Floor,
pub fn floor(self) -> Selfwhere
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))
Sourcepub fn lerp(self, other: Self, t: T) -> Self
pub fn lerp(self, other: Self, t: T) -> Self
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));
Source§impl<T: PartialOrd, U> Point3D<T, U>
impl<T: PartialOrd, U> Point3D<T, U>
Source§impl<T: NumCast + Copy, U> Point3D<T, U>
impl<T: NumCast + Copy, U> Point3D<T, U>
Sourcepub fn cast<NewT: NumCast>(self) -> Point3D<NewT, 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.
Sourcepub fn try_cast<NewT: NumCast>(self) -> Option<Point3D<NewT, U>>
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.
Sourcepub fn to_usize(self) -> Point3D<usize, U>
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.
Sourcepub fn to_u32(self) -> Point3D<u32, U>
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.
Trait Implementations§
Source§impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>
Source§fn add_assign(&mut self, other: Size3D<T, U>)
fn add_assign(&mut self, other: Size3D<T, U>)
+=
operation. Read moreSource§impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>
impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>
Source§fn add_assign(&mut self, other: Vector3D<T, U>)
fn add_assign(&mut self, other: Vector3D<T, U>)
+=
operation. Read moreSource§impl<T: ApproxEq<T>, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>
impl<T: ApproxEq<T>, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>
Source§fn approx_epsilon() -> Self
fn approx_epsilon() -> Self
Source§fn approx_eq_eps(&self, other: &Self, eps: &Self) -> bool
fn approx_eq_eps(&self, other: &Self, eps: &Self) -> bool
true
is this object is approximately equal to the other one, using
a provided epsilon value.Source§impl<'de, T, U> Deserialize<'de> for Point3D<T, U>where
T: Deserialize<'de>,
impl<'de, T, U> Deserialize<'de> for Point3D<T, U>where
T: Deserialize<'de>,
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
Source§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
Source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moreSource§impl<T: Copy + DivAssign, U> DivAssign<T> for Point3D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<T> for Point3D<T, U>
Source§fn div_assign(&mut self, scale: T)
fn div_assign(&mut self, scale: T)
/=
operation. Read moreSource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
Source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moreSource§impl<T: Copy + MulAssign, U> MulAssign<T> for Point3D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<T> for Point3D<T, U>
Source§fn mul_assign(&mut self, scale: T)
fn mul_assign(&mut self, scale: T)
*=
operation. Read moreSource§impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>
Source§fn sub_assign(&mut self, other: Size3D<T, U>)
fn sub_assign(&mut self, other: Size3D<T, U>)
-=
operation. Read moreSource§impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>
Source§fn sub_assign(&mut self, other: Vector3D<T, U>)
fn sub_assign(&mut self, other: Vector3D<T, U>)
-=
operation. Read moreimpl<T: Copy, U> Copy for Point3D<T, U>
impl<T, U> Eq for Point3D<T, U>where
T: Eq,
Auto Trait Implementations§
impl<T, U> Freeze for Point3D<T, U>where
T: Freeze,
impl<T, U> RefUnwindSafe for Point3D<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Point3D<T, U>
impl<T, U> Sync for Point3D<T, U>
impl<T, U> Unpin for Point3D<T, U>
impl<T, U> UnwindSafe for Point3D<T, U>where
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)