#[repr(C)]pub struct Scale<T, Src, Dst>(pub T, _);
Expand description
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 Scale
. They
may be types without values, such as empty enums. For example:
use euclid::Scale;
use euclid::Length;
enum Mm {};
enum Inch {};
let mm_per_inch: Scale<f32, Inch, Mm> = Scale::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;
Tuple Fields§
§0: T
Implementations§
source§impl<T, Src, Dst> Scale<T, Src, Dst>
impl<T, Src, Dst> Scale<T, Src, Dst>
pub const fn new(x: T) -> Self
sourcepub fn transform_point(self, point: Point2D<T, Src>) -> Point2D<T::Output, Dst>
pub fn transform_point(self, point: Point2D<T, Src>) -> Point2D<T::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));
sourcepub fn transform_point3d(
self,
point: Point3D<T, Src>,
) -> Point3D<T::Output, Dst>
pub fn transform_point3d( self, point: Point3D<T, Src>, ) -> Point3D<T::Output, Dst>
Returns the given point transformed by this scale.
sourcepub fn transform_vector(self, vec: Vector2D<T, Src>) -> Vector2D<T::Output, Dst>
pub fn transform_vector(self, vec: Vector2D<T, Src>) -> Vector2D<T::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));
sourcepub fn transform_size(self, size: Size2D<T, Src>) -> Size2D<T::Output, Dst>
pub fn transform_size(self, size: Size2D<T, Src>) -> Size2D<T::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));
sourcepub fn transform_rect(self, rect: &Rect<T, Src>) -> Rect<T::Output, Dst>
pub fn transform_rect(self, rect: &Rect<T, Src>) -> Rect<T::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));
sourcepub fn transform_box2d(self, b: &Box2D<T, Src>) -> Box2D<T::Output, Dst>
pub fn transform_box2d(self, b: &Box2D<T, Src>) -> Box2D<T::Output, Dst>
Returns the given box transformed by this scale.
sourcepub fn transform_box3d(self, b: &Box3D<T, Src>) -> Box3D<T::Output, Dst>
pub fn transform_box3d(self, b: &Box3D<T, Src>) -> Box3D<T::Output, Dst>
Returns the given box transformed by this scale.
sourcepub 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());
source§impl<T: PartialOrd, Src, Dst> Scale<T, Src, Dst>
impl<T: PartialOrd, Src, Dst> Scale<T, Src, Dst>
source§impl<T: NumCast, Src, Dst> Scale<T, Src, Dst>
impl<T: NumCast, Src, Dst> Scale<T, Src, Dst>
sourcepub fn cast<NewT: NumCast>(self) -> Scale<NewT, Src, Dst>
pub fn cast<NewT: NumCast>(self) -> Scale<NewT, Src, Dst>
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();
sourcepub fn try_cast<NewT: NumCast>(self) -> Option<Scale<NewT, Src, Dst>>
pub fn try_cast<NewT: NumCast>(self) -> Option<Scale<NewT, Src, Dst>>
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);
Trait Implementations§
source§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box2D<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box3D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box3D<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point2D<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Point3D<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Rect<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Rect<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for SideOffsets2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for SideOffsets2D<T, U>
source§fn div_assign(&mut self, other: Scale<T, U, U>)
fn div_assign(&mut self, other: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size2D<T, U>
source§fn div_assign(&mut self, other: Scale<T, U, U>)
fn div_assign(&mut self, other: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size3D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Size3D<T, U>
source§fn div_assign(&mut self, other: Scale<T, U, U>)
fn div_assign(&mut self, other: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Vector2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Vector2D<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Vector3D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Vector3D<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box2D<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box3D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box3D<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point2D<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Point3D<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Rect<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Rect<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for SideOffsets2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for SideOffsets2D<T, U>
source§fn mul_assign(&mut self, other: Scale<T, U, U>)
fn mul_assign(&mut self, other: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size2D<T, U>
source§fn mul_assign(&mut self, other: Scale<T, U, U>)
fn mul_assign(&mut self, other: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size3D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Size3D<T, U>
source§fn mul_assign(&mut self, other: Scale<T, U, U>)
fn mul_assign(&mut self, other: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Vector2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Vector2D<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Vector3D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Vector3D<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Ord, Src, Dst> Ord for Scale<T, Src, Dst>
impl<T: Ord, Src, Dst> Ord for Scale<T, Src, Dst>
source§impl<T: PartialOrd, Src, Dst> PartialOrd for Scale<T, Src, Dst>
impl<T: PartialOrd, Src, Dst> PartialOrd for Scale<T, Src, Dst>
impl<T: Copy, Src, Dst> Copy for Scale<T, Src, Dst>
impl<T: Eq, Src, Dst> Eq for Scale<T, Src, Dst>
Auto Trait Implementations§
impl<T, Src, Dst> Freeze for Scale<T, Src, Dst>where
T: Freeze,
impl<T, Src, Dst> RefUnwindSafe for Scale<T, Src, Dst>
impl<T, Src, Dst> Send for Scale<T, Src, Dst>
impl<T, Src, Dst> Sync for Scale<T, Src, Dst>
impl<T, Src, Dst> Unpin for Scale<T, Src, Dst>
impl<T, Src, Dst> UnwindSafe for Scale<T, Src, Dst>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)