Skip to main content

Transform

Struct Transform 

Source
#[repr(C)]
pub struct Transform { pub angle: f32, pub scale: f32, pub tx: f32, pub ty: f32, }
Expand description

A similarity transform — a turn and a uniform scale about the origin, then a move: p' = R(angle) · scale · p + t, y down, so a positive angle turns clockwise on screen. What a node’s rotate, scale and pivot compose to (ADR 0043), carried by the clip entry its quads name (display::Clip::transform) in the same units as the entry’s rect.

#[repr(C)]: four floats, which is how KuiClip and the Node clips() buffer read it.

use kui_core::{Rect, Transform, Vec2};
// A quarter turn about the centre of a 100 × 50 box at (10, 10).
let t = Transform::about(Vec2::new(60.0, 35.0), 0.25, 1.0);
let p = t.apply(Vec2::new(10.0, 10.0));
assert!((p.x - 85.0).abs() < 1e-4 && (p.y - (-15.0)).abs() < 1e-4);
let back = t.unapply(p);
assert!((back.x - 10.0).abs() < 1e-4 && (back.y - 10.0).abs() < 1e-4);
// Its bounding box is the box turned: 50 wide, 100 tall, same centre.
let b = t.bounds(Rect::new(10.0, 10.0, 100.0, 50.0));
assert!((b.w - 50.0).abs() < 1e-3 && (b.h - 100.0).abs() < 1e-3);

Fields§

§angle: f32

Radians, clockwise with y down.

§scale: f32

The uniform factor; 1 for none.

§tx: f32

The move after the turn and the scale.

§ty: f32

Implementations§

Source§

impl Transform

Source

pub const IDENTITY: Transform

No turn, no scale, no move.

Source

pub fn about(pivot: Vec2, turns: f32, scale: f32) -> Self

A turn of turns (clockwise, y down) and a scale of scale about pivot, which stays where it is.

Source

pub fn is_identity(&self) -> bool

Source

pub fn apply(&self, p: Vec2) -> Vec2

p through this transform.

Source

pub fn unapply(&self, p: Vec2) -> Vec2

The point that maps to p: the inverse. A scale of zero has no inverse; the answer is then NaN, which no rect contains, so nothing is hit, as nothing is drawn.

Source

pub fn then(&self, outer: &Transform) -> Transform

This transform, then outer: the composition a nested turn is (inner.then(outer) maps a point as outer.apply(inner.apply(p))).

Source

pub fn scaled(&self, s: f32) -> Transform

Logical to physical pixels: the move scales, the turn and the factor do not.

Source

pub fn bounds(&self, r: Rect) -> Rect

The smallest axis-aligned rect holding r put through this transform: what an access rect and a cull read.

Source

pub fn unbounds(&self, r: Rect) -> Rect

The bounding box of r pulled back through this transform: the rect in this transform’s source space that covers everything of r in its target space — how a clip from outside a turn is approximated inside it (ADR 0043, decision 4).

Trait Implementations§

Source§

impl Clone for Transform

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Transform

Source§

impl Debug for Transform

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Transform

Source§

fn default() -> Self

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

impl PartialEq for Transform

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Transform

Auto Trait Implementations§

Blanket Implementations§

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> 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
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.