[−][src]Struct euclid::Point3D
A 3d Point tagged with a unit.
Fields
x: Ty: Tz: TMethods
impl<T, U> Point3D<T, U>[src]
pub fn origin() -> Self where
T: Zero, [src]
T: Zero,
Constructor, setting all components to zero.
pub fn zero() -> Self where
T: Zero, [src]
T: Zero,
The same as origin().
pub const fn new(x: T, y: T, z: T) -> Self[src]
Constructor taking scalar values directly.
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 from_untyped(p: Point3D<T, UnknownUnit>) -> Self[src]
Tag a unitless value with units.
impl<T: Copy, U> Point3D<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 xy(&self) -> Point2D<T, U>[src]
Returns a 2d point using this point's x and y coordinates
pub fn xz(&self) -> Point2D<T, U>[src]
Returns a 2d point using this point's x and z coordinates
pub fn yz(&self) -> Point2D<T, U>[src]
Returns a 2d point using this point's x and z coordinates
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]
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]
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]
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>[src]
Convert into a 2d point.
#[must_use]pub fn round(&self) -> Self where
T: Round, [src]
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))
#[must_use]pub fn ceil(&self) -> Self where
T: Ceil, [src]
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))
#[must_use]pub fn floor(&self) -> Self where
T: Floor, [src]
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>, [src]
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>[src]
pub fn min(self, other: Self) -> Self[src]
pub fn max(self, other: Self) -> Self[src]
pub fn clamp(&self, start: Self, end: Self) -> Self where
T: Copy, [src]
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>[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]
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>[src]
Cast into an f32 point.
pub fn to_f64(&self) -> Point3D<f64, U>[src]
Cast into an f64 point.
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]
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>[src]
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>[src]
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: Copy + Add<T, Output = T>, U> Point3D<T, U>[src]
Trait Implementations
impl<T: Add, U> Add<Size3D<T, U>> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the + operator.
fn add(self, other: Size3D<T, U>) -> Self::Output[src]
impl<T: Add, U> Add<Vector3D<T, U>> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the + operator.
fn add(self, other: Vector3D<T, U>) -> Self::Output[src]
impl<T: AddAssign, U> AddAssign<Size3D<T, U>> for Point3D<T, U>[src]
fn add_assign(&mut self, other: Size3D<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]
impl<T: ApproxEq<T>, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>[src]
fn approx_epsilon() -> Self[src]
fn approx_eq_eps(&self, other: &Self, eps: &Self) -> bool[src]
fn approx_eq(&self, other: &Self) -> bool[src]
impl<T: Ceil, U> Ceil for Point3D<T, U>[src]
fn ceil(self) -> Self[src]
See Point3D::ceil()
impl<T: Clone, U> Clone for Point3D<T, U>[src]
fn clone(&self) -> Self[src]
fn clone_from(&mut self, source: &Self)1.0.0[src]
impl<T: Copy, U> Copy for Point3D<T, U>[src]
impl<T: Debug, U> Debug for Point3D<T, U>[src]
impl<T: Default, U> Default for Point3D<T, U>[src]
impl<T: Display, U> Display for Point3D<T, U>[src]
impl<T: Clone + Div, U1, U2> Div<Scale<T, U1, U2>> for Point3D<T, U2>[src]
type Output = Point3D<T::Output, U1>
The resulting type after applying the / operator.
fn div(self, scale: Scale<T, U1, U2>) -> Self::Output[src]
impl<T: Clone + Div, U> Div<T> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the / operator.
fn div(self, scale: T) -> Self::Output[src]
impl<T: Clone + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>[src]
fn div_assign(&mut self, scale: Scale<T, U, U>)[src]
impl<T: Clone + DivAssign, U> DivAssign<T> for Point3D<T, U>[src]
fn div_assign(&mut self, scale: T)[src]
impl<T, U> Eq for Point3D<T, U> where
T: Eq, [src]
T: Eq,
impl<T: Floor, U> Floor for Point3D<T, U>[src]
fn floor(self) -> Self[src]
See Point3D::floor()
impl<T, U> From<[T; 3]> for Point3D<T, U>[src]
impl<T, U> From<(T, T, T)> for Point3D<T, U>[src]
impl<T: One, U> From<Point3D<T, U>> for HomogeneousVector<T, U>[src]
impl<T, U> Hash for Point3D<T, U> where
T: Hash, [src]
T: Hash,
fn hash<H: Hasher>(&self, h: &mut H)[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
H: Hasher,
impl<T, U> Into<[T; 3]> for Point3D<T, U>[src]
impl<T, U> Into<(T, T, T)> for Point3D<T, U>[src]
impl<T: Clone + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Point3D<T, U1>[src]
type Output = Point3D<T::Output, U2>
The resulting type after applying the * operator.
fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output[src]
impl<T: Clone + Mul, U> Mul<T> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the * operator.
fn mul(self, scale: T) -> Self::Output[src]
impl<T: Clone + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>[src]
fn mul_assign(&mut self, scale: Scale<T, U, U>)[src]
impl<T: Clone + MulAssign, U> MulAssign<T> for Point3D<T, U>[src]
fn mul_assign(&mut self, scale: T)[src]
impl<T: Neg, U> Neg for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the - operator.
fn neg(self) -> Self::Output[src]
impl<T, U> PartialEq<Point3D<T, U>> for Point3D<T, U> where
T: PartialEq, [src]
T: PartialEq,
impl<T: Round, U> Round for Point3D<T, U>[src]
fn round(self) -> Self[src]
See Point3D::round()
impl<T: Sub, U> Sub<Point3D<T, U>> for Point3D<T, U>[src]
type Output = Vector3D<T::Output, U>
The resulting type after applying the - operator.
fn sub(self, other: Self) -> Self::Output[src]
impl<T: Sub, U> Sub<Size3D<T, U>> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the - operator.
fn sub(self, other: Size3D<T, U>) -> Self::Output[src]
impl<T: Sub, U> Sub<Vector3D<T, U>> for Point3D<T, U>[src]
type Output = Point3D<T::Output, U>
The resulting type after applying the - operator.
fn sub(self, other: Vector3D<T, U>) -> Self::Output[src]
impl<T: SubAssign, U> SubAssign<Size3D<T, U>> for Point3D<T, U>[src]
fn sub_assign(&mut self, other: Size3D<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]
impl<T: Zero, U> Zero for Point3D<T, U>[src]
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> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T[src]
fn clone_into(&self, target: &mut T)[src]
impl<T> ToString for T where
T: Display + ?Sized, [src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> Zero for T where
T: Zero, [src]
T: Zero,