Struct Parameter 

pub struct Parameter {
    pub name: &'static str,
    pub data_type: DataType,
}

Defines an input parameter to change the value of a ModelComponent.

This offers a public mechanism to change the internal values of functions at runtime. The parameters are defined by a name and a DataType.

The main use for the parameters is to change the parameters of models at runtime. The main usecase for this is when building a UI for model building.

These are returned from the parameters method.

Fields

name: &'static str

Display name of the parameter.

data_type: DataType

Datatype of the parameter.

Implementations

impl Parameter

pub fn new(name: &'static str, data_type: DataType) -> Self

Create a new parameter from a name and a DataType

pub fn set_value_from_param<T: Float>( parameter_name: &str, data: &Data<T>, target_name: &str, target: &mut T, ) -> bool

Helper method to assign the value from a matching parameter to a floating point variable. It will assign the value of the parameter to the target input if the parameter_name matches the target_name and the data provided matches the target type, which in this instance is a Float value.

Arguments

• parameter_name - The name of the provided parameter
• data - The data contained.
• target_name - The name of the current target.
• target - Where the data should be assigned if matching the name and the type.

pub fn get_string_from_enum_param<T>( parameter_name: &str, data: &Data<T>, target_name: &str, ) -> Option<String>

Helper method to get the value from a matching parameter for Enum data.

This method will return the string value contained in the parameter if the provided data is of enum type and the name matches the target name. Otherwise it will return None.

Arguments

• parameter_name - The name of the provided parameter
• data - The data contained in the parameter.
• target_name - The name of the current target.

pub fn set_clamped_value_from_param<T: Float>( parameter_name: &str, data: &Data<T>, target_name: &str, target: &mut T, min: T, max: T, ) -> bool

Helper method to assign the value from a matching parameter to a field. It will assign the value of the parameter to the target input if the parameter_name matches the target_name and the data provided matches the target type, which in this instance is a Float value.

The difference between this and Parameter::set_value_from_param is that this method will ensure the value, if assigned, is kept within the bounds.

Arguments

• parameter_name - The name of the provided parameter
• data - The data contained.
• target_name - The name of the current target.
• target - Where the data should be assigned if matching the name and the type.
• min - Minimum allowed value. If the provided value is smaller than this, the min value will be assigned.
• max - Maximum allowed value. If the provided value is larger than this, the max value will be assigned.

pub fn set_vec3_from_param<T: Float>( parameter_name: &str, data: &Data<T>, target_name: &str, target: &mut Vec3<T>, ) -> bool

Helper method to get the value from a matching parameter for Vec3 data.

This method will return the value contained in the parameter if the provided data is of Vec3 type and the name matches the target name.

Arguments

• parameter_name - The name of the provided parameter
• data - The data contained in the parameter.
• target_name - The name of the current target.

pub fn set_bool_from_param<T: Float>( parameter_name: &str, data: &Data<T>, param: &str, target: &mut bool, ) -> bool

Helper method to get the value from a matching parameter for bool data.

This method will return the value contained in the parameter if the provided data is of Vec3 type and the name matches the target name.

Arguments

• parameter_name - The name of the provided parameter
• data - The data contained in the parameter.
• target_name - The name of the current target.

pub fn set_text_from_param<T: Float>( parameter_name: &str, data: &Data<T>, param: &str, target: &mut String, ) -> bool

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.