Struct NodeHandle

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

A lightweight handle to a node. Can not be created manually, use HoudiniNode instead. Some APIs return a list of such handles for efficiency, for example HoudiniNode::find_children_by_type. Once you found the node you’re looking for, upgrade it to a “full” node type.

Implementations

impl NodeHandle

pub fn info(&self, session: &Session) -> Result<NodeInfo>

Retrieve info about the node this handle belongs to

pub fn is_valid(&self, session: &Session) -> Result<bool>

Check if the handle is valid (node wasn’t deleted)

pub fn to_node(&self, session: &Session) -> Result<HoudiniNode>

Upgrade the handle to HoudiniNode, which has more capabilities.

pub fn as_geometry_node(&self, session: &Session) -> Result<Option<Geometry>>

Upgrade the handle to Geometry node.

pub fn as_top_node(&self, session: &Session) -> Result<Option<TopNode>>

If this is a handle to a TOP node, returns a TopNode type.

Trait Implementations

impl AsRef<NodeHandle> for HoudiniNode

fn as_ref(&self) -> &NodeHandle

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NodeHandle> for NodeHandle

fn as_ref(&self) -> &NodeHandle

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NodeHandle

fn clone(&self) -> NodeHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeHandle

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

Formats the value using the given formatter.

impl Default for NodeHandle

fn default() -> Self

Returns the “default value” for a type.

impl From<&HoudiniNode> for NodeHandle

fn from(n: &HoudiniNode) -> Self

Converts to this type from the input type.

impl From<HoudiniNode> for NodeHandle

fn from(n: HoudiniNode) -> Self

Converts to this type from the input type.

impl From<NodeHandle> for HAPI_NodeId

fn from(h: NodeHandle) -> Self

Converts to this type from the input type.

impl From<TopNode> for NodeHandle

fn from(value: TopNode) -> Self

Converts to this type from the input type.

impl PartialEq for NodeHandle

fn eq(&self, other: &NodeHandle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NodeHandle

impl Eq for NodeHandle

impl StructuralPartialEq for NodeHandle