Struct euclid::TypedPoint2D

#[repr(C)]
pub struct TypedPoint2D<T, U> {
    pub x: T,
    pub y: T,
    // some fields omitted
}

A 2d Point tagged with a unit.

Fields

x: T

y: T

Methods

impl<T: Copy + Zero, U> TypedPoint2D<T, U>

fn origin() -> Self

Constructor, setting all components to zero.

fn zero() -> Self

fn to_3d(&self) -> TypedPoint3D<T, U>

Convert into a 3d point.

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

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

Constructor taking scalar values directly.

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

Constructor taking properly typed Lengths instead of scalar values.

fn to_vector(&self) -> TypedVector2D<T, U>

Cast this point into a vector.

Equivalent to substracting the origin to this point.

fn x_typed(&self) -> Length<T, U>

Returns self.x as a Length carrying the unit.

fn y_typed(&self) -> Length<T, U>

Returns self.y as a Length carrying the unit.

fn to_untyped(&self) -> Point2D<T>

Drop the units, preserving only the numeric value.

fn from_untyped(p: &Point2D<T>) -> Self

Tag a unitless value with units.

fn to_array(&self) -> [T; 2]

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

fn add_size(&self, other: &TypedSize2D<T, U>) -> Self

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

fn min(self, other: TypedPoint2D<T, U>) -> Self

fn max(self, other: TypedPoint2D<T, U>) -> Self

impl<T: Round, U> TypedPoint2D<T, U>

fn round(&self) -> Self

Rounds each component to the nearest integer value.

This behavior is preserved for negative values (unlike the basic cast). For example { -0.1, -0.8 }.round() == { 0.0, -1.0 }.

impl<T: Ceil, U> TypedPoint2D<T, U>

fn ceil(&self) -> Self

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). For example { -0.1, -0.8 }.ceil() == { 0.0, 0.0 }.

impl<T: Floor, U> TypedPoint2D<T, U>

fn floor(&self) -> Self

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). For example { -0.1, -0.8 }.floor() == { -1.0, -1.0 }.

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

fn cast<NewT: NumCast + Copy>(&self) -> Option<TypedPoint2D<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.

fn to_f32(&self) -> TypedPoint2D<f32, U>

Cast into an f32 point.

fn to_usize(&self) -> TypedPoint2D<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.

fn to_i32(&self) -> TypedPoint2D<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.

fn to_i64(&self) -> TypedPoint2D<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, U> TypedPoint2D<T, U> where
    T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>, 

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

Linearly interpolate between this point and another point.

t is expected to be between zero and one.

Trait Implementations

impl<T: Clone, U> Clone for TypedPoint2D<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: Copy, U> Copy for TypedPoint2D<T, U>

impl<T, U> HeapSizeOf for TypedPoint2D<T, U> where
    T: HeapSizeOf, 

fn heap_size_of_children(&self) -> usize

Measure the size of any heap-allocated structures that hang off this value, but not the space taken up by the value itself (i.e. what size_of:: measures, more or less); that space is handled by the implementation of HeapSizeOf for Box below.

impl<T, U> Deserialize for TypedPoint2D<T, U> where
    T: Deserialize, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer, 

Deserialize this value from the given Serde deserializer.

impl<T, U> Serialize for TypedPoint2D<T, U> where
    T: Serialize, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T, U> Eq for TypedPoint2D<T, U> where
    T: Eq, 

impl<T, U> PartialEq for TypedPoint2D<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 !=.

impl<T, U> Hash for TypedPoint2D<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, 

Feeds a slice of this type into the given [Hasher].

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

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

Formats the value using the given formatter.

impl<T: Display, U> Display for TypedPoint2D<T, U>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Copy + Add<T, Output = T>, U> Add<TypedSize2D<T, U>> for TypedPoint2D<T, U>

type Output = TypedPoint2D<T, U>

The resulting type after applying the + operator

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

The method for the + operator

impl<T: Copy + Add<T, Output = T>, U> AddAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U>

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

The method for the += operator

impl<T: Copy + Sub<T, Output = T>, U> SubAssign<TypedVector2D<T, U>> for TypedPoint2D<T, U>

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

The method for the -= operator

impl<T: Copy + Add<T, Output = T>, U> Add<TypedVector2D<T, U>> for TypedPoint2D<T, U>

type Output = TypedPoint2D<T, U>

The resulting type after applying the + operator

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

The method for the + operator

impl<T: Copy + Sub<T, Output = T>, U> Sub for TypedPoint2D<T, U>

type Output = TypedVector2D<T, U>

The resulting type after applying the - operator

fn sub(self, other: TypedPoint2D<T, U>) -> TypedVector2D<T, U>

The method for the - operator

impl<T: Copy + Sub<T, Output = T>, U> Sub<TypedVector2D<T, U>> for TypedPoint2D<T, U>

type Output = Self

The resulting type after applying the - operator

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

The method for the - operator

impl<T: Copy + Mul<T, Output = T>, U> Mul<T> for TypedPoint2D<T, U>

type Output = Self

The resulting type after applying the * operator

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

The method for the * operator

impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for TypedPoint2D<T, U>

fn mul_assign(&mut self, scale: T)

The method for the *= operator

impl<T: Copy + Div<T, Output = T>, U> Div<T> for TypedPoint2D<T, U>

type Output = Self

The resulting type after applying the / operator

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

The method for the / operator

impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for TypedPoint2D<T, U>

fn div_assign(&mut self, scale: T)

The method for the /= operator

impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<ScaleFactor<T, U1, U2>> for TypedPoint2D<T, U1>

type Output = TypedPoint2D<T, U2>

The resulting type after applying the * operator

fn mul(self, scale: ScaleFactor<T, U1, U2>) -> TypedPoint2D<T, U2>

The method for the * operator

impl<T: Copy + Div<T, Output = T>, U1, U2> Div<ScaleFactor<T, U1, U2>> for TypedPoint2D<T, U2>

type Output = TypedPoint2D<T, U1>

The resulting type after applying the / operator

fn div(self, scale: ScaleFactor<T, U1, U2>) -> TypedPoint2D<T, U1>

The method for the / operator

impl<T: Copy + ApproxEq<T>, U> ApproxEq<Self> for TypedPoint2D<T, U>

fn approx_epsilon() -> Self

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

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

impl<T: Copy, U> Into<[T; 2]> for TypedPoint2D<T, U>

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

Performs the conversion.

impl<T: Copy, U> From<[T; 2]> for TypedPoint2D<T, U>

fn from(array: [T; 2]) -> Self

Performs the conversion.