Enum UnitValue 

pub enum UnitValue {
    Unitless(Numeric),
    Percent(Numeric),
}

A scalar value in a normalized unit domain.

UnitValue accepts both unitless numbers and percents. It is useful for properties whose authoring domain is “part of a whole”, such as path drawing progress where 0.5 and 50% describe the same position.

Variants

Unitless(Numeric)

Unitless normalized value, where 0.5 means halfway through the domain.

Percent(Numeric)

Percent value, where 50% means halfway through the domain.

Implementations

impl UnitValue

pub fn to_unit_float(&self) -> f64

Returns the wrapped value as a normalized unitless float.

UnitValue::Unitless(0.5) returns 0.5, and UnitValue::Percent(50) returns 0.5.

pub fn to_clamped_unit_float(&self) -> f64

Returns to_unit_float() clamped into the closed unit interval.

Trait Implementations

impl Clone for UnitValue

fn clone(&self) -> UnitValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CoercionRules for UnitValue

fn try_coerce(value: PaxValue) -> Result<UnitValue, String>

Attempts to coerce value into Self.

fn allows_singleton_stack() -> bool

Opts appearance layers into scalar-to-singleton stack conversion. Ordinary vector values remain list-only.

fn is_identity_roundtrip() -> bool

Whether cloning Self preserves the semantics of converting that clone through ToPaxValue and back with try_coerce.

impl Copy for UnitValue

impl Debug for UnitValue

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

Formats the value using the given formatter.

impl Default for UnitValue

fn default() -> UnitValue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnitValue

fn deserialize<__D>( __deserializer: __D, ) -> Result<UnitValue, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UnitValue

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

Formats the value using the given formatter.

impl HelperFunctions for UnitValue

fn register_all_functions()

Registers all helper functions for this type.

impl Interpolatable for UnitValue

fn interpolate(&self, other: &UnitValue, t: f64) -> UnitValue

Interpolates this value toward other at time t on the unit interval.

impl PartialEq for UnitValue

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for UnitValue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UnitValue

impl ToPaxValue for UnitValue

fn to_pax_value(self) -> PaxValue

Converts this value into a PaxValue.

fn nested_properties(&self) -> Vec<UntypedProperty>

Live properties read when snapshotting a compound value for PAXEL. Adapters observe these as well as the containing property.

fn to_pax_value_in_graph(self) -> PaxValue

where Self: Sized,

Converts against owner-thread graph views, including nested generated property fields. Requires an entered property graph for shared fields. Ordinary Self::to_pax_value reads published value snapshots.