Trait hapi_rs::parameter::ParmBaseTrait
source · pub trait ParmBaseTrait {
Show 13 methods
fn name(&self) -> Result<String> { ... }
fn session(&self) -> &Session { ... }
fn node(&self) -> NodeHandle { ... }
fn size(&self) -> i32 { ... }
fn info(&self) -> &ParmInfo { ... }
fn is_menu(&self) -> bool { ... }
fn menu_items(&self) -> Result<Option<Vec<ParmChoiceInfo>>> { ... }
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: i32) -> Result<()> { ... }
fn set_anim_curve(&self, index: i32, keys: &[KeyFrame]) -> Result<()> { ... }
}Expand description
Common trait for parameters
Provided Methods§
fn name(&self) -> Result<String>
fn session(&self) -> &Session
fn node(&self) -> NodeHandle
fn size(&self) -> i32
fn info(&self) -> &ParmInfo
If the parameter has choice menu.
If parameter is a menu type, return a vec of menu items
sourcefn expression(&self, index: i32) -> Result<Option<String>>
fn expression(&self, index: i32) -> Result<Option<String>>
Returns a parameter expression string
sourcefn has_expression(&self, index: i32) -> Result<bool>
fn has_expression(&self, index: i32) -> Result<bool>
Checks if parameter has an expression
sourcefn remove_expression(&self, index: i32) -> Result<()>
fn remove_expression(&self, index: i32) -> Result<()>
Remove parameter expression
sourcefn revert_to_default(&self, index: i32) -> Result<()>
fn revert_to_default(&self, index: i32) -> Result<()>
Revert parameter at index to its default value