Struct StringParameter

pub struct StringParameter(/* private fields */);

Represents string parameters of many different types.

Implementations

impl StringParameter

pub fn set(&self, index: i32, value: impl AsRef<str>) -> Result<()>

Set parameter value at index.

pub fn get(&self, index: i32) -> Result<String>

Get parameter value at index.

pub fn set_array<T: AsRef<str>>(&self, val: impl AsRef<[T]>) -> Result<()>

Set all parameter tuple values

pub fn get_array(&self) -> Result<Vec<String>>

Get all parameter tuple values

pub fn save_parm_file( &self, destination_dir: &Path, filename: &str, ) -> Result<()>

Save/Download a file referenced in this parameter to a given file. filename must include the desired extension to work properly.

pub fn set_value_as_node(&self, value: impl AsRef<NodeHandle>) -> Result<()>

If parameter is a ParmType::Node type, set it to reference another node

pub fn get_value_as_node(&self) -> Result<Option<NodeHandle>>

Return a handle to a node if the parameter is of type ParmType::Node

Trait Implementations

impl Debug for StringParameter

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

Formats the value using the given formatter.

impl ParmBaseTrait for StringParameter

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 insert_multiparm_instance(&self, position: i32) -> Result<()>

fn remove_multiparm_instance(&self, position: i32) -> Result<()>

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: Option<i32>) -> Result<()>

Revert parameter at index to its default value. If index is None - reset all instances.

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

Set keyframes on the parameter

fn has_tag(&self, tag: &str) -> Result<bool>

fn get_tag_name(&self, tag_index: i32) -> Result<String>

Get parameter tag name by index. The number of tags is stored in self.info().tag_count()

fn get_tag_value(&self, tag_name: &str) -> Result<String>