Struct hapi_rs::node::HoudiniNode

pub struct HoudiniNode {
    pub handle: NodeHandle,
    pub session: Session,
    pub info: Arc<NodeInfo>,
}

Represents a Houdini node

Fields

handle: NodeHandle

session: Session

info: Arc<NodeInfo>

Implementations

impl<'session> HoudiniNode

pub fn delete(self) -> Result<()>

pub fn is_valid(&self) -> Result<bool>

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

pub fn path_relative(&self, to: Option<NodeHandle>) -> Result<String>

pub fn cook(&self, options: Option<&CookOptions>) -> Result<()>

pub fn cook_blocking(&self, options: Option<&CookOptions>) -> Result<CookResult>

In sync mode (single threaded), the error will be available in Err(..) while in threaded cooking mode the status will be in CookResult

pub fn cook_count(
    &self,
    node_types: NodeType,
    node_flags: NodeFlags,
    recurse: bool
) -> Result<i32>

pub fn create<H: Into<NodeHandle>>(
    name: &str,
    label: Option<&str>,
    parent: Option<H>,
    session: Session,
    cook: bool
) -> Result<HoudiniNode>

pub fn get_manager_node(
    session: &Session,
    node_type: NodeType
) -> Result<HoudiniNode>

pub fn get_object_info(&self) -> Result<ObjectInfo<'_>>

pub fn get_objects_info(&self) -> Result<Vec<ObjectInfo<'_>>>

pub fn get_children(
    &self,
    types: NodeType,
    flags: NodeFlags,
    recursive: bool
) -> Result<Vec<NodeHandle>>

pub fn find_sibling(
    &self,
    name: impl AsRef<str>,
    node_type: NodeType
) -> Result<Option<HoudiniNode>>

Search child node by name

pub fn parent_node(&self) -> Option<NodeHandle>

pub fn parameter(&self, name: &str) -> Result<Parameter>

pub fn parameters(&self) -> Result<Vec<Parameter>>

pub fn asset_info(&'session self) -> Result<AssetInfo<'session>>

pub fn check_for_specific_error(
    &self,
    error_bits: ErrorCode
) -> Result<ErrorCode>

pub fn cook_result(&self, verbosity: StatusVerbosity) -> Result<String>

pub fn reset_simulation(&self) -> Result<()>

pub fn input_node(&self, idx: i32) -> Result<Option<HoudiniNode>>

pub fn rename(&self, new_name: impl AsRef<str>) -> Result<()>

pub fn save_to_file(&self, file: impl AsRef<Path>) -> Result<()>

pub fn load_from_file(
    session: &Session,
    parent: Option<NodeHandle>,
    label: &str,
    cook: bool,
    file: impl AsRef<Path>
) -> Result<HoudiniNode>

pub fn get_preset(&self, name: &str, preset_type: PresetType) -> Result<Vec<i8>>

pub fn set_preset(
    &self,
    name: &str,
    preset_type: PresetType,
    data: &[i8]
) -> Result<()>

pub fn geometry(&self) -> Result<Option<Geometry>>

pub fn number_of_geo_outputs(&self) -> Result<i32>

pub fn geometry_outputs(&self) -> Result<Vec<Geometry>>

pub fn get_transform(
    &self,
    rst_order: Option<RSTOrder>,
    relative_to: Option<NodeHandle>
) -> Result<Transform>

pub fn set_transform(&self, transform: &TransformEuler) -> Result<()>

pub fn set_transform_anim_curve(
    &self,
    component: TransformComponent,
    keys: &[KeyFrame]
) -> Result<()>

pub fn connect_input<H: Into<NodeHandle>>(
    &self,
    input_num: i32,
    source: H,
    output_num: i32
) -> Result<()>

pub fn output_connected_nodes(
    &self,
    output_index: i32,
    search_subnets: bool
) -> Result<Vec<NodeHandle>>

pub fn disconnect_input(&self, input_index: i32) -> Result<()>

pub fn disconnect_outputs(&self, output_index: i32) -> Result<()>

pub fn set_display_flag(&self, on: bool) -> Result<()>

Trait Implementations

impl Clone for HoudiniNode

fn clone(&self) -> HoudiniNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HoudiniNode

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

Formats the value using the given formatter.

impl From<&'_ HoudiniNode> for NodeHandle

fn from(n: &HoudiniNode) -> Self

Performs the conversion.

impl From<HoudiniNode> for NodeHandle

fn from(n: HoudiniNode) -> Self

Performs the conversion.