Houdini 20.5 hapi

hapi.cookPDG function

Starts a PDG cooking operation. This can be asynchronous.

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.

Usage

cookPDG(session: hapi.Session, cook_node_id: int, generate_only: int, blocking: int) → bool

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.

session

The session of Houdini you are interacting with. See hapi.Session for more on sessions. Pass None to just use the default in-process session.

cook_node_id

The node id of a TOP node for the cook operation.

generate_only

1 means only static graph generation will done. 0 means a full graph cook. Generation is always blocking.

blocking

0 means return immediately and cooking will be done asynchronously. 1 means return when cooking completes.

hapi