[][src]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: Ty: T

Methods

impl<T: Copy + Zero, U> TypedPoint2D<T, U>[src]

pub fn origin() -> Self[src]

Constructor, setting all components to zero.

pub fn zero() -> Self[src]

pub fn to_3d(&self) -> TypedPoint3D<T, U>[src]

Convert into a 3d point.

impl<T, U> TypedPoint2D<T, U>[src]

pub fn new(x: T, y: T) -> Self[src]

Constructor taking scalar values directly.

impl<T: Copy, U> TypedPoint2D<T, U>[src]

pub fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> Self[src]

Constructor taking properly typed Lengths instead of scalar values.

pub fn extend(&self, z: T) -> TypedPoint3D<T, U>[src]

Create a 3d point from this one, using the specified z value.

pub fn to_vector(&self) -> TypedVector2D<T, U>[src]

Cast this point into a vector.

Equivalent to subtracting the origin from this point.

pub fn yx(&self) -> Self[src]

Swap x and y.

pub fn x_typed(&self) -> Length<T, U>[src]

Returns self.x as a Length carrying the unit.

pub fn y_typed(&self) -> Length<T, U>[src]

Returns self.y as a Length carrying the unit.

pub fn to_untyped(&self) -> Point2D<T>[src]

Drop the units, preserving only the numeric value.

pub fn from_untyped(p: &Point2D<T>) -> Self[src]

Tag a unitless value with units.

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

pub fn to_tuple(&self) -> (T, T)[src]

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

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

impl<T: Float, U> TypedPoint2D<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[src]

impl<T: Round, U> TypedPoint2D<T, U>[src]

pub fn round(&self) -> Self[src]

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>[src]

pub fn ceil(&self) -> Self[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). For example { -0.1, -0.8 }.ceil() == { 0.0, 0.0 }.

impl<T: Floor, U> TypedPoint2D<T, U>[src]

pub fn floor(&self) -> Self[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). For example { -0.1, -0.8 }.floor() == { -1.0, -1.0 }.

impl<T: NumCast + Copy, U> TypedPoint2D<T, U>[src]

pub fn cast<NewT: NumCast + Copy>(&self) -> TypedPoint2D<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 + Copy>(&self) -> Option<TypedPoint2D<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) -> TypedPoint2D<f32, U>[src]

Cast into an f32 point.

pub fn to_f64(&self) -> TypedPoint2D<f64, U>[src]

Cast into an f64 point.

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

pub fn lerp(&self, other: Self, t: T) -> Self[src]

Linearly interpolate between this point and another point.

t is expected to be between zero and one.

Trait Implementations

impl<T: Copy + ApproxEq<T>, U> ApproxEq<TypedPoint2D<T, U>> for TypedPoint2D<T, U>[src]

impl<T, U> PartialEq<TypedPoint2D<T, U>> for TypedPoint2D<T, U> where
    T: PartialEq
[src]

#[must_use] fn ne(&self, other: &Rhs) -> bool1.0.0[src]

This method tests for !=.

impl<T, U> Eq for TypedPoint2D<T, U> where
    T: Eq
[src]

impl<T, U> Hash for TypedPoint2D<T, U> where
    T: Hash
[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0[src]

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

impl<T: Display, U> Display for TypedPoint2D<T, U>[src]

impl<T: Debug, U> Debug for TypedPoint2D<T, U>[src]

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

type Output = Self

The resulting type after applying the + operator.

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

type Output = Self

The resulting type after applying the + operator.

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

type Output = TypedVector2D<T, U>

The resulting type after applying the - operator.

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

type Output = Self

The resulting type after applying the - operator.

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

type Output = Self

The resulting type after applying the * operator.

impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<TypedScale<T, U1, U2>> for TypedPoint2D<T, U1>[src]

type Output = TypedPoint2D<T, U2>

The resulting type after applying the * operator.

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

type Output = Self

The resulting type after applying the / operator.

impl<T: Copy + Div<T, Output = T>, U1, U2> Div<TypedScale<T, U1, U2>> for TypedPoint2D<T, U2>[src]

type Output = TypedPoint2D<T, U1>

The resulting type after applying the / operator.

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

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

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

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

impl<T, U> Copy for TypedPoint2D<T, U> where
    T: Copy
[src]

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

impl<T: Copy, U> Into<(T, T)> for TypedPoint2D<T, U>[src]

impl<T: Zero + One, U> From<TypedPoint2D<T, U>> for HomogeneousVector<T, U>[src]

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

impl<T: Copy, U> From<(T, T)> for TypedPoint2D<T, U>[src]

impl<T, U> Clone for TypedPoint2D<T, U> where
    T: Clone
[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T: Default, U> Default for TypedPoint2D<T, U>[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]