Struct euclid::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: T

y: T

Methods

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

pub fn origin() -> Self

Constructor, setting all components to zero.

pub fn zero() -> Self

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

Convert into a 3d point.

impl<T, U> Point2D<T, U>

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

Constructor taking scalar values directly.

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

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

Constructor taking properly Lengths instead of scalar values.

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

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

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

Cast this point into a vector.

Equivalent to subtracting the origin from this point.

pub fn yx(&self) -> Self

Swap x and y.

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

Drop the units, preserving only the numeric value.

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

Tag a unitless value with units.

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

Cast the unit

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

pub fn to_tuple(&self) -> (T, T)

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

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

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

pub fn min(self, other: Self) -> Self

pub fn max(self, other: Self) -> Self

pub fn clamp(&self, start: Self, end: Self) -> Self

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

#[must_use] pub 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> Point2D<T, U>

#[must_use] pub 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> Point2D<T, U>

#[must_use] pub 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> Point2D<T, U>

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

pub fn try_cast<NewT: NumCast + Copy>(&self) -> Option<Point2D<NewT, U>>

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>

Cast into an f32 point.

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

Cast into an f64 point.

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

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

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

pub 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: Copy + Add<T, Output = T>, U> Add<Size2D<T, U>> for Point2D<T, U>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Copy + Add<T, Output = T>, U> Add<Vector2D<T, U>> for Point2D<T, U>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

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

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

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

Formats the value using the given formatter.

impl<T: Default, U> Default for Point2D<T, U>

fn default() -> Self

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

impl<T: Copy + Div<T, Output = T>, U1, U2> Div<Scale<T, U1, U2>> for Point2D<T, U2>

type Output = Point2D<T, U1>

The resulting type after applying the / operator.

fn div(self, scale: Scale<T, U1, U2>) -> Point2D<T, U1>

Performs the / operation.

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

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

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

fn div_assign(&mut self, scale: T)

Performs the /= operation.

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

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

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

Performs the conversion.

impl<T: Copy, U> From<(T, T)> for Point2D<T, U>

fn from(tuple: (T, T)) -> Self

Performs the conversion.

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

fn from(p: Point2D<T, U>) -> Self

Performs the conversion.

impl<T, U> Hash for Point2D<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: Copy, U> Into<[T; 2]> for Point2D<T, U>

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

Performs the conversion.

impl<T: Copy, U> Into<(T, T)> for Point2D<T, U>

fn into(self) -> (T, T)

Performs the conversion.

impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<Scale<T, U1, U2>> for Point2D<T, U1>

type Output = Point2D<T, U2>

The resulting type after applying the * operator.

fn mul(self, scale: Scale<T, U1, U2>) -> Point2D<T, U2>

Performs the * operation.

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

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

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

type Output = Vector2D<T, U>

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.