Enum ParamKind 

pub enum ParamKind {
    Modal,
    Structural,
}

What a parameter is for (ADR-0180 rule 2): whether its value carries an integer meaning, which decides two things and nothing else — whether the engine quantizes it before the scene sees it, and which of the generated reference’s two groups it prints under.

Orthogonal to [hold]: a hold reaches any bindable parameter whatever its kind, and a kind quantizes whether or not the binding is held.

Variants

Modal

Continuous — every value in the range means something, and the scene reads the fraction. The default, and what every parameter was before kinds existed.

Structural

Integer meaning: a mode number, a rule index, a count, a family. The engine rounds the post-smoothing value once, CPU-side, before set_param, so the scene is never handed 6.4 petals.

Implementations

impl ParamKind

pub fn as_str(self) -> &'static str

The name the generated reference and the exported schema print. Two readers, one spelling.

pub fn quantize(self, value: f32) -> f32

value as the scene should receive it: rounded for a Structural parameter, untouched for a Modal one.

The last step before set_param, after the hold has chosen which frame’s value stands and the smoother has eased toward it — which is why a structural parameter that is also smoothed steps through the intervening integers rather than landing fractionally. An author who wants a clean jump leaves it out of [smoothing].

A non-finite value is passed through rather than rounded: f32::round leaves NaN alone anyway, and the scenes already guard their own inputs.

Trait Implementations

impl Clone for ParamKind

fn clone(&self) -> ParamKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamKind

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

Formats the value using the given formatter.

impl Default for ParamKind

fn default() -> ParamKind

Returns the “default value” for a type.

impl PartialEq for ParamKind

fn eq(&self, other: &ParamKind) -> 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 Copy for ParamKind

impl Eq for ParamKind

impl StructuralPartialEq for ParamKind