Struct jumpy::prelude::kira::tween::Parameter

pub struct Parameter<T = f64>
where
    T: Tweenable,
{
    state: State<T>,
    raw_value: T,
    stagnant: bool,
}

Manages and updates a value that can be smoothly transitioned and linked to modulators.

You’ll only need to use this if you’re creating your own Sound, Effect, or Modulator implementations. If you want to adjust a parameter of something from gameplay code (such as the volume of a sound or the speed of a clock), use the functions on that object’s handle.

Fields

state: State<T>

raw_value: T

stagnant: bool

Implementations

impl<T> Parameter<T>

where T: Tweenable,

pub fn new(initial_value: Value<T>, default_raw_value: T) -> Parameter<T>

Creates a new Parameter with an initial Value.

The default_raw_value is used if the parameter is linked to a modulator that doesn’t exist.

pub fn value(&self) -> T

Returns the current actual value of the parameter.

pub fn set(&mut self, target: Value<T>, tween: Tween)

Starts a transition from the current value to the target value.

pub fn read_command( &mut self, command_reader: &mut CommandReader<ValueChangeCommand<T>>, )

where T: Send,

Reads a ValueChangeCommand from a CommandReader, and if there is one, sets the parameter with the value and tween.

pub fn update( &mut self, dt: f64, clock_info_provider: &ClockInfoProvider<'_>, modulator_value_provider: &ModulatorValueProvider<'_>, ) -> bool

Updates any in-progress transitions and keeps the value up-to-date with any linked modulators.

Returns true if a transition just finished after this update.

Trait Implementations

impl<T> Clone for Parameter<T>

where T: Clone + Tweenable,

fn clone(&self) -> Parameter<T>

Returns a copy of the value.

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

Performs copy-assignment from source.