Struct TopNode

pub struct TopNode {
    pub node: HoudiniNode,
}

A wrapper for HoudiniNode with methods for cooking PDG.

Fields

node: HoudiniNode

Implementations

impl TopNode

pub fn cook_async<F>(&self, all_outputs: bool, func: F) -> Result<()>

where F: FnMut(CookStep) -> Result<ControlFlow<bool>>,

Start cooking a TOP node asynchronously. For each generated event, a user closure will be called with a CookStep argument.

The closure returns Result<ControlFlow<bool>> which is handled like this:

If its an Err(_) - bubble up the error. If it’s [ControlFlow::Break(bool)] then the bool is either to cancel the cooking or just break the loop and return. In case of [ControlFlow::Continue(_)] run until completion.

See the pdg_cook example in the /examples folder.

pub fn cook_pdg_blocking(&self, all_outputs: bool) -> Result<()>

Trigger PDG cooking and wait for completion. If all_outputs is true and this TOP node is of topnet type, cook all network outptus. Results can then be retrieved from workitems with get_all_workitems()

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

Get the graph(context) id of this node in PDG.

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

Cancel cooking.

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

Pause cooking process

pub fn dirty_node(&self, clean_results: bool) -> Result<()>

Dirty the node, forcing the work items to regenerate.

pub fn get_current_state(&self, context_id: Option<i32>) -> Result<PdgState>

Which this node current PdgState

pub fn get_workitem(&self, workitem_id: WorkItemId) -> Result<PDGWorkItem<'_>>

Get the work item by id and graph(context) id.

pub fn get_all_workitems(&self) -> Result<Vec<PDGWorkItem<'_>>>

pub fn create_workitem( &self, name: &str, index: i32, context_id: Option<i32>, ) -> Result<PDGWorkItem<'_>>

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

Trait Implementations

impl Clone for TopNode

fn clone(&self) -> TopNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopNode

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

Formats the value using the given formatter.

impl From<TopNode> for NodeHandle

fn from(value: TopNode) -> Self

Converts to this type from the input type.