Enum hapi_rs::parameter::Parameter

pub enum Parameter {
    Float(FloatParameter),
    Int(IntParameter),
    String(StringParameter),
    Button(IntParameter),
    Other(BaseParameter),
}

Enum of different parameter types.

Variants

Float(FloatParameter)

ParmType::Float | ParmType::Color

Int(IntParameter)

ParmType::Int | ParmType::Toggle

String(StringParameter)

ParmType::String | ParmType::Node | ParmType::PathFile | ParmType::PathFileDir | ParmType::PathFileGeo | ParmType::PathFileImage

Button(IntParameter)

ParmType::Int

Other(BaseParameter)

Other ParmType::_

Implementations

impl Parameter

pub fn value_as_debug(&self) -> Result<Box<dyn Debug>>

A convenient method to evaluate a parameter value as string for debugging.

pub fn info(&self) -> &ParmInfo

Information about the parameter

pub fn name(&self) -> Result<String>

Parameter internal name

pub fn label(&self) -> Result<String>

Parameter UI label

pub fn size(&self) -> i32

Number or elements in the parameter

pub fn parent(&self) -> Result<Option<ParmInfo>>

Parameter parent if any (examples are multi-parm or Folder type parameters)

Trait Implementations

impl Debug for Parameter

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

Formats the value using the given formatter.

impl ParmBaseTrait for Parameter

fn name(&self) -> Result<Cow<'_, str>>

fn session(&self) -> &Session

fn node(&self) -> NodeHandle

fn size(&self) -> i32

fn info(&self) -> &ParmInfo

fn update(&mut self) -> Result<()>

Update the internal parameter metadata if Houdini parameter changed, for example children added to a multi-parm or the menu was updated.

fn is_menu(&self) -> bool

If the parameter has choice menu.

fn menu_items(&self) -> Result<Option<Vec<ParmChoiceInfo>>>

If parameter is a menu type, return a vec of menu items

fn multiparm_children(&self) -> Result<Option<Vec<Parameter>>>

If the parameter is a multiparm, return its children parms. NOTE: THis is not a recommended way to traverse parameters in general, this is here for convenience only

fn expression(&self, index: i32) -> Result<Option<String>>

Returns a parameter expression string

fn has_expression(&self, index: i32) -> Result<bool>

Checks if parameter has an expression

fn set_expression(&self, value: &str, index: i32) -> Result<()>

Set parameter expression

fn remove_expression(&self, index: i32) -> Result<()>

Remove parameter expression

fn revert_to_default(&self, index: i32) -> Result<()>

Revert parameter at index to its default value

fn set_anim_curve(&self, index: i32, keys: &[KeyFrame]) -> Result<()>

Set keyframes on the parameter