Trait hapi_rs::parameter::ParmBaseTrait

source ·

pub trait ParmBaseTrait {
Show 18 methods    // Provided methods
    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<()> { ... }
    fn is_menu(&self) -> bool { ... }
    fn menu_items(&self) -> Result<Option<Vec<ParmChoiceInfo>>> { ... }
    fn multiparm_children(&self) -> Result<Option<Vec<Parameter>>> { ... }
    fn expression(&self, index: i32) -> Result<Option<String>> { ... }
    fn has_expression(&self, index: i32) -> Result<bool> { ... }
    fn set_expression(&self, value: &str, index: i32) -> Result<()> { ... }
    fn remove_expression(&self, index: i32) -> Result<()> { ... }
    fn revert_to_default(&self, index: Option<i32>) -> Result<()> { ... }
    fn set_anim_curve(&self, index: i32, keys: &[KeyFrame]) -> Result<()> { ... }
    fn has_tag(&self, tag: &str) -> Result<bool> { ... }
    fn get_tag_name(&self, tag_index: i32) -> Result<String> { ... }
    fn get_tag_value(&self, tag_name: &str) -> Result<String> { ... }
}

Expand description

Common trait for parameters

Provided Methods§

source

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.

source

fn is_menu(&self) -> bool

If the parameter has choice menu.

source

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

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

source

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

source