#[repr(C)]pub struct Point3D<T, U> {
pub x: T,
pub y: T,
pub z: T,
/* private fields */
}
canvas
only.Expand description
A 3d Point tagged with a unit.
Fields§
§x: T
§y: T
§z: T
Implementations§
§impl<T, U> Point3D<T, U>
impl<T, U> Point3D<T, U>
pub fn from_lengths(
x: Length<T, U>,
y: Length<T, U>,
z: Length<T, U>
) -> Point3D<T, U>
pub fn from_lengths( x: Length<T, U>, y: Length<T, U>, z: Length<T, U> ) -> Point3D<T, U>
Constructor taking properly Lengths instead of scalar values.
pub fn splat(v: T) -> Point3D<T, U>where
T: Clone,
pub fn splat(v: T) -> Point3D<T, U>where
T: Clone,
Constructor setting all components to the same value.
pub fn from_untyped(p: Point3D<T, UnknownUnit>) -> Point3D<T, U>
pub fn from_untyped(p: Point3D<T, UnknownUnit>) -> Point3D<T, U>
Tag a unitless value with units.
§impl<T, U> Point3D<T, U>where
T: Copy,
impl<T, U> Point3D<T, U>where
T: Copy,
pub 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.
pub 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,
pub 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,
pub 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);
pub 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);
pub fn round(self) -> Point3D<T, U>where
T: Round,
pub fn round(self) -> Point3D<T, U>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) -> Point3D<T, U>where
T: Ceil,
pub fn ceil(self) -> Point3D<T, U>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) -> Point3D<T, U>where
T: Floor,
pub fn floor(self) -> Point3D<T, U>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: Point3D<T, U>, t: T) -> Point3D<T, U>
pub fn lerp(self, other: Point3D<T, U>, t: T) -> Point3D<T, U>
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, U> Point3D<T, U>where
T: PartialOrd,
impl<T, U> Point3D<T, U>where
T: PartialOrd,
§impl<T, U> Point3D<T, U>
impl<T, U> Point3D<T, U>
pub fn cast<NewT>(self) -> Point3D<NewT, U>where
NewT: NumCast,
pub fn cast<NewT>(self) -> Point3D<NewT, U>where
NewT: NumCast,
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>(self) -> Option<Point3D<NewT, U>>where
NewT: NumCast,
pub fn try_cast<NewT>(self) -> Option<Point3D<NewT, U>>where
NewT: NumCast,
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>
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>
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.
§impl<T, U> Point3D<T, U>
impl<T, U> Point3D<T, U>
pub fn distance_to(self, other: Point3D<T, U>) -> T
§impl<T, U> Point3D<T, U>where
T: Euclid,
impl<T, U> Point3D<T, U>where
T: Euclid,
pub fn rem_euclid(&self, other: &Size3D<T, U>) -> Point3D<T, U>
pub fn rem_euclid(&self, other: &Size3D<T, U>) -> Point3D<T, U>
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>) -> Point3D<T, U>
pub fn div_euclid(&self, other: &Size3D<T, U>) -> Point3D<T, U>
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, U> AddAssign<Size3D<T, U>> for Point3D<T, U>where
T: AddAssign,
impl<T, U> AddAssign<Size3D<T, U>> for Point3D<T, U>where
T: AddAssign,
§fn add_assign(&mut self, other: Size3D<T, U>)
fn add_assign(&mut self, other: Size3D<T, U>)
+=
operation. Read more§impl<T, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>
impl<T, U> AddAssign<Vector3D<T, U>> for Point3D<T, U>
§fn add_assign(&mut self, other: Vector3D<T, U>)
fn add_assign(&mut self, other: Vector3D<T, U>)
+=
operation. Read more§impl<T, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>where
T: ApproxEq<T>,
impl<T, U> ApproxEq<Point3D<T, U>> for Point3D<T, U>where
T: ApproxEq<T>,
§fn approx_epsilon() -> Point3D<T, U>
fn approx_epsilon() -> Point3D<T, U>
§fn approx_eq_eps(&self, other: &Point3D<T, U>, eps: &Point3D<T, U>) -> bool
fn approx_eq_eps(&self, other: &Point3D<T, U>, eps: &Point3D<T, U>) -> bool
true
is this object is approximately equal to the other one, using
a provided epsilon value.§impl<T, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
impl<T, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read more§impl<T, U> DivAssign<T> for Point3D<T, U>
impl<T, U> DivAssign<T> for Point3D<T, U>
§fn div_assign(&mut self, scale: T)
fn div_assign(&mut self, scale: T)
/=
operation. Read more§impl<T, U> Floor for Point3D<T, U>where
T: Floor,
impl<T, U> Floor for Point3D<T, U>where
T: Floor,
§fn floor(self) -> Point3D<T, U>
fn floor(self) -> Point3D<T, U>
See Point3D::floor()
§impl<T, U> From<Point3D<T, U>> for HomogeneousVector<T, U>where
T: One,
impl<T, U> From<Point3D<T, U>> for HomogeneousVector<T, U>where
T: One,
§fn from(p: Point3D<T, U>) -> HomogeneousVector<T, U>
fn from(p: Point3D<T, U>) -> HomogeneousVector<T, U>
§impl<T, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
impl<T, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read more§impl<T, U> MulAssign<T> for Point3D<T, U>
impl<T, U> MulAssign<T> for Point3D<T, U>
§fn mul_assign(&mut self, scale: T)
fn mul_assign(&mut self, scale: T)
*=
operation. Read more§impl<T, U> PartialEq for Point3D<T, U>where
T: PartialEq,
impl<T, U> PartialEq for Point3D<T, U>where
T: PartialEq,
§impl<T, U> Round for Point3D<T, U>where
T: Round,
impl<T, U> Round for Point3D<T, U>where
T: Round,
§fn round(self) -> Point3D<T, U>
fn round(self) -> Point3D<T, U>
See Point3D::round()
§impl<T, U> SubAssign<Size3D<T, U>> for Point3D<T, U>where
T: SubAssign,
impl<T, U> SubAssign<Size3D<T, U>> for Point3D<T, U>where
T: SubAssign,
§fn sub_assign(&mut self, other: Size3D<T, U>)
fn sub_assign(&mut self, other: Size3D<T, U>)
-=
operation. Read more§impl<T, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>
impl<T, U> SubAssign<Vector3D<T, U>> for Point3D<T, U>
§fn sub_assign(&mut self, other: Vector3D<T, U>)
fn sub_assign(&mut self, other: Vector3D<T, U>)
-=
operation. Read moreimpl<T, U> Copy for Point3D<T, U>where
T: Copy,
impl<T, U> Eq for Point3D<T, U>where
T: Eq,
Auto Trait Implementations§
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<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
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, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more