In threaded mode, this is an async call!
This method will load the HIP file into the scene. This means
that any registered hou.hipFile
event callbacks will be triggered
with the hou.hipFileEventType.BeforeMerge
and
hou.hipFileEventType.AfterMerge
events.
This method loads a HIP file, completely overwriting everything that already exists in the scene. Therefore, any HAPI ids (node ids, part ids, etc.) that were obtained before calling this method will be invalidated.
Usage ¶
loadHIPFile(session
: hapi.Session, file_name
: str
, cook_on_load
: bool
) → bool
Loads a .hip file into the main Houdini scene.
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.
file_name
Absolute path to the .hip file to load.
cook_on_load
Set to True if you wish the nodes to cook as soon as they are created. Otherwise, you will have to call hapi.cookNode explicitly for each after you call this function.