Struct kurbo::TranslateScale

pub struct TranslateScale {
    pub translation: Vec2,
    pub scale: f64,
}

A transformation consisting of a uniform scaling followed by a translation.

If the translation is (x, y) and the scale is s, then this transformation represents this augmented matrix:

| s 0 x |
| 0 s y |
| 0 0 1 |

See Affine for more details about the equivalence with augmented matrices.

Various multiplication ops are defined, and these are all defined to be consistent with matrix multiplication. Therefore, TranslateScale * Point is defined but not the other way around.

Also note that multiplication is not commutative. Thus, TranslateScale::scale(2.0) * TranslateScale::translate(Vec2::new(1.0, 0.0)) has a translation of (2, 0), while TranslateScale::translate(Vec2::new(1.0, 0.0)) * TranslateScale::scale(2.0) has a translation of (1, 0). (Both have a scale of 2; also note that the first case can be written 2.0 * TranslateScale::translate(Vec2::new(1.0, 0.0)) as this case has an implicit conversion).

This transformation is less powerful than Affine, but can be applied to more primitives, especially including Rect.

Fields

translation: Vec2

The translation component of this transformation

scale: f64

The scale component of this transformation

Implementations

impl TranslateScale

pub const fn new(translation: Vec2, scale: f64) -> TranslateScale

Create a new transformation from translation and scale.

pub const fn scale(s: f64) -> TranslateScale

Create a new transformation with scale only.

pub fn translate(translation: impl Into<Vec2>) -> TranslateScale

Create a new transformation with translation only.

pub const fn as_tuple(self) -> (Vec2, f64)

👎Deprecated: use the struct fields directly

Decompose transformation into translation and scale.

pub fn from_scale_about(scale: f64, focus: impl Into<Point>) -> Self

Create a transform that scales about a point other than the origin.

Examples

let center = Point::new(1., 1.);
let ts = TranslateScale::from_scale_about(2., center);
// Should keep the point (1., 1.) stationary
assert_near(ts * center, center);
// (2., 2.) -> (3., 3.)
assert_near(ts * Point::new(2., 2.), Point::new(3., 3.));

pub fn inverse(self) -> TranslateScale

Compute the inverse transform.

Multiplying a transform with its inverse (either on the left or right) results in the identity transform (modulo floating point rounding errors).

Produces NaN values when scale is zero.

pub fn is_finite(&self) -> bool

Is this translate/scale finite?

pub fn is_nan(&self) -> bool

Is this translate/scale NaN?

Trait Implementations

impl Add<TranslateScale> for Vec2

type Output = TranslateScale

The resulting type after applying the + operator.

fn add(self, other: TranslateScale) -> TranslateScale

Performs the + operation.

impl Add<Vec2> for TranslateScale

type Output = TranslateScale

The resulting type after applying the + operator.

fn add(self, other: Vec2) -> TranslateScale

Performs the + operation.

impl AddAssign<Vec2> for TranslateScale

fn add_assign(&mut self, other: Vec2)

Performs the += operation.

impl Clone for TranslateScale

fn clone(&self) -> TranslateScale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranslateScale

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

Formats the value using the given formatter.

impl Default for TranslateScale

fn default() -> TranslateScale

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TranslateScale

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TranslateScale> for Affine

fn from(ts: TranslateScale) -> Affine

Converts to this type from the input type.

impl JsonSchema for TranslateScale

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<'a> Mul<&'a BezPath> for TranslateScale

type Output = BezPath

The resulting type after applying the * operator.

fn mul(self, other: &BezPath) -> BezPath

Performs the * operation.

impl Mul<BezPath> for TranslateScale

type Output = BezPath

The resulting type after applying the * operator.

fn mul(self, other: BezPath) -> BezPath

Performs the * operation.

impl Mul<Circle> for TranslateScale

type Output = Circle

The resulting type after applying the * operator.

fn mul(self, other: Circle) -> Circle

Performs the * operation.

impl Mul<CubicBez> for TranslateScale

type Output = CubicBez

The resulting type after applying the * operator.

fn mul(self, other: CubicBez) -> CubicBez

Performs the * operation.

impl Mul<Line> for TranslateScale

type Output = Line

The resulting type after applying the * operator.

fn mul(self, other: Line) -> Line

Performs the * operation.

impl Mul<PathEl> for TranslateScale

type Output = PathEl

The resulting type after applying the * operator.

fn mul(self, other: PathEl) -> PathEl

Performs the * operation.

impl Mul<PathSeg> for TranslateScale

type Output = PathSeg

The resulting type after applying the * operator.

fn mul(self, other: PathSeg) -> PathSeg

Performs the * operation.

impl Mul<Point> for TranslateScale

type Output = Point

The resulting type after applying the * operator.

fn mul(self, other: Point) -> Point

Performs the * operation.

impl Mul<QuadBez> for TranslateScale

type Output = QuadBez

The resulting type after applying the * operator.

fn mul(self, other: QuadBez) -> QuadBez

Performs the * operation.

impl Mul<Rect> for TranslateScale

type Output = Rect

The resulting type after applying the * operator.

fn mul(self, other: Rect) -> Rect

Performs the * operation.

impl Mul<RoundedRect> for TranslateScale

type Output = RoundedRect

The resulting type after applying the * operator.

fn mul(self, other: RoundedRect) -> RoundedRect

Performs the * operation.

impl Mul<RoundedRectRadii> for TranslateScale

type Output = RoundedRectRadii

The resulting type after applying the * operator.

fn mul(self, other: RoundedRectRadii) -> RoundedRectRadii

Performs the * operation.

impl Mul<TranslateScale> for f64

type Output = TranslateScale

The resulting type after applying the * operator.

fn mul(self, other: TranslateScale) -> TranslateScale

Performs the * operation.

impl Mul for TranslateScale

type Output = TranslateScale

The resulting type after applying the * operator.

fn mul(self, other: TranslateScale) -> TranslateScale

Performs the * operation.

impl MulAssign for TranslateScale

fn mul_assign(&mut self, other: TranslateScale)

Performs the *= operation.

impl Serialize for TranslateScale

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Vec2> for TranslateScale

type Output = TranslateScale

The resulting type after applying the - operator.

fn sub(self, other: Vec2) -> TranslateScale

Performs the - operation.

impl SubAssign<Vec2> for TranslateScale

fn sub_assign(&mut self, other: Vec2)

Performs the -= operation.

impl Copy for TranslateScale