Type Alias Scale
pub type Scale = Scale<f32, UnknownUnit, UnknownUnit>;geometry only.Expand description
Alias for euclid::default::Scale<f32>
Aliased Type§
struct Scale(pub f32);Fields§
§0: f32Implementations
§impl<T, Src, Dst> Scale<T, Src, Dst>
impl<T, Src, Dst> Scale<T, Src, Dst>
pub const fn new(x: T) -> Scale<T, Src, Dst>
pub fn transform_point(
self,
point: Point2D<T, Src>,
) -> Point2D<<T as Mul>::Output, Dst>
pub fn transform_point( self, point: Point2D<T, Src>, ) -> Point2D<<T as Mul>::Output, Dst>
Returns the given point transformed by this scale.
§Example
use euclid::{Scale, point2};
enum Mm {};
enum Cm {};
let to_mm: Scale<i32, Cm, Mm> = Scale::new(10);
assert_eq!(to_mm.transform_point(point2(42, -42)), point2(420, -420));pub fn transform_point3d(
self,
point: Point3D<T, Src>,
) -> Point3D<<T as Mul>::Output, Dst>
pub fn transform_point3d( self, point: Point3D<T, Src>, ) -> Point3D<<T as Mul>::Output, Dst>
Returns the given point transformed by this scale.
pub fn transform_vector(
self,
vec: Vector2D<T, Src>,
) -> Vector2D<<T as Mul>::Output, Dst>
pub fn transform_vector( self, vec: Vector2D<T, Src>, ) -> Vector2D<<T as Mul>::Output, Dst>
Returns the given vector transformed by this scale.
§Example
use euclid::{Scale, vec2};
enum Mm {};
enum Cm {};
let to_mm: Scale<i32, Cm, Mm> = Scale::new(10);
assert_eq!(to_mm.transform_vector(vec2(42, -42)), vec2(420, -420));pub fn transform_size(
self,
size: Size2D<T, Src>,
) -> Size2D<<T as Mul>::Output, Dst>
pub fn transform_size( self, size: Size2D<T, Src>, ) -> Size2D<<T as Mul>::Output, Dst>
Returns the given size transformed by this scale.
§Example
use euclid::{Scale, size2};
enum Mm {};
enum Cm {};
let to_mm: Scale<i32, Cm, Mm> = Scale::new(10);
assert_eq!(to_mm.transform_size(size2(42, -42)), size2(420, -420));pub fn transform_rect(
self,
rect: &Rect<T, Src>,
) -> Rect<<T as Mul>::Output, Dst>
pub fn transform_rect( self, rect: &Rect<T, Src>, ) -> Rect<<T as Mul>::Output, Dst>
Returns the given rect transformed by this scale.
§Example
use euclid::{Scale, rect};
enum Mm {};
enum Cm {};
let to_mm: Scale<i32, Cm, Mm> = Scale::new(10);
assert_eq!(to_mm.transform_rect(&rect(1, 2, 42, -42)), rect(10, 20, 420, -420));pub fn transform_box2d(
self,
b: &Box2D<T, Src>,
) -> Box2D<<T as Mul>::Output, Dst>
pub fn transform_box2d( self, b: &Box2D<T, Src>, ) -> Box2D<<T as Mul>::Output, Dst>
Returns the given box transformed by this scale.
pub fn transform_box3d(
self,
b: &Box3D<T, Src>,
) -> Box3D<<T as Mul>::Output, Dst>
pub fn transform_box3d( self, b: &Box3D<T, Src>, ) -> Box3D<<T as Mul>::Output, Dst>
Returns the given box transformed by this scale.
pub fn is_identity(self) -> bool
pub fn is_identity(self) -> bool
Returns true if this scale has no effect.
§Example
use euclid::Scale;
use euclid::num::One;
enum Mm {};
enum Cm {};
let cm_per_mm: Scale<f32, Mm, Cm> = Scale::new(0.1);
let mm_per_mm: Scale<f32, Mm, Mm> = Scale::new(1.0);
assert_eq!(cm_per_mm.is_identity(), false);
assert_eq!(mm_per_mm.is_identity(), true);
assert_eq!(mm_per_mm, Scale::one());pub fn get(self) -> T
pub fn get(self) -> T
Returns the underlying scalar scale factor.
§impl<T, Src, Dst> Scale<T, Src, Dst>where
T: PartialOrd,
impl<T, Src, Dst> Scale<T, Src, Dst>where
T: PartialOrd,
§impl<T, Src, Dst> Scale<T, Src, Dst>where
T: NumCast,
impl<T, Src, Dst> Scale<T, Src, Dst>where
T: NumCast,
pub fn cast<NewT>(self) -> Scale<NewT, Src, Dst>where
NewT: NumCast,
pub fn cast<NewT>(self) -> Scale<NewT, Src, Dst>where
NewT: NumCast,
Cast from one numeric representation to another, preserving the units.
§Panics
If the source value cannot be represented by the target type NewT, then
method panics. Use try_cast if that must be case.
§Example
use euclid::Scale;
enum Mm {};
enum Cm {};
let to_mm: Scale<i32, Cm, Mm> = Scale::new(10);
assert_eq!(to_mm.cast::<f32>(), Scale::new(10.0));That conversion will panic, because i32 not enough to store such big numbers:
use euclid::Scale;
enum Mm {};// millimeter = 10^-2 meters
enum Em {};// exameter = 10^18 meters
// Panics
let to_em: Scale<i32, Mm, Em> = Scale::new(10e20).cast();pub fn try_cast<NewT>(self) -> Option<Scale<NewT, Src, Dst>>where
NewT: NumCast,
pub fn try_cast<NewT>(self) -> Option<Scale<NewT, Src, Dst>>where
NewT: NumCast,
Fallible cast from one numeric representation to another, preserving the units.
If the source value cannot be represented by the target type NewT, then None
is returned.
§Example
use euclid::Scale;
enum Mm {};
enum Cm {};
enum Em {};// Exameter = 10^18 meters
let to_mm: Scale<i32, Cm, Mm> = Scale::new(10);
let to_em: Scale<f32, Mm, Em> = Scale::new(10e20);
assert_eq!(to_mm.try_cast::<f32>(), Some(Scale::new(10.0)));
// Integer to small to store that number
assert_eq!(to_em.try_cast::<i32>(), None);