Struct TypedPoint2D

Source

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

Expand description

A 2d Point tagged with a unit.

Fields§

§x: T§y: T

Implementations§

Source §

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

Source

pub fn origin() -> TypedPoint2D<T, U>

Constructor, setting all components to zero.

Source

pub fn zero() -> TypedPoint2D<T, U>

Source

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

Convert into a 3d point.

Source §

impl<T, U> TypedPoint2D<T, U>

Source

pub fn new(x: T, y: T) -> TypedPoint2D<T, U>

Constructor taking scalar values directly.

Source §

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

Source

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

Constructor taking properly typed Lengths instead of scalar values.

Source

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

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

Source

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

Cast this point into a vector.

Equivalent to subtracting the origin from this point.

Source

pub fn yx(&self) -> TypedPoint2D<T, U>

Swap x and y.

Source

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

Returns self.x as a Length carrying the unit.

Source

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

Returns self.y as a Length carrying the unit.

Source

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

Drop the units, preserving only the numeric value.

Source

pub fn from_untyped(p: &TypedPoint2D<T, UnknownUnit>) -> TypedPoint2D<T, U>

Tag a unitless value with units.

Source

pub fn clamp( &self, start: TypedPoint2D<T, U>, end: TypedPoint2D<T, U>, ) -> TypedPoint2D<T, U>

Source §

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

Source

pub fn round(&self) -> TypedPoint2D<T, U>

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 }.

Source §

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

Source

pub fn ceil(&self) -> TypedPoint2D<T, U>

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 }.

Source §

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

Source

pub fn floor(&self) -> TypedPoint2D<T, U>

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 }.

Source §

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

Source

pub fn cast<NewT>(&self) -> TypedPoint2D<NewT, U>
where NewT: NumCast + Copy,

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.

Source

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

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.

Source

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

Cast into an f32 point.

Source

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

Cast into an f64 point.

Source

pub 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.

Source

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

Source

pub 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.

Source

pub 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.

Source §