PDG/TOPs

Functions
HAPI_DECL	HAPI_GetPDGGraphContexts (const HAPI_Session *session, HAPI_StringHandle *context_names_array, HAPI_PDG_GraphContextId *context_id_array, int start, int length)
	Return an array of PDG graph context names and ids, the first count names will be returned. These ids can be used with HAPI_GetPDGEvents and HAPI_GetPDGState. The values of the names can be retrieved with HAPI_GetString. More...
HAPI_DECL	HAPI_GetPDGGraphContextsCount (const HAPI_Session *session, int *num_contexts)
	Return the total number of PDG graph contexts found. More...
HAPI_DECL	HAPI_GetPDGGraphContextId (const HAPI_Session *session, HAPI_NodeId top_node_id, HAPI_PDG_GraphContextId *context_id)
	Get the PDG graph context for the specified TOP node. More...
HAPI_DECL	HAPI_CookPDG (const HAPI_Session *session, HAPI_NodeId cook_node_id, int generate_only, int blocking)
	Starts a PDG cooking operation. This can be asynchronous. Progress can be checked with HAPI_GetPDGState() and HAPI_GetPDGState(). Events generated during this cook can be collected with HAPI_GetPDGEvents(). Any uncollected events will be discarded at the start of the cook. More...
HAPI_DECL	HAPI_CookPDGAllOutputs (const HAPI_Session *session, HAPI_NodeId cook_node_id, int generate_only, int blocking)
	Starts a PDG cooking operation. This can be asynchronous. Progress can be checked with HAPI_GetPDGState() and HAPI_GetPDGState(). Events generated during this cook can be collected with HAPI_GetPDGEvents(). Any uncollected events will be discarded at the start of the cook. More...
HAPI_DECL	HAPI_GetPDGEvents (const HAPI_Session *session, HAPI_PDG_GraphContextId graph_context_id, HAPI_PDG_EventInfo *event_array, int length, int *event_count, int *remaining_events)
	Returns PDG events that have been collected. Calling this function will remove those events from the queue. Events collection is restarted by calls to HAPI_CookPDG(). More...
HAPI_DECL	HAPI_GetPDGState (const HAPI_Session *session, HAPI_PDG_GraphContextId graph_context_id, int *pdg_state)
	Gets the state of a PDG graph. More...
	HAPI_CreateWorkitem (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId *workitem_id, const char *name, int index)
	Creates a new pending workitem for the given node. The workitem will not be submitted to the graph until it is committed with HAPI_CommitWorkitems(). The node is expected to be a generator type. More...
	HAPI_GetWorkitemInfo (const HAPI_Session *session, HAPI_PDG_GraphContextId graph_context_id, HAPI_PDG_WorkItemId workitem_id, HAPI_PDG_WorkItemInfo *workitem_info)
	Retrieves the info of a given workitem by id. More...
	HAPI_SetWorkitemIntData (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, const char *data_name, const int *values_array, int length)
	Adds integer data to a pending PDG workitem data member for the given node. More...
	HAPI_SetWorkitemFloatData (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, const char *data_name, const float *values_array, int length)
	Adds float data to a pending PDG workitem data member for the given node. More...
	HAPI_SetWorkitemStringData (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, const char *data_name, int data_index, const char *value)
	Adds integer data to a pending PDG workitem data member for the given node. More...
	HAPI_CommitWorkitems (const HAPI_Session *session, HAPI_NodeId node_id)
	Commits any pending workitems. More...
	HAPI_GetNumWorkitems (const HAPI_Session *session, HAPI_NodeId node_id, int *num)
	Gets the number of workitems that are available on the given node. Should be used with HAPI_GetWorkitems. More...
	HAPI_GetWorkitems (const HAPI_Session *session, HAPI_NodeId node_id, int *workitem_ids_array, int length)
	Gets the list of work item ids for the given node. More...
	HAPI_GetWorkitemDataLength (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, const char *data_name, int *length)
	Gets the length of the workitem data member. It is the length of the array of data. More...
	HAPI_GetWorkitemIntData (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, const char *data_name, int *data_array, int length)
	Gets int data from a work item member. More...
	HAPI_GetWorkitemFloatData (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, const char *data_name, float *data_array, int length)
	Gets float data from a work item member. More...
	HAPI_GetWorkitemStringData (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, const char *data_name, HAPI_StringHandle *data_array, int length)
	Gets string ids from a work item member. More...
	HAPI_GetWorkitemResultInfo (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId workitem_id, HAPI_PDG_WorkItemOutputFile *resultinfo_array, int resultinfo_count)
	Gets the info for workitem results. The number of workitem results is found on the HAPI_PDG_WorkItemInfo returned by HAPI_GetWorkitemInfo() More...
HAPI_DECL	HAPI_CreateWorkItem (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId *work_item_id, const char *name, int index)
	Creates a new pending work item for the given node. The work item will not be submitted to the graph until it is committed with HAPI_CommitWorkItems(). The node is expected to be a generator type. More...
HAPI_DECL	HAPI_GetWorkItemInfo (const HAPI_Session *session, HAPI_PDG_GraphContextId graph_context_id, HAPI_PDG_WorkItemId work_item_id, HAPI_PDG_WorkItemInfo *work_item_info)
	Retrieves the info of a given work item by id. More...
HAPI_DECL	HAPI_SetWorkItemIntAttribute (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, const char *attribute_name, const int *values_array, int length)
	Adds integer data to a pending PDG work item attribute for the given node. More...
HAPI_DECL	HAPI_SetWorkItemFloatAttribute (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, const char *attribute_name, const float *values_array, int length)
	Adds float data to a pending PDG work item attribute for the given node. More...
HAPI_DECL	HAPI_SetWorkItemStringAttribute (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, const char *attribute_name, int data_index, const char *value)
	Adds integer data to a pending PDG work item attribute for the given node. More...
HAPI_DECL	HAPI_CommitWorkItems (const HAPI_Session *session, HAPI_NodeId node_id)
	Commits any pending work items. More...
HAPI_DECL	HAPI_GetNumWorkItems (const HAPI_Session *session, HAPI_NodeId node_id, int *num)
	Gets the number of work items that are available on the given node. Should be used with HAPI_GetWorkItems. More...
HAPI_DECL	HAPI_GetWorkItems (const HAPI_Session *session, HAPI_NodeId node_id, int *work_item_ids_array, int length)
	Gets the list of work item ids for the given node. More...
HAPI_DECL	HAPI_GetWorkItemAttributeSize (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, const char *attribute_name, int *length)
	Gets the size of the work item attribute. It is the length of the array of data. More...
HAPI_DECL	HAPI_GetWorkItemIntAttribute (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, const char *attribute_name, int *data_array, int length)
	Gets int data from a work item attribute. More...
HAPI_DECL	HAPI_GetWorkItemFloatAttribute (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, const char *attribute_name, float *data_array, int length)
	Gets float data from a work item attribute. More...
HAPI_DECL	HAPI_GetWorkItemStringAttribute (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, const char *attribute_name, HAPI_StringHandle *data_array, int length)
	Gets string ids from a work item attribute. More...
HAPI_DECL	HAPI_GetWorkItemOutputFiles (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_PDG_WorkItemId work_item_id, HAPI_PDG_WorkItemOutputFile *resultinfo_array, int resultinfo_count)
	Gets the info for work item output files. The number of work item results is found on the HAPI_PDG_WorkItemInfo returned by HAPI_GetWorkItemInfo() More...
HAPI_DECL	HAPI_DirtyPDGNode (const HAPI_Session *session, HAPI_NodeId node_id, HAPI_Bool clean_results)
	Dirties the given node. Cancels the cook if necessary and then deletes all workitems on the node. More...
HAPI_DECL	HAPI_PausePDGCook (const HAPI_Session *session, HAPI_PDG_GraphContextId graph_context_id)
	Pause the PDG cooking operation. More...
HAPI_DECL	HAPI_CancelPDGCook (const HAPI_Session *session, HAPI_PDG_GraphContextId graph_context_id)
	Cancel the PDG cooking operation. More...

Detailed Description

Functions for working with PDG/TOPs

Function Documentation

HAPI_DECL HAPI_CancelPDGCook	(	const HAPI_Session *	session,
		HAPI_PDG_GraphContextId	graph_context_id
	)

Cancel the PDG cooking operation.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	graph_context_id	The id of the graph context

HAPI_CommitWorkitems	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id
	)

Commits any pending workitems.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id for which the pending workitems have been created but not yet injected.

HAPI_DECL HAPI_CommitWorkItems	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id
	)

Commits any pending work items.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id for which the pending work items have been created but not yet injected.

HAPI_DECL HAPI_CookPDG	(	const HAPI_Session *	session,
		HAPI_NodeId	cook_node_id,
		int	generate_only,
		int	blocking
	)

Starts a PDG cooking operation. This can be asynchronous. Progress can be checked with HAPI_GetPDGState() and HAPI_GetPDGState(). Events generated during this cook can be collected with HAPI_GetPDGEvents(). Any uncollected events will be discarded at the start of the cook.

If there are any $HIPFILE file dependencies on nodes involved in the cook a hip file will be automatically saved to $HOUDINI_TEMP_DIR directory so that it can be copied to the working directory by the scheduler. This means $HIP will be equal to $HOUDINI_TEMP_DIR.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	cook_node_id	The node id of a TOP node for the cook operation.
[in]	generate_only	1 means only static graph generation will done. 0 means a full graph cook. Generation is always blocking.
[in]	blocking	0 means return immediately and cooking will be done asynchronously. 1 means return when cooking completes.

HAPI_DECL HAPI_CookPDGAllOutputs	(	const HAPI_Session *	session,
		HAPI_NodeId	cook_node_id,
		int	generate_only,
		int	blocking
	)

Starts a PDG cooking operation. This can be asynchronous. Progress can be checked with HAPI_GetPDGState() and HAPI_GetPDGState(). Events generated during this cook can be collected with HAPI_GetPDGEvents(). Any uncollected events will be discarded at the start of the cook.

If there are any $HIPFILE file dependencies on nodes involved in the cook a hip file will be automatically saved to $HOUDINI_TEMP_DIR directory so that it can be copied to the working directory by the scheduler. This means $HIP will be equal to $HOUDINI_TEMP_DIR.

If cook_node_id is a network / subnet, then if it has output nodes it cooks all of its output nodes and not just output 0. If it does not have output nodes it cooks the node with the output flag.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	cook_node_id	The node id of a TOP node for the cook operation.
[in]	generate_only	1 means only static graph generation will done. 0 means a full graph cook. Generation is always blocking.
[in]	blocking	0 means return immediately and cooking will be done asynchronously. 1 means return when cooking completes.

HAPI_CreateWorkitem	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId *	workitem_id,
		const char *	name,
		int	index
	)

Creates a new pending workitem for the given node. The workitem will not be submitted to the graph until it is committed with HAPI_CommitWorkitems(). The node is expected to be a generator type.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[out]	workitem_id	The id of the pending workitem.
[in]	name	The null-terminated name of the workitem. The name will be automatically suffixed to make it unique.
[in]	index	The index of the workitem. The semantics of the index are user defined.

HAPI_DECL HAPI_CreateWorkItem	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId *	work_item_id,
		const char *	name,
		int	index
	)

Creates a new pending work item for the given node. The work item will not be submitted to the graph until it is committed with HAPI_CommitWorkItems(). The node is expected to be a generator type.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[out]	work_item_id	The id of the pending workitem.
[in]	name	The null-terminated name of the work item. The name will be automatically suffixed to make it unique.
[in]	index	The index of the work item. The semantics of the index are user defined.

HAPI_DECL HAPI_DirtyPDGNode	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_Bool	clean_results
	)

Dirties the given node. Cancels the cook if necessary and then deletes all workitems on the node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	clean_results	Remove the results generated by the node.

HAPI_GetNumWorkitems	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		int *	num
	)

Gets the number of workitems that are available on the given node. Should be used with HAPI_GetWorkitems.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[out]	num	The number of workitems.

HAPI_DECL HAPI_GetNumWorkItems	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		int *	num
	)

Gets the number of work items that are available on the given node. Should be used with HAPI_GetWorkItems.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[out]	num	The number of work items.

HAPI_DECL HAPI_GetPDGEvents	(	const HAPI_Session *	session,
		HAPI_PDG_GraphContextId	graph_context_id,
		HAPI_PDG_EventInfo *	event_array,
		int	length,
		int *	event_count,
		int *	remaining_events
	)

Returns PDG events that have been collected. Calling this function will remove those events from the queue. Events collection is restarted by calls to HAPI_CookPDG().

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	graph_context_id	The id of the graph context
[out]	event_array	buffer of HAPI_PDG_EventInfo of size at least length.
[in]	length	The size of the buffer passed in.
[out]	event_count	Number of events removed from queue and copied to buffer.
[out]	remaining_events	Number of queued events remaining after this operation.

HAPI_DECL HAPI_GetPDGGraphContextId	(	const HAPI_Session *	session,
		HAPI_NodeId	top_node_id,
		HAPI_PDG_GraphContextId *	context_id
	)

Get the PDG graph context for the specified TOP node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	top_node_id	The id of the TOP node to query its graph context.
[out]	context_id	The PDG graph context id.

HAPI_DECL HAPI_GetPDGGraphContexts	(	const HAPI_Session *	session,
		HAPI_StringHandle *	context_names_array,
		HAPI_PDG_GraphContextId *	context_id_array,
		int	start,
		int	length
	)

Return an array of PDG graph context names and ids, the first count names will be returned. These ids can be used with HAPI_GetPDGEvents and HAPI_GetPDGState. The values of the names can be retrieved with HAPI_GetString.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]	context_names_array	Array of context names stored as HAPI_StringHandle at least the size of length. These can be used with HAPI_GetString() and are valid until the next call to this function.
[out]	context_id_array	Array of graph context ids at least the size of length.
[in]	start	First index of range. Must be at least 0 and at most context_count - 1 where context_count is the count returned by HAPI_GetPDGGraphContextsCount()
[in]	length	Given num_contexts returned by HAPI_GetPDGGraphContextsCount(), length should be at least 0 and at most num_contexts - start.

HAPI_DECL HAPI_GetPDGGraphContextsCount	(	const HAPI_Session *	session,
		int *	num_contexts
	)

Return the total number of PDG graph contexts found.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]	num_contexts	Total PDG graph contexts count.

HAPI_DECL HAPI_GetPDGState	(	const HAPI_Session *	session,
		HAPI_PDG_GraphContextId	graph_context_id,
		int *	pdg_state
	)

Gets the state of a PDG graph.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	graph_context_id	The graph context id
[out]	pdg_state	One of HAPI_PDG_State.

HAPI_DECL HAPI_GetWorkItemAttributeSize	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		const char *	attribute_name,
		int *	length
	)

Gets the size of the work item attribute. It is the length of the array of data.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the work item
[in]	attribute_name	null-terminated name of the work item attribute
[out]	length	The length of the data member array

HAPI_GetWorkitemDataLength	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		const char *	data_name,
		int *	length
	)

Gets the length of the workitem data member. It is the length of the array of data.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the workitem
[in]	data_name	null-terminated name of the data member
[out]	length	The length of the data member array

HAPI_DECL HAPI_GetWorkItemFloatAttribute	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		const char *	attribute_name,
		float *	data_array,
		int	length
	)

Gets float data from a work item attribute.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the work_item
[in]	attribute_name	null-terminated name of the work item attribute
[out]	data_array	buffer of at least size length to copy the data into. The required length should be determined by ::HAPI_GetWorkItemDataLength().
[in]	length	The length of the data_array

HAPI_GetWorkitemFloatData	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		const char *	data_name,
		float *	data_array,
		int	length
	)

Gets float data from a work item member.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the workitem
[in]	data_name	null-terminated name of the data member
[out]	data_array	buffer of at least size length to copy the data into. The required length should be determined by HAPI_GetWorkitemDataLength().
[in]	length	The length of the data_array

HAPI_GetWorkitemInfo	(	const HAPI_Session *	session,
		HAPI_PDG_GraphContextId	graph_context_id,
		HAPI_PDG_WorkItemId	workitem_id,
		HAPI_PDG_WorkItemInfo *	workitem_info
	)

Retrieves the info of a given workitem by id.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	graph_context_id	The graph context that the workitem is in.
[in]	workitem_id	The id of the workitem.
[out]	workitem_info	The returned HAPI_PDG_WorkItemInfo for the workitem. Note that the enclosed string handle is only valid until the next call to this function.

HAPI_DECL HAPI_GetWorkItemInfo	(	const HAPI_Session *	session,
		HAPI_PDG_GraphContextId	graph_context_id,
		HAPI_PDG_WorkItemId	work_item_id,
		HAPI_PDG_WorkItemInfo *	work_item_info
	)

Retrieves the info of a given work item by id.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	graph_context_id	The graph context that the work item is in.
[in]	work_item_id	The id of the work item.
[out]	work_item_info	The returned HAPI_PDG_WorkItemInfo for the work item. Note that the enclosed string handle is only valid until the next call to this function.

HAPI_DECL HAPI_GetWorkItemIntAttribute	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		const char *	attribute_name,
		int *	data_array,
		int	length
	)

Gets int data from a work item attribute.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the work_item
[in]	attribute_name	null-terminated name of the work item attribute
[out]	data_array	buffer of at least size length to copy the data into. The required length should be determined by ::HAPI_GetWorkItemDataLength().
[in]	length	The length of data_array

HAPI_GetWorkitemIntData	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		const char *	data_name,
		int *	data_array,
		int	length
	)

Gets int data from a work item member.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the workitem
[in]	data_name	null-terminated name of the data member
[out]	data_array	buffer of at least size length to copy the data into. The required length should be determined by HAPI_GetWorkitemDataLength().
[in]	length	The length of data_array

HAPI_DECL HAPI_GetWorkItemOutputFiles	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		HAPI_PDG_WorkItemOutputFile *	resultinfo_array,
		int	resultinfo_count
	)

Gets the info for work item output files. The number of work item results is found on the HAPI_PDG_WorkItemInfo returned by HAPI_GetWorkItemInfo()

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the work item
[out]	resultinfo_array	Buffer to fill with info structs. String handles are valid until the next call of this function.
[in]	resultinfo_count	The length of resultinfo_array

HAPI_GetWorkitemResultInfo	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		HAPI_PDG_WorkItemOutputFile *	resultinfo_array,
		int	resultinfo_count
	)

Gets the info for workitem results. The number of workitem results is found on the HAPI_PDG_WorkItemInfo returned by HAPI_GetWorkitemInfo()

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the workitem
[out]	resultinfo_array	Buffer to fill with info structs. String handles are valid until the next call of this function.
[in]	resultinfo_count	The length of resultinfo_array

HAPI_GetWorkitems	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		int *	workitem_ids_array,
		int	length
	)

Gets the list of work item ids for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[out]	workitem_ids_array	buffer for resulting array of HAPI_PDG_WorkItemId
[in]	length	The length of the workitem_ids buffer

HAPI_DECL HAPI_GetWorkItems	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		int *	work_item_ids_array,
		int	length
	)

Gets the list of work item ids for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[out]	work_item_ids_array	buffer for resulting array of HAPI_PDG_WorkItemId
[in]	length	The length of the work_item_ids buffer

HAPI_DECL HAPI_GetWorkItemStringAttribute	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		const char *	attribute_name,
		HAPI_StringHandle *	data_array,
		int	length
	)

Gets string ids from a work item attribute.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the work item
[in]	attribute_name	null-terminated name of the work item attribute
[out]	data_array	buffer of at least size length to copy the data into. The required length should be determined by ::HAPI_GetWorkItemDataLength(). The data is an array of HAPI_StringHandle which can be used with HAPI_GetString(). The string handles are valid until the next call to this function.
[in]	length	The length of data_array

HAPI_GetWorkitemStringData	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		const char *	data_name,
		HAPI_StringHandle *	data_array,
		int	length
	)

Gets string ids from a work item member.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the workitem
[in]	data_name	null-terminated name of the data member
[out]	data_array	buffer of at least size length to copy the data into. The required length should be determined by HAPI_GetWorkitemDataLength(). The data is an array of HAPI_StringHandle which can be used with HAPI_GetString(). The string handles are valid until the next call to this function.
[in]	length	The length of data_array

HAPI_DECL HAPI_PausePDGCook	(	const HAPI_Session *	session,
		HAPI_PDG_GraphContextId	graph_context_id
	)

Pause the PDG cooking operation.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	graph_context_id	The id of the graph context

HAPI_DECL HAPI_SetWorkItemFloatAttribute	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		const char *	attribute_name,
		const float *	values_array,
		int	length
	)

Adds float data to a pending PDG work item attribute for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the pending work item returned by HAPI_CreateWorkItem()
[in]	attribute_name	null-terminated name of the work item attribute
[in]	values_array	array of float values
[in]	length	number of values to copy from values_array to the parameter

HAPI_SetWorkitemFloatData	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		const char *	data_name,
		const float *	values_array,
		int	length
	)

Adds float data to a pending PDG workitem data member for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the pending workitem returned by HAPI_CreateWorkitem()
[in]	data_name	null-terminated name of the workitem data member
[in]	values_array	array of float values
[in]	length	number of values to copy from values_array to the parameter

HAPI_DECL HAPI_SetWorkItemIntAttribute	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		const char *	attribute_name,
		const int *	values_array,
		int	length
	)

Adds integer data to a pending PDG work item attribute for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the pending work item returned by HAPI_CreateWorkItem()
[in]	attribute_name	null-terminated name of the work item attribute
[in]	values_array	array of integer values
[in]	length	number of values to copy from values_array to the parameter

HAPI_SetWorkitemIntData	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		const char *	data_name,
		const int *	values_array,
		int	length
	)

Adds integer data to a pending PDG workitem data member for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the pending workitem returned by HAPI_CreateWorkitem()
[in]	data_name	null-terminated name of the data member
[in]	values_array	array of integer values
[in]	length	number of values to copy from values_array to the parameter

HAPI_DECL HAPI_SetWorkItemStringAttribute	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	work_item_id,
		const char *	attribute_name,
		int	data_index,
		const char *	value
	)

Adds integer data to a pending PDG work item attribute for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	work_item_id	The id of the created work item returned by HAPI_CreateWorkItem()
[in]	attribute_name	null-terminated name of the work item attribute
[in]	data_index	index of the string data member
[in]	value	null-terminated string to copy to the work item data member

HAPI_SetWorkitemStringData	(	const HAPI_Session *	session,
		HAPI_NodeId	node_id,
		HAPI_PDG_WorkItemId	workitem_id,
		const char *	data_name,
		int	data_index,
		const char *	value
	)

Adds integer data to a pending PDG workitem data member for the given node.

Parameters

[in]	session	The session of Houdini you are interacting with. See Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	node_id	The node id.
[in]	workitem_id	The id of the created workitem returned by HAPI_CreateWorkitem()
[in]	data_name	null-terminated name of the data member
[in]	data_index	index of the string data member
[in]	value	null-terminated string to copy to the workitem data member