#[repr(C)]
pub struct Translation2D<T, Src, Dst> { pub x: T, pub y: T, /* private fields */ }
Available on crate feature canvas only.
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§

§

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

pub const fn new(x: T, y: T) -> Translation2D<T, Src, Dst>

pub fn splat(v: T) -> Translation2D<T, Src, Dst>
where T: Clone,

pub fn identity() -> Translation2D<T, Src, Dst>
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, Src, Dst> Translation2D<T, Src, Dst>
where T: Copy,

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> ) -> Translation2D<T, Src, Dst>

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 as Add>::Output, Dst>
where T: Add,

Translate a point and cast its unit.

pub fn transform_rect(&self, r: &Rect<T, Src>) -> Rect<<T as Add>::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 as Add>::Output, Dst>
where T: Add,

Translate a 2D box and cast its unit.

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

Return the inverse transformation.

Trait Implementations§

§

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

§

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

The resulting type after applying the + operator.
§

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

Performs the + operation. Read more
§

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

§

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

Performs the += operation. Read more
§

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

§

fn clone(&self) -> Translation2D<T, Src, Dst>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

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

§

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

Formats the value using the given formatter. Read more
§

impl<T, Src, Dst> Default for Translation2D<T, Src, Dst>
where T: Zero,

§

fn default() -> Translation2D<T, Src, Dst>

Returns the “default value” for a type. Read more
§

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

§

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

Converts to this type from the input type.
§

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

§

fn hash<H>(&self, h: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl<T, Src, Dst> Into<Transform2D<T, Src, Dst>> for Translation2D<T, Src, Dst>
where T: Zero + One,

§

fn into(self) -> Transform2D<T, Src, Dst>

Converts this type into the (usually inferred) input type.
§

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

§

fn into(self) -> Vector2D<T, Src>

Converts this type into the (usually inferred) input type.
§

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

§

fn eq(&self, other: &Translation2D<T, Src, Dst>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

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

§

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

The resulting type after applying the - operator.
§

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

Performs the - operation. Read more
§

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

§

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

Performs the -= operation. Read more
§

impl<S> Transformation<S> for Translation2D<S, UnknownUnit, UnknownUnit>
where S: Scalar,

§

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

§

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>

§

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§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CallHasher for T
where T: Hash + ?Sized,

§

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64
where H: Hash + ?Sized, B: BuildHasher,

source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromAngle<T> for T

source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoStimulus<T> for T

source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> MaybeSend for T
where T: Send,

source§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T

§

impl<T> WasmNotSync for T
where T: Sync,