[−][src]Struct euclid::TypedScale

#[repr(C)]
pub struct TypedScale<T, Src, Dst>(pub T, _);

A scaling factor between two different units of measurement.

This is effectively a type-safe float, intended to be used in combination with other types like length::Length to enforce conversion between systems of measurement at compile time.

Src and Dst represent the units before and after multiplying a value by a TypedScale. They may be types without values, such as empty enums. For example:

use euclid::TypedScale;
use euclid::Length;
enum Mm {};
enum Inch {};

let mm_per_inch: TypedScale<f32, Inch, Mm> = TypedScale::new(25.4);

let one_foot: Length<f32, Inch> = Length::new(12.0);
let one_foot_in_mm: Length<f32, Mm> = one_foot * mm_per_inch;

Methods

`impl<T, Src, Dst> TypedScale<T, Src, Dst>`[src]

`pub fn new(x: T) -> Self`[src]

`impl<T: Clone, Src, Dst> TypedScale<T, Src, Dst>`[src]

`pub fn get(&self) -> T`[src]

`impl<Src, Dst> TypedScale<f32, Src, Dst>`[src]

`pub const ONE: Self`[src]

Identity scaling, could be used to safely transit from one space to another.

`impl<T: Clone + One + Div<T, Output = T>, Src, Dst> TypedScale<T, Src, Dst>`[src]

`pub fn inv(&self) -> TypedScale<T, Dst, Src>`[src]

The inverse TypedScale (1.0 / self).

`impl<T: NumCast + Clone, Src, Dst0> TypedScale<T, Src, Dst0>`[src]

`pub fn cast<T1: NumCast + Clone>(&self) -> TypedScale<T1, Src, Dst0>`[src]

Cast from one numeric representation to another, preserving the units.

`pub fn try_cast<T1: NumCast + Clone>(&self) -> Option<TypedScale<T1, Src, Dst0>>`[src]

Fallible cast from one numeric representation to another, preserving the units.

`impl<T, Src, Dst> TypedScale<T, Src, Dst> where T: Copy + Clone + Mul<T, Output = T> + Neg<Output = T> + PartialEq + One,` [src]

`pub fn transform_point( &self, point: &TypedPoint2D<T, Src> ) -> TypedPoint2D<T, Dst>`[src]

Returns the given point transformed by this scale.

`pub fn transform_vector( &self, vec: &TypedVector2D<T, Src> ) -> TypedVector2D<T, Dst>`[src]

Returns the given vector transformed by this scale.

`pub fn transform_size(&self, size: &TypedSize2D<T, Src>) -> TypedSize2D<T, Dst>`[src]

Returns the given vector transformed by this scale.

`pub fn transform_rect(&self, rect: &TypedRect<T, Src>) -> TypedRect<T, Dst>`[src]

Returns the given rect transformed by this scale.

`pub fn inverse(&self) -> TypedScale<T, Dst, Src>`[src]

Returns the inverse of this scale.

`pub fn is_identity(&self) -> bool`[src]

Returns true if this scale has no effect.

Trait Implementations

`impl<T: PartialEq, Src, Dst> PartialEq<TypedScale<T, Src, Dst>> for TypedScale<T, Src, Dst>`[src]

`fn eq(&self, other: &TypedScale<T, Src, Dst>) -> bool`[src]

`#[must_use] fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

This method tests for !=.

`impl<T: Copy, Src, Dst> Copy for TypedScale<T, Src, Dst>`[src]

`impl<T: Clone + Add<T, Output = T>, Src, Dst> Add<TypedScale<T, Src, Dst>> for TypedScale<T, Src, Dst>`[src]

`type Output = TypedScale<T, Src, Dst>`

The resulting type after applying the + operator.

`fn add(self, other: TypedScale<T, Src, Dst>) -> TypedScale<T, Src, Dst>`[src]

`impl<T: Clone + Sub<T, Output = T>, Src, Dst> Sub<TypedScale<T, Src, Dst>> for TypedScale<T, Src, Dst>`[src]

`type Output = TypedScale<T, Src, Dst>`

The resulting type after applying the - operator.