Struct Transform

pub struct Transform { /* private fields */ }

A transform builder type.

Builder

The transform can be started by one of Transform::new_* associated functions or Transform::identity. More transforms can be chained by calling the methods for each.

Examples

Create a transform that

let rotate_then_move = Transform::new_rotate(10.deg()).translate(50, 30);

Implementations

impl Transform

pub fn identity() -> Self

No transform.

pub fn new_rotate<A: Into<AngleRadian>>(angle: A) -> Transform

Create a 2d rotation transform.

pub fn new_rotate_x<A: Into<AngleRadian>>(angle: A) -> Transform

Create a 3d rotation transform around the x axis.

pub fn new_rotate_y<A: Into<AngleRadian>>(angle: A) -> Transform

Create a 3d rotation transform around the y axis.

pub fn new_rotate_z<A: Into<AngleRadian>>(angle: A) -> Transform

Same as new_rotate.

pub fn new_rotate_3d<A: Into<AngleRadian>>( x: f32, y: f32, z: f32, angle: A, ) -> Transform

Create a 3d rotation transform.

pub fn new_translate<X: Into<Length>, Y: Into<Length>>(x: X, y: Y) -> Transform

Create a 2d translation transform.

pub fn new_translate_3d<X: Into<Length>, Y: Into<Length>, Z: Into<Length>>( x: X, y: Y, z: Z, ) -> Transform

Create a 3d translation transform.

pub fn new_translate_x<X: Into<Length>>(x: X) -> Transform

Create a 2d translation transform in the X dimension.

pub fn new_translate_y<Y: Into<Length>>(y: Y) -> Transform

Create a 2d translation transform in the Y dimension.

pub fn new_translate_z<Z: Into<Length>>(z: Z) -> Transform

Create a 3d translation transform in the z dimension.

pub fn new_perspective<D: Into<Length>>(d: D) -> Transform

Create a 3d perspective transform.

pub fn new_skew<X: Into<AngleRadian>, Y: Into<AngleRadian>>( x: X, y: Y, ) -> Transform

Create a 2d skew transform.

pub fn new_skew_x<X: Into<AngleRadian>>(x: X) -> Transform

Create a 2d skew transform in the X dimension.

pub fn new_skew_y<Y: Into<AngleRadian>>(y: Y) -> Transform

Create a 2d skew transform in the Y dimension.

pub fn new_scale<S: Into<Factor>>(scale: S) -> Transform

Create a 2d scale transform.

The same scale is applied to both dimensions.

pub fn new_scale_x<X: Into<Factor>>(x: X) -> Transform

Create a 2d scale transform on the X dimension.

pub fn new_scale_y<Y: Into<Factor>>(y: Y) -> Transform

Create a 2d scale transform on the Y dimension.

pub fn new_scale_xy<X: Into<Factor>, Y: Into<Factor>>(x: X, y: Y) -> Transform

Create a 2d scale transform.

impl Transform

pub fn then(self, other: Transform) -> Self

Change self to apply other after its transformation.

Examples

Transform::new_rotate(10.deg()).then(Transform::new_translate(50, 30));

Is the equivalent of:

Transform::new_rotate(10.deg()).translate(50, 30);

pub fn rotate<A: Into<AngleRadian>>(self, angle: A) -> Self

Change self to apply a 2d rotation after its transformation.

pub fn rotate_x<A: Into<AngleRadian>>(self, angle: A) -> Self

Change self to apply a 3d rotation around the x axis.

Note that the composition of 3D rotations is usually not commutative, so the order this is applied will affect the result.

pub fn rotate_y<A: Into<AngleRadian>>(self, angle: A) -> Self

Change self to apply a 3d rotation around the y axis.

Note that the composition of 3D rotations is usually not commutative, so the order this is applied will affect the result.

pub fn rotate_z<A: Into<AngleRadian>>(self, angle: A) -> Self

Same as rotate.

pub fn rotate_3d<A: Into<AngleRadian>>( self, x: f32, y: f32, z: f32, angle: A, ) -> Self

Change self to apply a 3d rotation.

Note that the composition of 3D rotations is usually not commutative, so the order this is applied will affect the result.

pub fn translate<X: Into<Length>, Y: Into<Length>>(self, x: X, y: Y) -> Self

Change self to apply a 2d translation after its transformation.

pub fn translate_x<X: Into<Length>>(self, x: X) -> Self

Change self to apply a x translation after its transformation.

pub fn translate_y<Y: Into<Length>>(self, y: Y) -> Self

Change self to apply a y translation after its transformation.

pub fn translate_z<Z: Into<Length>>(self, z: Z) -> Self

Change self to apply a z translation after its transformation.

pub fn translate_3d<X: Into<Length>, Y: Into<Length>, Z: Into<Length>>( self, x: X, y: Y, z: Z, ) -> Self

Change self to apply a 3d translation after its transformation.

Note that the composition of 3D rotations is usually not commutative, so the order this is applied will affect the result.

pub fn skew<X: Into<AngleRadian>, Y: Into<AngleRadian>>( self, x: X, y: Y, ) -> Self

Change self to apply a 2d skew after its transformation.

pub fn skew_x<X: Into<AngleRadian>>(self, x: X) -> Self

Change self to apply a x skew after its transformation.

pub fn skew_y<Y: Into<AngleRadian>>(self, y: Y) -> Self

Change self to apply a y skew after its transformation.

pub fn scale_xy<X: Into<Factor>, Y: Into<Factor>>(self, x: X, y: Y) -> Self

Change self to apply a 2d scale after its transformation.

pub fn scale_x<X: Into<Factor>>(self, x: X) -> Self

Change self to apply a x scale after its transformation.

pub fn scale_y<Y: Into<Factor>>(self, y: Y) -> Self

Change self to apply a y scale after its transformation.

pub fn scale<S: Into<Factor>>(self, scale: S) -> Self

Change self to apply a uniform 2d scale after its transformation.

pub fn perspective<D: Into<Length>>(self, d: D) -> Self

Change self 3d perspective distance.

impl Transform

pub fn layout(&self) -> PxTransform

Compute a PxTransform in the current LAYOUT context.

pub fn try_layout(&self) -> Option<PxTransform>

Compute a PxTransform if it is not affected by the layout context.

pub fn needs_layout(&self) -> bool

Returns true if this transform is affected by the layout context where it is evaluated.

Trait Implementations

impl Clone for Transform

fn clone(&self) -> Transform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Transform

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

Formats the value using the given formatter.

impl Default for Transform

fn default() -> Transform

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Transform

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PxTransform> for Transform

fn from(t: PxTransform) -> Self

Converts to this type from the input type.

impl IntoVar<Transform> for PxTransform

type Var = LocalVar<Transform>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Layout2d for Transform

type Px = PxTransform

Pixel type.

fn layout_dft(&self, _: Self::Px) -> Self::Px

Compute the pixel value in the current LAYOUT context with default.

fn affect_mask(&self) -> LayoutMask

Compute a LayoutMask that flags all contextual values that affect the result of layout.

fn layout(&self) -> Self::Px

Compute the pixel value in the current LAYOUT context.

impl PartialEq for Transform

fn eq(&self, other: &Transform) -> 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 Serialize for Transform

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transitionable for Transform

fn lerp(self, to: &Self, step: EasingStep) -> Self

Sample the linear interpolation from self -> to by step.

impl IntoValue<Transform> for PxTransform

impl StructuralPartialEq for Transform