Methods ¶
isCurrent()
→ bool
Return True if the take is the current take and False otherwise.
name()
Return the name of the take.
setName(name)
Rename the take.
addChildTake(name)
→ hou.Take
Create a new take with the given name and add it as a child to this take.
If no name is specified then the take will have a generated name based on the default take name.
addNodeDisplayFlag(node)
Include the given node’s display flag in this take making it editable in this take.
This method does nothing if the node’s display flag is already included in the take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
removeNodeDisplayFlag(node)
Exclude the given node’s display flag from this take making it uneditable in this take.
This method does nothing if the node’s display flag is not included in the take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
addNodeBypassFlag(node)
Include the given node’s bypass flag in this take making it editable in this take.
This method does nothing if the node’s bypass flag is already included in the take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
removeNodeBypassFlag(node)
Exclude the given node’s bypass flag from this take making it uneditable in this take.
This method does nothing if the node’s bypass flag is not included in the take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
addNodeRenderFlag(node)
Include the given node’s render flag in this take making it editable in this take.
This method does nothing if the node’s render flag is already included in the take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
removeNodeRenderFlag(node)
Exclude the given node’s render flag from this take making it uneditable in this take.
This method does nothing if the node’s render flag is not included in the take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
parmTuples()
→ tuple of hou.ParmTuple
Return a tuple of node parameters that are included and editable in this take.
hasParmTuple(parm_tuple)
→ bool
Return True if the given parameter is included in this take and False otherwise.
Raise hou.OperationFailed if the parm_tuple argument is None.
addParmTuple(parm_tuple)
Include the given parameter in this take making it editable in this take.
This method does nothing if the parameter is already included in this take.
Raise hou.OperationFailed if the parm_tuple argument is None.
Raise hou.OperationFailed if this take is not the current take.
removeParmTuple(parm_tuple)
Exclude the given parameter from this take making it uneditable in this take.
This method does nothing if the parameter is not included in this take.
Raise hou.OperationFailed if the parm_tuple argument is None.
Raise hou.OperationFailed if this take is not the current take.
addParmTuplesFromTake(take, overwrite_existing=True)
Include all the given take’s parameters in this take making the parameters editable in this take.
If overwrite_existing is True then parameters that are already included
in this take will have their values overwritten by the same parameters
found in the other take. Otherwise, parameters already included in this
take will not be affected by the same parameters found in the other take.
Raise hou.OperationFailed if the take argument is None.
Raise hou.OperationFailed if this take is not the current take.
addParmTuplesFromNode(node)
Include all the given node’s parameters in this take making them editable in this take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
removeParmTuplesFromNode(node)
Exclude all the given node’s parameters from this take making them uneditable in this take.
Raise hou.OperationFailed if the node argument is None.
Raise hou.OperationFailed if this take is not the current take.
children()
→ tuple of hou.Take
Return a tuple of the child takes.
destroy(recurse=False)
Deletes the take.
If recurse is True then all child and descendent takes will be deleted as well.
parent()
→ hou.Take
Return the parent take or None if this take is the main (master) take.
path()
→ str
Return the path of the take. The take path consists of the name of this take as well as the names of its ancestor takes.
insertTakeAbove(name)
→ hou.Take
Create a new take with the given name and add it as a child of this take’s parent. This take is reparented with the newly created take as the parent.
Raise hou.OperationFailed if this take is the main (master) take.
moveUnderTake(take)
Reparent this take to the specified take.
Raise hou.OperationFailed if the take argument is None.
Raise hou.OperationFailed if this take is the main (master) take.
saveToFile(filename, recurse=False)
Save this take to a file on disk.
If recurse is True then any child and descendent takes will also be saved
to the file.
Note that the saved file can only be loaded within the same .hip file session. If Houdini is restarted or if the .hip file is closed and re-opened then the saved file will fail to load.
Raise hou.OperationFailed if the filename argument does not point
to a valid location on disk.
loadChildTakeFromFile(filename)
→ tuple of hou.Take
Load a take from a file that is saved to disk and make it a child of this take. This will also load any child and descendent takes that are saved in the file.
Return a tuple of takes that have been loaded from the file. The first take in the tuple is the direct child take of this take. All takes that follow are the children and descendants of the first take.
Loaded takes will be renamed if there already exists takes with the same names.
Note that you can only load files that have been saved from the same .hip file session. If Houdini is restarted or if the .hip file is closed and re-opened after the save then the file will fail to load.
Raise hou.OperationFailed if the filename argument does not point
to a valid file on disk.
| See also |