Struct euclid::Translation2D

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

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

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

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

pub fn splat(v: T) -> Self

where T: Clone,

pub fn identity() -> Self

where T: Zero,

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

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);

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

No-op, just cast the unit.

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

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

Cast into a 2D vector.

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

Cast into an array with x and y.

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

Cast into a tuple with x and y.

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

Drop the units, preserving only the numeric value.

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

Tag a unitless value with units.

pub fn to_transform(&self) -> Transform2D<T, Src, Dst>

where T: Zero + One,

Returns the matrix representation of this translation.

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

where T: Add,

Translate a point and cast its unit.

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.

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

where T: Add,

Translate a 2D box and cast its unit.

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

where T: Neg,

Return the inverse transformation.

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

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.

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.

pub fn to_f32(self) -> Translation2D<f32, Src, Dst>

Cast into an f32 vector.

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

Cast into an f64 vector.

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.

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.

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.

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.

Trait Implementations

impl<T: Add, Src, Dst1, Dst2> Add<Translation2D<T, Dst1, Dst2>> for Translation2D<T, Src, Dst1>

type Output = Translation2D<<T as Add>::Output, Src, Dst2>

The resulting type after applying the + operator.

fn add(self, other: Translation2D<T, Dst1, Dst2>) -> Self::Output

Performs the + operation.

impl<T: AddAssign, Src, Dst> AddAssign<Translation2D<T, Dst, Dst>> for Translation2D<T, Src, Dst>

fn add_assign(&mut self, other: Translation2D<T, Dst, Dst>)

Performs the += operation.

impl<T: Clone, Src, Dst> Clone for Translation2D<T, Src, Dst>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, Src, Dst> Debug for Translation2D<T, Src, Dst>

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

Formats the value using the given formatter.

impl<T, Src, Dst> Default for Translation2D<T, Src, Dst>

where T: Zero,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T, Src, Dst> Deserialize<'de> for Translation2D<T, Src, Dst>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, Src, Dst> From<Translation2D<T, Src, Dst>> for Transform2D<T, Src, Dst>

where T: Zero + One,

fn from(t: Translation2D<T, Src, Dst>) -> Self

Converts to this type from the input type.

impl<T, Src, Dst> From<Translation2D<T, Src, Dst>> for Vector2D<T, Src>

fn from(t: Translation2D<T, Src, Dst>) -> Self

Converts to this type from the input type.

impl<T, Src, Dst> From<Vector2D<T, Src>> for Translation2D<T, Src, Dst>

fn from(v: Vector2D<T, Src>) -> Self

Converts to this type from the input type.

impl<T, Src, Dst> Hash for Translation2D<T, Src, Dst>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, Src, Dst> PartialEq for Translation2D<T, Src, Dst>

where T: PartialEq,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, Src, Dst> Serialize for Translation2D<T, Src, Dst>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Sub, Src, Dst1, Dst2> Sub<Translation2D<T, Dst1, Dst2>> for Translation2D<T, Src, Dst2>

type Output = Translation2D<<T as Sub>::Output, Src, Dst1>

The resulting type after applying the - operator.

fn sub(self, other: Translation2D<T, Dst1, Dst2>) -> Self::Output

Performs the - operation.

impl<T: SubAssign, Src, Dst> SubAssign<Translation2D<T, Dst, Dst>> for Translation2D<T, Src, Dst>

fn sub_assign(&mut self, other: Translation2D<T, Dst, Dst>)

Performs the -= operation.

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

impl<T, Src, Dst> Eq for Translation2D<T, Src, Dst>

where T: Eq,