[][src]Struct euclid::point::Point2D

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

A 2d Point tagged with a unit.

Fields

x: Ty: T

Implementations

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

pub fn origin() -> Self where
    T: Zero
[src]

Constructor, setting all components to zero.

pub fn zero() -> Self where
    T: Zero
[src]

The same as origin().

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

Constructor taking scalar values directly.

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

Constructor taking properly Lengths instead of scalar values.

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

Tag a unitless value with units.

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

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

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

pub fn to_vector(&self) -> Vector2D<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.

Example

enum Mm {}

let point: Point2D<_, Mm> = point2(1, -8);

assert_eq!(point.yx(), point2(-8, 1));

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

Drop the units, preserving only the numeric value.

Example

enum Mm {}

let point: Point2D<_, Mm> = point2(1, -8);

assert_eq!(point.x, point.to_untyped().x);
assert_eq!(point.y, point.to_untyped().y);

pub fn cast_unit<V>(&self) -> Point2D<T, V>[src]

Cast the unit, preserving the numeric value.

Example

enum Mm {}
enum Cm {}

let point: Point2D<_, Mm> = point2(1, -8);

assert_eq!(point.x, point.cast_unit::<Cm>().x);
assert_eq!(point.y, point.cast_unit::<Cm>().y);

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

Cast into an array with x and y.

Example

enum Mm {}

let point: Point2D<_, Mm> = point2(1, -8);

assert_eq!(point.to_array(), [1, -8]);

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

Cast into a tuple with x and y.

Example

enum Mm {}

let point: Point2D<_, Mm> = point2(1, -8);

assert_eq!(point.to_tuple(), (1, -8));

pub fn to_3d(&self) -> Point3D<T, U> where
    T: Zero
[src]

Convert into a 3d point with z-coordinate equals to zero.

#[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!(point2::<_, Mm>(-0.1, -0.8).round(), point2::<_, Mm>(0.0, -1.0))

#[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!(point2::<_, Mm>(-0.1, -0.8).ceil(), point2::<_, Mm>(0.0, 0.0))

#[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!(point2::<_, Mm>(-0.1, -0.8).floor(), point2::<_, Mm>(-1.0, -1.0))

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::point2;
use euclid::default::Point2D;

let from: Point2D<_> = point2(0.0, 10.0);
let to:  Point2D<_> = point2(8.0, -4.0);

assert_eq!(from.lerp(to, -1.0), point2(-8.0,  24.0));
assert_eq!(from.lerp(to,  0.0), point2( 0.0,  10.0));
assert_eq!(from.lerp(to,  0.5), point2( 4.0,   3.0));
assert_eq!(from.lerp(to,  1.0), point2( 8.0,  -4.0));
assert_eq!(from.lerp(to,  2.0), point2(16.0, -18.0));

impl<T: PartialOrd, U> Point2D<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]

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> Point2D<T, U>[src]

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

Cast into an f32 point.

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

Cast into an f64 point.

pub fn to_usize(&self) -> Point2D<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) -> Point2D<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) -> Point2D<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) -> Point2D<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> Point2D<T, U>[src]

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

impl<T: Float + Sub<T, Output = T>, U> Point2D<T, U>[src]

pub fn distance_to(self, other: Self) -> T[src]

Trait Implementations

impl<T: Add, U> Add<Size2D<T, U>> for Point2D<T, U>[src]

type Output = Point2D<T::Output, U>

The resulting type after applying the + operator.

impl<T: Add, U> Add<Vector2D<T, U>> for Point2D<T, U>[src]

type Output = Point2D<T::Output, U>

The resulting type after applying the + operator.

impl<T: AddAssign, U> AddAssign<Size2D<T, U>> for Point2D<T, U>[src]

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

impl<T: ApproxEq<T>, U> ApproxEq<Point2D<T, U>> for Point2D<T, U>[src]

impl<T: Ceil, U> Ceil for Point2D<T, U>[src]

fn ceil(self) -> Self[src]

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

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

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

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

impl<'de, T, U> Deserialize<'de> for Point2D<T, U> where
    T: Deserialize<'de>, 
[src]

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

impl<T: Clone + Div, U1, U2> Div<Scale<T, U1, U2>> for Point2D<T, U2>[src]

type Output = Point2D<T::Output, U1>

The resulting type after applying the / operator.

impl<T: Clone + Div, U> Div<T> for Point2D<T, U>[src]

type Output = Point2D<T::Output, U>

The resulting type after applying the / operator.

impl<T: Clone + DivAssign, U> DivAssign<Scale<T, U, U>> for Point2D<T, U>[src]

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

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

impl<T: Floor, U> Floor for Point2D<T, U>[src]

fn floor(self) -> Self[src]

impl<T, U> From<[T; 2]> for Point2D<T, U>[src]

impl<T, U> From<(T, T)> for Point2D<T, U>[src]

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

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

impl<T, U> Into<[T; 2]> for Point2D<T, U>[src]

impl<T, U> Into<(T, T)> for Point2D<T, U>[src]

impl<T: Clone + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Point2D<T, U1>[src]

type Output = Point2D<T::Output, U2>

The resulting type after applying the * operator.

impl<T: Clone + Mul, U> Mul<T> for Point2D<T, U>[src]

type Output = Point2D<T::Output, U>

The resulting type after applying the * operator.

impl<T: Clone + MulAssign, U> MulAssign<Scale<T, U, U>> for Point2D<T, U>[src]

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

impl<T: Neg, U> Neg for Point2D<T, U>[src]

type Output = Point2D<T::Output, U>

The resulting type after applying the - operator.

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

impl<T: Round, U> Round for Point2D<T, U>[src]

fn round(self) -> Self[src]

impl<T, U> Serialize for Point2D<T, U> where
    T: Serialize
[src]

impl<T: Sub, U> Sub<Point2D<T, U>> for Point2D<T, U>[src]

type Output = Vector2D<T::Output, U>

The resulting type after applying the - operator.

impl<T: Sub, U> Sub<Size2D<T, U>> for Point2D<T, U>[src]

type Output = Point2D<T::Output, U>

The resulting type after applying the - operator.

impl<T: Sub, U> Sub<Vector2D<T, U>> for Point2D<T, U>[src]

type Output = Point2D<T::Output, U>

The resulting type after applying the - operator.

impl<T: SubAssign, U> SubAssign<Size2D<T, U>> for Point2D<T, U>[src]

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

impl<T: Zero, U> Zero for Point2D<T, U>[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

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

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

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[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]

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> 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> Zero for T where
    T: Zero
[src]