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 a source and a 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
sourceimpl<T, Src, Dst> Translation2D<T, Src, Dst>
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,
sourcepub fn is_identity(&self) -> bool where
T: Zero + PartialEq,
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);
sourcepub fn transform_size(&self, s: Size2D<T, Src>) -> Size2D<T, Dst>
pub fn transform_size(&self, s: Size2D<T, Src>) -> Size2D<T, Dst>
No-op, just cast the unit.
sourceimpl<T: Copy, Src, Dst> Translation2D<T, Src, Dst>
impl<T: Copy, Src, Dst> Translation2D<T, Src, Dst>
sourcepub fn to_untyped(&self) -> Translation2D<T, UnknownUnit, UnknownUnit>
pub fn to_untyped(&self) -> Translation2D<T, UnknownUnit, UnknownUnit>
Drop the units, preserving only the numeric value.
sourcepub fn from_untyped(t: &Translation2D<T, UnknownUnit, UnknownUnit>) -> Self
pub fn from_untyped(t: &Translation2D<T, UnknownUnit, UnknownUnit>) -> Self
Tag a unitless value with units.
sourcepub fn to_transform(&self) -> Transform2D<T, Src, Dst> where
T: Zero + One,
pub fn to_transform(&self) -> Transform2D<T, Src, Dst> where
T: Zero + One,
Returns the matrix representation of this translation.
sourcepub fn transform_point(&self, p: Point2D<T, Src>) -> Point2D<T::Output, Dst> where
T: Add,
pub fn transform_point(&self, p: Point2D<T, Src>) -> Point2D<T::Output, Dst> where
T: Add,
Translate a point and cast its unit.
sourcepub fn transform_rect(&self, r: &Rect<T, Src>) -> Rect<T::Output, Dst> where
T: Add<Output = T>,
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.
sourcepub fn transform_box(&self, r: &Box2D<T, Src>) -> Box2D<T::Output, Dst> where
T: Add,
pub fn transform_box(&self, r: &Box2D<T, Src>) -> Box2D<T::Output, Dst> where
T: Add,
Translate a 2D box and cast its unit.
sourcepub fn inverse(&self) -> Translation2D<T::Output, Dst, Src> where
T: Neg,
pub fn inverse(&self) -> Translation2D<T::Output, Dst, Src> where
T: Neg,
Return the inverse transformation.
Trait Implementations
sourceimpl<T: Add, Src, Dst1, Dst2> Add<Translation2D<T, Dst1, Dst2>> for Translation2D<T, Src, Dst1>
impl<T: Add, Src, Dst1, Dst2> Add<Translation2D<T, Dst1, Dst2>> for Translation2D<T, Src, Dst1>
type Output = Translation2D<T::Output, Src, Dst2>
type Output = Translation2D<T::Output, Src, Dst2>
The resulting type after applying the +
operator.
sourcefn add(self, other: Translation2D<T, Dst1, Dst2>) -> Self::Output
fn add(self, other: Translation2D<T, Dst1, Dst2>) -> Self::Output
Performs the +
operation. Read more
sourceimpl<T: AddAssign, Src, Dst> AddAssign<Translation2D<T, Dst, Dst>> for Translation2D<T, Src, Dst>
impl<T: AddAssign, Src, Dst> AddAssign<Translation2D<T, Dst, Dst>> for Translation2D<T, Src, Dst>
sourcefn add_assign(&mut self, other: Translation2D<T, Dst, Dst>)
fn add_assign(&mut self, other: Translation2D<T, Dst, Dst>)
Performs the +=
operation. Read more
sourceimpl<T: Clone, Src, Dst> Clone for Translation2D<T, Src, Dst>
impl<T: Clone, Src, Dst> Clone for Translation2D<T, Src, Dst>
sourceimpl<T: Debug, Src, Dst> Debug for Translation2D<T, Src, Dst>
impl<T: Debug, Src, Dst> Debug for Translation2D<T, Src, Dst>
sourceimpl<T, Src, Dst> Default for Translation2D<T, Src, Dst> where
T: Zero,
impl<T, Src, Dst> Default for Translation2D<T, Src, Dst> where
T: Zero,
sourceimpl<T, Src, Dst> From<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
impl<T, Src, Dst> From<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
sourceimpl<T, Src, Dst> Hash for Translation2D<T, Src, Dst> where
T: Hash,
impl<T, Src, Dst> Hash for Translation2D<T, Src, Dst> where
T: Hash,
sourceimpl<T, Src, Dst> Into<Transform2D<T, Src, Dst>> for Translation2D<T, Src, Dst> where
T: Zero + One,
impl<T, Src, Dst> Into<Transform2D<T, Src, Dst>> for Translation2D<T, Src, Dst> where
T: Zero + One,
sourcefn into(self) -> Transform2D<T, Src, Dst>
fn into(self) -> Transform2D<T, Src, Dst>
Converts this type into the (usually inferred) input type.
sourceimpl<T, Src, Dst> Into<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
impl<T, Src, Dst> Into<Vector2D<T, Src>> for Translation2D<T, Src, Dst>
sourceimpl<T, Src, Dst> PartialEq<Translation2D<T, Src, Dst>> for Translation2D<T, Src, Dst> where
T: PartialEq,
impl<T, Src, Dst> PartialEq<Translation2D<T, Src, Dst>> for Translation2D<T, Src, Dst> where
T: PartialEq,
sourceimpl<T: Sub, Src, Dst1, Dst2> Sub<Translation2D<T, Dst1, Dst2>> for Translation2D<T, Src, Dst2>
impl<T: Sub, Src, Dst1, Dst2> Sub<Translation2D<T, Dst1, Dst2>> for Translation2D<T, Src, Dst2>
type Output = Translation2D<T::Output, Src, Dst1>
type Output = Translation2D<T::Output, Src, Dst1>
The resulting type after applying the -
operator.
sourcefn sub(self, other: Translation2D<T, Dst1, Dst2>) -> Self::Output
fn sub(self, other: Translation2D<T, Dst1, Dst2>) -> Self::Output
Performs the -
operation. Read more
sourceimpl<T: SubAssign, Src, Dst> SubAssign<Translation2D<T, Dst, Dst>> for Translation2D<T, Src, Dst>
impl<T: SubAssign, Src, Dst> SubAssign<Translation2D<T, Dst, Dst>> for Translation2D<T, Src, Dst>
sourcefn sub_assign(&mut self, other: Translation2D<T, Dst, Dst>)
fn sub_assign(&mut self, other: Translation2D<T, Dst, Dst>)
Performs the -=
operation. Read more
impl<T: Copy, Src, Dst> Copy for Translation2D<T, Src, Dst>
impl<T, Src, Dst> Eq for Translation2D<T, Src, Dst> where
T: Eq,
Auto Trait Implementations
impl<T, Src, Dst> RefUnwindSafe for Translation2D<T, Src, Dst> where
Dst: RefUnwindSafe,
Src: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, Src, Dst> Send for Translation2D<T, Src, Dst> where
Dst: Send,
Src: Send,
T: Send,
impl<T, Src, Dst> Sync for Translation2D<T, Src, Dst> where
Dst: Sync,
Src: Sync,
T: Sync,
impl<T, Src, Dst> Unpin for Translation2D<T, Src, Dst> where
Dst: Unpin,
Src: Unpin,
T: Unpin,
impl<T, Src, Dst> UnwindSafe for Translation2D<T, Src, Dst> where
Dst: UnwindSafe,
Src: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more