Struct euclid::Translation2D

source ·

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

Expand description

A 2d transformation from a space to another that can only express translations.

The main benefit of this type over a Vector2D is the ability to cast between source and destination spaces.

Example:

use euclid::{Translation2D, Point2D, point2};
struct ParentSpace;
struct ChildSpace;
type ScrollOffset = Translation2D<i32, ParentSpace, ChildSpace>;
type ParentPoint = Point2D<i32, ParentSpace>;
type ChildPoint = Point2D<i32, ChildSpace>;

let scrolling = ScrollOffset::new(0, 100);
let p1: ParentPoint = point2(0, 0);
let p2: ChildPoint = scrolling.transform_point(p1);

Fields§

§x: T§y: T

Implementations§

source §

pub fn identity() -> Self
where T: Zero,

Creates no-op translation (both x and y is zero()).

source

pub fn is_identity(&self) -> bool
where T: Zero + PartialEq,

Check if translation does nothing (both x and y is zero()).

use euclid::default::Translation2D;

assert_eq!(Translation2D::<f32>::identity().is_identity(), true);
assert_eq!(Translation2D::new(0, 0).is_identity(), true);
assert_eq!(Translation2D::new(1, 0).is_identity(), false);
assert_eq!(Translation2D::new(0, 1).is_identity(), false);

source

pub fn transform_size(&self, s: Size2D<T, Src>) -> Size2D<T, Dst>

No-op, just cast the unit.

source §

impl<T: Copy, Src, Dst> Translation2D<T, Src, Dst>

source

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

Cast into a 2D vector.

source

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

Cast into an array with x and y.

source

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

Cast into a tuple with x and y.

source

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

Drop the units, preserving only the numeric value.

source

pub fn from_untyped(t: &Translation2D<T, UnknownUnit, UnknownUnit>) -> Self

Tag a unitless value with units.

source

pub fn to_transform(&self) -> Transform2D<T, Src, Dst>
where T: Zero + One,

Returns the matrix representation of this translation.

source

pub fn transform_point(&self, p: Point2D<T, Src>) -> Point2D<T::Output, Dst>
where T: Add,

Translate a point and cast its unit.

source

pub fn transform_rect(&self, r: &Rect<T, Src>) -> Rect<T::Output, Dst>
where T: Add<Output = T>,

Translate a rectangle and cast its unit.

source

pub fn transform_box(&self, r: &Box2D<T, Src>) -> Box2D<T::Output, Dst>
where T: Add,

Translate a 2D box and cast its unit.

source

pub fn inverse(&self) -> Translation2D<T::Output, Dst, Src>
where T: Neg,

Return the inverse transformation.

source §

impl<T: NumCast + Copy, Src, Dst> Translation2D<T, Src, Dst>

source

pub fn cast<NewT: NumCast>(self) -> Translation2D<NewT, Src, Dst>

Cast from one numeric representation to another, preserving the units.

When casting from floating vector 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: NumCast>(self) -> Option<Translation2D<NewT, Src, Dst>>

Fallible cast from one numeric representation to another, preserving the units.

When casting from floating vector 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) -> Translation2D<f32, Src, Dst>

Cast into an f32 vector.

source

pub fn to_f64(self) -> Translation2D<f64, Src, Dst>

Cast into an f64 vector.

source

pub fn to_usize(self) -> Translation2D<usize, Src, Dst>

Cast into an usize vector, truncating decimals if any.

When casting from floating vector vectors, 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) -> Translation2D<u32, Src, Dst>

Cast into an u32 vector, truncating decimals if any.

When casting from floating vector vectors, 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) -> Translation2D<i32, Src, Dst>

Cast into an i32 vector, truncating decimals if any.

When casting from floating vector vectors, 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) -> Translation2D<i64, Src, Dst>

Cast into an i64 vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.