Struct euclid::Point3D [−][src]
#[repr(C)]pub struct Point3D<T, U> { pub x: T, pub y: T, pub z: T, // some fields omitted }
Expand description
A 3d Point tagged with a unit.
Fields
x: T
y: T
z: T
Implementations
impl<T, U> Point3D<T, U>
[src]
impl<T, U> Point3D<T, U>
[src]pub fn from_lengths(x: Length<T, U>, y: Length<T, U>, z: Length<T, U>) -> Self
[src]
pub fn from_lengths(x: Length<T, U>, y: Length<T, U>, z: Length<T, U>) -> Self
[src]Constructor taking properly Lengths instead of scalar values.
pub fn splat(v: T) -> Self where
T: Clone,
[src]
pub fn splat(v: T) -> Self where
T: Clone,
[src]Constructor setting all components to the same value.
pub fn from_untyped(p: Point3D<T, UnknownUnit>) -> Self
[src]
pub fn from_untyped(p: Point3D<T, UnknownUnit>) -> Self
[src]Tag a unitless value with units.
impl<T: Copy, U> Point3D<T, U>
[src]
impl<T: Copy, U> Point3D<T, U>
[src]pub fn to_vector(self) -> Vector3D<T, U>
[src]
pub fn to_vector(self) -> Vector3D<T, U>
[src]Cast this point into a vector.
Equivalent to subtracting the origin to this point.
pub fn to_array(self) -> [T; 3]
[src]
pub fn to_array(self) -> [T; 3]
[src]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,
[src]
T: One,
pub fn to_tuple(self) -> (T, T, T)
[src]
pub fn to_tuple(self) -> (T, T, T)
[src]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,
[src]
T: One,
pub fn to_untyped(self) -> Point3D<T, UnknownUnit>
[src]
pub fn to_untyped(self) -> Point3D<T, UnknownUnit>
[src]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>
[src]
pub fn cast_unit<V>(self) -> Point3D<T, V>
[src]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);
#[must_use]pub fn round(self) -> Self where
T: Round,
[src]
#[must_use]pub fn round(self) -> Self where
T: Round,
[src]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))
#[must_use]pub fn ceil(self) -> Self where
T: Ceil,
[src]
#[must_use]pub fn ceil(self) -> Self where
T: Ceil,
[src]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))
#[must_use]pub fn floor(self) -> Self where
T: Floor,
[src]
#[must_use]pub fn floor(self) -> Self where
T: Floor,
[src]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>,
[src]
pub fn lerp(self, other: Self, t: T) -> Self where
T: One + Sub<Output = T> + Mul<Output = T> + Add<Output = T>,
[src]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>
[src]
impl<T: PartialOrd, U> Point3D<T, U>
[src]impl<T: NumCast + Copy, U> Point3D<T, U>
[src]
impl<T: NumCast + Copy, U> Point3D<T, U>
[src]pub fn cast<NewT: NumCast>(self) -> Point3D<NewT, U>
[src]
pub fn cast<NewT: NumCast>(self) -> Point3D<NewT, U>
[src]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>>
[src]
pub fn try_cast<NewT: NumCast>(self) -> Option<Point3D<NewT, U>>
[src]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_usize(self) -> Point3D<usize, U>
[src]
pub fn to_usize(self) -> Point3D<usize, U>
[src]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>
[src]
pub fn to_u32(self) -> Point3D<u32, U>
[src]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.
impl<T: Float + Sub<T, Output = T>, U> Point3D<T, U>
[src]
impl<T: Float + Sub<T, Output = T>, U> Point3D<T, U>
[src]pub fn distance_to(self, other: Self) -> T
[src]
Trait Implementations
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>
[src]
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>
[src]fn add_assign(&mut self, other: Size3D<T, U>)
[src]
fn add_assign(&mut self, other: Size3D<T, U>)
[src]Performs the +=
operation. Read more
impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>
[src]
impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>
[src]fn add_assign(&mut self, other: Vector3D<T, U>)
[src]
fn add_assign(&mut self, other: Vector3D<T, U>)
[src]Performs the +=
operation. Read more
impl<T: ApproxEq<T>, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>
[src]
impl<T: ApproxEq<T>, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>
[src]fn approx_epsilon() -> Self
[src]
fn approx_epsilon() -> Self
[src]Default epsilon value
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
[src]
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
[src]fn div_assign(&mut self, scale: Scale<T, U, U>)
[src]
fn div_assign(&mut self, scale: Scale<T, U, U>)
[src]Performs the /=
operation. Read more
impl<T: Copy + DivAssign, U> DivAssign<T> for Point3D<T, U>
[src]
impl<T: Copy + DivAssign, U> DivAssign<T> for Point3D<T, U>
[src]fn div_assign(&mut self, scale: T)
[src]
fn div_assign(&mut self, scale: T)
[src]Performs the /=
operation. Read more
impl<T: One, U> From<Point3D<T, U>> for HomogeneousVector<T, U>
[src]
impl<T: One, U> From<Point3D<T, U>> for HomogeneousVector<T, U>
[src]impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
[src]
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
[src]fn mul_assign(&mut self, scale: Scale<T, U, U>)
[src]
fn mul_assign(&mut self, scale: Scale<T, U, U>)
[src]Performs the *=
operation. Read more
impl<T: Copy + MulAssign, U> MulAssign<T> for Point3D<T, U>
[src]
impl<T: Copy + MulAssign, U> MulAssign<T> for Point3D<T, U>
[src]fn mul_assign(&mut self, scale: T)
[src]
fn mul_assign(&mut self, scale: T)
[src]Performs the *=
operation. Read more
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>
[src]
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>
[src]fn sub_assign(&mut self, other: Size3D<T, U>)
[src]
fn sub_assign(&mut self, other: Size3D<T, U>)
[src]Performs the -=
operation. Read more
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>
[src]
impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>
[src]fn sub_assign(&mut self, other: Vector3D<T, U>)
[src]
fn sub_assign(&mut self, other: Vector3D<T, U>)
[src]Performs the -=
operation. Read more
impl<T: Copy, U> Copy for Point3D<T, U>
[src]
impl<T, U> Eq for Point3D<T, U> where
T: Eq,
[src]
T: Eq,
Auto Trait Implementations
impl<T, U> RefUnwindSafe for Point3D<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Point3D<T, U> where
T: Send,
U: Send,
T: Send,
U: Send,
impl<T, U> Sync for Point3D<T, U> where
T: Sync,
U: Sync,
T: Sync,
U: Sync,
impl<T, U> Unpin for Point3D<T, U> where
T: Unpin,
U: Unpin,
T: Unpin,
U: Unpin,
impl<T, U> UnwindSafe for Point3D<T, U> where
T: UnwindSafe,
U: UnwindSafe,
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more