Struct StatesMap

pub struct StatesMap { /* private fields */ }

A simple implementation of States that is backed by a HashMap.

This is useful for testing or other places when you want to pass a States to a component outside of a Conformal wrapper.

Implementations

impl StatesMap

pub fn new_override_defaults<'a, S: AsRef<str> + 'a>( infos: impl IntoIterator<Item = InfoRef<'a, S>> + 'a, overrides: &HashMap<&str, InternalValue>, ) -> Self

Create a new StatesMap from a list of Infos and overrides.

This creates a StatesMap with all parameters set to default values, except for the ones that are overridden by the overrides.

Note that if you want to pass this into a synth, you should use Self::new_override_synth_defaults instead.

overrides work exactly as in override_defaults.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];

let overrides = vec![("numeric", InternalValue::Numeric(0.5))].into_iter().collect();

let states = StatesMap::new_override_defaults(infos.iter().cloned(), &overrides);
assert_eq!(states.get_numeric("numeric"), Some(0.5));

pub fn new_defaults<'a, S: AsRef<str> + 'a>( infos: impl IntoIterator<Item = InfoRef<'a, S>> + 'a, ) -> Self

Create a new StatesMap from a list of Infos.

Each parameter in Infos will be set to its default value.

Note that if you want to pass this into a synth, you should use Self::new_synth_defaults instead.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];

let states = StatesMap::new_defaults(infos.iter().cloned());
assert_eq!(states.get_numeric("numeric"), Some(0.0));

pub fn new_override_synth_defaults<'a, 'b: 'a>( infos: impl IntoIterator<Item = InfoRef<'a, &'b str>> + 'a, overrides: &HashMap<&str, InternalValue>, ) -> Self

Create a new StatesMap to pass to a synth from a list of Infos and overrides.

This is similar to Self::new_override_defaults, but it also includes the controller parameters that are common to all synths. (crate::synth::CONTROLLER_PARAMETERS).

Thus, this is more appropriate to use if you plan to pass the parameters to a synth.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];

let overrides = vec![
  // You can override declared parameters
  ("numeric", InternalValue::Numeric(0.5)),
  // Or you can override control parameters
  (MOD_WHEEL_PARAMETER, InternalValue::Numeric(0.2)),
].into_iter().collect();
let states = StatesMap::new_override_synth_defaults(infos.iter().cloned(), &overrides);

// Overridden parameters get the values you passed in
assert_eq!(states.get_numeric("numeric"), Some(0.5));
assert_eq!(states.get_numeric(MOD_WHEEL_PARAMETER), Some(0.2));

// Other parameters get their default values
assert_eq!(states.get_numeric(PITCH_BEND_PARAMETER), Some(0.0));

pub fn new_synth_defaults<'a, 'b: 'a>( infos: impl IntoIterator<Item = InfoRef<'a, &'b str>> + 'a, ) -> Self

Create a new StatesMap to pass to a synth from a list of Infos.

Each parameter in Infos will be set to its default value.

This is similar to Self::new_defaults, but it also includes the controller parameters that are common to all synths. (crate::synth::CONTROLLER_PARAMETERS).

Thus, this is more appropriate to use if you plan to pass the parameters to a synth.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];

let states = StatesMap::new_synth_defaults(infos.iter().cloned());
assert_eq!(states.get_numeric("numeric"), Some(0.0));

// Controller parameters will also be included
assert_eq!(states.get_numeric(MOD_WHEEL_PARAMETER), Some(0.0));

Trait Implementations

impl Clone for StatesMap

fn clone(&self) -> StatesMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatesMap

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

Formats the value using the given formatter.

impl Default for StatesMap

fn default() -> StatesMap

Returns the “default value” for a type.

impl<S: AsRef<str>> From<HashMap<S, InternalValue>> for StatesMap

fn from(map: HashMap<S, InternalValue>) -> Self

Converts to this type from the input type.

impl States for StatesMap

fn get_by_hash(&self, id_hash: IdHash) -> Option<InternalValue>

Get the current value of a parameter by it’s hashed unique ID.

fn get(&self, unique_id: &str) -> Option<InternalValue>

Get the current value of a parameter by it’s unique ID.

fn numeric_by_hash(&self, id_hash: IdHash) -> Option<f32>

Get the current numeric value of a parameter by it’s hashed unique ID.

fn get_numeric(&self, unique_id: &str) -> Option<f32>

Get the current numeric value of a parameter by it’s unique ID.

fn enum_by_hash(&self, id_hash: IdHash) -> Option<u32>

Get the current enum value of a parameter by it’s hashed unique ID.

fn get_enum(&self, unique_id: &str) -> Option<u32>

Get the current enum value of a parameter by it’s unique ID.

fn switch_by_hash(&self, id_hash: IdHash) -> Option<bool>

Get the current switch value of a parameter by it’s hashed unique ID.

fn get_switch(&self, unique_id: &str) -> Option<bool>

Get the current switch value of a parameter by it’s unique ID.