Struct zng_unit::Factor

#[repr(transparent)]
pub struct Factor(pub f32);

Normalized multiplication factor.

Values of this type are normalized to generally be in between 0.0 and 1.0 to indicate a fraction of a unit. However, values are not clamped to this range, Factor(2.0) is a valid value and so are negative values.

Equality

Equality is determined to within 0.00001 epsilon.

Tuple Fields

0: f32

Implementations

impl Factor

pub fn clamp_range(self) -> Self

Clamp factor to [0.0..=1.0] range.

pub fn max(self, other: impl Into<Factor>) -> Factor

Returns the maximum of two factors.

pub fn min(self, other: impl Into<Factor>) -> Factor

Returns the minimum of two factors.

pub fn clamp(self, min: impl Into<Factor>, max: impl Into<Factor>) -> Factor

Returns self if min <= self <= max, returns min if self < min or returns max if self > max.

pub fn abs(self) -> Factor

Computes the absolute value of self.

pub fn flip(self) -> Factor

Flip factor, around 0.5,

Returns 1.0 - self.

pub fn pct(self) -> FactorPercent

Factor as percentage.

Trait Implementations

impl Add for Factor

type Output = Factor

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Factor

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Factor

fn clone(&self) -> Factor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Factor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Factor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Factor

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

Formats the value using the given formatter.

impl Div<Factor> for Dip

type Output = Dip

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> Dip

Performs the / operation.

impl Div<Factor> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> Duration

Performs the / operation.

impl Div<Factor> for FactorPercent

type Output = FactorPercent

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> Self

Performs the / operation.

impl Div<Factor> for DipPoint

type Output = Point2D<Dip, Dip>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> DipPoint

Performs the / operation.

impl Div<Factor> for PxPoint

type Output = Point2D<Px, Px>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> PxPoint

Performs the / operation.

impl Div<Factor> for Point2D<f32, Px>

type Output = Point2D<f32, Px>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> Point2D<f32, Px>

Performs the / operation.

impl Div<Factor> for Px

type Output = Px

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> Px

Performs the / operation.

impl Div<Factor> for DipRect

type Output = Rect<Dip, Dip>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> DipRect

Performs the / operation.

impl Div<Factor> for PxRect

type Output = Rect<Px, Px>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> PxRect

Performs the / operation.

impl Div<Factor> for DipSize

type Output = Size2D<Dip, Dip>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> DipSize

Performs the / operation.

impl Div<Factor> for PxSize

type Output = Size2D<Px, Px>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> PxSize

Performs the / operation.

impl Div<Factor> for Size2D<f32, Px>

type Output = Size2D<f32, Px>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> Size2D<f32, Px>

Performs the / operation.

impl Div<Factor> for DipVector

type Output = Vector2D<Dip, Dip>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> DipVector

Performs the / operation.

impl Div<Factor> for PxVector

type Output = Vector2D<Px, Px>

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> PxVector

Performs the / operation.

impl Div<Factor> for f32

type Output = f32

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> f32

Performs the / operation.

impl Div<Factor> for f64

type Output = f64

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> f64

Performs the / operation.

impl Div<Factor> for i128

type Output = i128

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> i128

Performs the / operation.

impl Div<Factor> for i16

type Output = i16

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> i16

Performs the / operation.

impl Div<Factor> for i32

type Output = i32

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> i32

Performs the / operation.

impl Div<Factor> for i64

type Output = i64

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> i64

Performs the / operation.

impl Div<Factor> for i8

type Output = i8

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> i8

Performs the / operation.

impl Div<Factor> for isize

type Output = isize

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> isize

Performs the / operation.

impl Div<Factor> for u128

type Output = u128

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> u128

Performs the / operation.

impl Div<Factor> for u16

type Output = u16

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> u16

Performs the / operation.

impl Div<Factor> for u32

type Output = u32

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> u32

Performs the / operation.

impl Div<Factor> for u64

type Output = u64

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> u64

Performs the / operation.

impl Div<Factor> for u8

type Output = u8

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> u8

Performs the / operation.

impl Div<Factor> for usize

type Output = usize

The resulting type after applying the / operator.

fn div(self, rhs: Factor) -> usize

Performs the / operation.

impl Div for Factor

type Output = Factor

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign<Factor> for Dip

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for Duration

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for FactorPercent

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for DipPoint

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for PxPoint

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for Point2D<f32, Px>

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for Px

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for DipRect

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for PxRect

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for DipSize

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for PxSize

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for Size2D<f32, Px>

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for DipVector

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for PxVector

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for f32

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for f64

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for i128

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for i16

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for i32

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for i64

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for i8

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for isize

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for u128

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for u16

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for u32

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for u64

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for u8

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign<Factor> for usize

fn div_assign(&mut self, rhs: Factor)

Performs the /= operation.

impl DivAssign for Factor

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<Factor> for FactorPercent

fn from(value: Factor) -> Self

Converts to this type from the input type.

impl From<Factor> for RgbaComponent

Color channel value is in the [0..=1] range.

fn from(f: Factor) -> Self

Converts to this type from the input type.

impl From<FactorPercent> for Factor

fn from(value: FactorPercent) -> Self

Converts to this type from the input type.

impl From<bool> for Factor

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Factor

fn from(value: f32) -> Self

Converts to this type from the input type.

impl Hash for Factor

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<Factor> for Dip

type Output = Dip

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> Dip

Performs the * operation.

impl Mul<Factor> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> Duration

Performs the * operation.

impl Mul<Factor> for FactorPercent

type Output = FactorPercent

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> Self

Performs the * operation.

impl Mul<Factor> for DipPoint

type Output = Point2D<Dip, Dip>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> DipPoint

Performs the * operation.

impl Mul<Factor> for PxPoint

type Output = Point2D<Px, Px>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> PxPoint

Performs the * operation.

impl Mul<Factor> for Point2D<f32, Px>

type Output = Point2D<f32, Px>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> Point2D<f32, Px>

Performs the * operation.

impl Mul<Factor> for Px

type Output = Px

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> Px

Performs the * operation.

impl Mul<Factor> for DipRect

type Output = Rect<Dip, Dip>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> DipRect

Performs the * operation.

impl Mul<Factor> for PxRect

type Output = Rect<Px, Px>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> PxRect

Performs the * operation.

impl Mul<Factor> for DipSize

type Output = Size2D<Dip, Dip>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> DipSize

Performs the * operation.

impl Mul<Factor> for PxSize

type Output = Size2D<Px, Px>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> PxSize

Performs the * operation.

impl Mul<Factor> for Size2D<f32, Px>

type Output = Size2D<f32, Px>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> Size2D<f32, Px>

Performs the * operation.

impl Mul<Factor> for DipVector

type Output = Vector2D<Dip, Dip>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> DipVector

Performs the * operation.

impl Mul<Factor> for PxVector

type Output = Vector2D<Px, Px>

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> PxVector

Performs the * operation.

impl Mul<Factor> for f32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> f32

Performs the * operation.

impl Mul<Factor> for f64

type Output = f64

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> f64

Performs the * operation.

impl Mul<Factor> for i128

type Output = i128

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> i128

Performs the * operation.

impl Mul<Factor> for i16

type Output = i16

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> i16

Performs the * operation.

impl Mul<Factor> for i32

type Output = i32

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> i32

Performs the * operation.

impl Mul<Factor> for i64

type Output = i64

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> i64

Performs the * operation.

impl Mul<Factor> for i8

type Output = i8

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> i8

Performs the * operation.

impl Mul<Factor> for isize

type Output = isize

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> isize

Performs the * operation.

impl Mul<Factor> for u128

type Output = u128

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> u128

Performs the * operation.

impl Mul<Factor> for u16

type Output = u16

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> u16

Performs the * operation.

impl Mul<Factor> for u32

type Output = u32

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> u32

Performs the * operation.

impl Mul<Factor> for u64

type Output = u64

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> u64

Performs the * operation.

impl Mul<Factor> for u8

type Output = u8

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> u8

Performs the * operation.

impl Mul<Factor> for usize

type Output = usize

The resulting type after applying the * operator.

fn mul(self, rhs: Factor) -> usize

Performs the * operation.

impl Mul for Factor

type Output = Factor

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<Factor> for Dip

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for Duration

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for FactorPercent

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for DipPoint

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for PxPoint

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for Point2D<f32, Px>

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for Px

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for DipRect

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for PxRect

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for DipSize

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for PxSize

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for Size2D<f32, Px>

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for DipVector

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for PxVector

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for f32

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for f64

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for i128

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for i16

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for i32

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for i64

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for i8

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for isize

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for u128

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for u16

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for u32

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for u64

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for u8

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign<Factor> for usize

fn mul_assign(&mut self, rhs: Factor)

Performs the *= operation.

impl MulAssign for Factor

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Factor

type Output = Factor

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Factor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Factor

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Factor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Factor

type Output = Factor

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Factor

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Zeroable for Factor

fn zeroed() -> Self

Calls zeroed.

impl Copy for Factor

impl Pod for Factor