hou.FolderParmTemplate

Describes a folder in a parameter dialog.

Unlike all other hou.ParmTemplate subclasses, a folder does not correspond to an individual hou.ParmTuple. Instead, the set of adjacent folders form a folder set, and there is one parameter for this set that controls which folder is currently visible. These folder sets correspond to hou.FolderSetParmTemplate objects.

Folder parm template objects are useful when manipulating the parameter interface of a node or a digital asset definition. Unlike folder set parm templates, they contain the parm templates inside the folder. They also let you add, remove, or hide an individual folder or move it from set one to another using hou.ParmTemplateGroup objects. Doing these individual folder-level operations is not possible with folder set parm templates.

Note that folder parm templates are also used to represent multiparm blocks, much like the Type Properties dialog does. The folder parm template’s hou.folderType determines whether it is a folder or a multiparm block. Unlike folder parm templates, which do not correspond directly to parameter instances, a multiparm parm template does correspond to an integer parameter that controls the number of instances of the multiparm.

Methods

Inherited from hou.ParmTemplate: asCode, clone, dataType, disableWhen, help, hide, hideLabel, isHidden, isLabelHidden, joinWithNext, joinsWithNext, label, look, name, namingScheme, numComponents, scriptCallback, scriptCallbackLanguage, setDisableWhen, setHelp, setJoinWithNext, setLabel, setLook, setName, setNamingScheme, setNumComponents, setScriptCallback, setScriptCallbackLanguage, setTags, tags, type

__init__	Create a new folder parm template.
addParmTemplate	Append a parm template to the end of the list of parm templates inside the folder.
defaultValue	Return the integer default value.
endsTabGroup	Return whether this folder will be the last in the folder set, even if the next parameter is also a folder. In that case, the next parameter will begin a new folder set.
folderType	Return the type of folder. Note that the folder may actually be a multiparm block.
isActualFolder	Return whether or not this parm template corresponds to an actual folder, as opposed to a multiparm or import block.
parmTemplates	Return a tuple of copies of the parm templates stored inside this folder.
setDefaultValue	Set the default value to an integer.
setFolderType	Set the type of folder to a hou.folderType enum value.
setParmTemplates	Replace the parm templates inside this folder with a new sequence of parm templates.

__init__(name, label, parm_templates=(), folder_type=hou.folderType.Tabs, is_hidden=False, ends_tab_group=False, tags={})

Create a new folder parm template.

`name`	The internal name of the parm template. Normally, parm template names correspond directly to parm tuples on nodes. However, because folder sets, not folders, correspond directly to parm tuples, the name used for the folder set parm tuple is the name of the first folder parm template in the set of adjacent folder parm templates.
`label`	The name of the folder that is displayed in the parameter dialog.
`parm_templates`	A sequence of hou.ParmTemplate subclass objects for the parameters inside the folder. Folders may be nested in other folders by putting FolderParmTemplates in this sequence.
`folder_type`	A hou.folderType enumerated value controlling whether the parameter is a folder or a multiparm block. This value controls the look of the folder/multiparm instance.
`is_hidden`	Whether or not this folder is hidden.
`ends_tab_group`	If `True`, this folder will be the last in the folder set, even if the next parameter is also a folder. In that case, the next parameter will begin a new folder set.
`tags`	A dictionary of extra information attached to the parm template.

parmTemplates(self) → tuple of hou.ParmTemplate

Return a tuple of copies of the parm templates stored inside this folder.

Because copies are returned, you cannot change the contents of the parm templates inside this folder by modifying the parm templates returned. Instead, use methods in hou.ParmTemplateGroup to modify parm templates in this folder.

addParmTemplate(self, parm_template)

Append a parm template to the end of the list of parm templates inside the folder.

Note that hou.ParmTemplateGroup provides a number of methods to insert parm templates inside folders, including hou.ParmTemplateGroup.appendToFolder.

setParmTemplates(self, parm_templates)

Replace the parm templates inside this folder with a new sequence of parm templates.

folderType(self) → hou.folderType enum value

Return the type of folder. Note that the folder may actually be a multiparm block.

setFolderType(self, folder_type)

Set the type of folder to a hou.folderType enum value.

isActualFolder(self) → bool

Return whether or not this parm template corresponds to an actual folder, as opposed to a multiparm or import block.

This method can be implemented as follows:

def isActualFolder(self):
    return self.folderType() in (
        hou.folderType.Tabs, hou.folderType.RadioButtons)

defaultValue(self) → int

Return the integer default value.

The default value is only used for folders that are multiparm blocks, and controls the default number of multiparm instances in newly created nodes.

setDefaultValue(self, default_value)

Set the default value to an integer.

The default value is only used for folders that are multiparm blocks. See the defaultValue method for more information.

endsTabGroup(self) → bool

Return whether this folder will be the last in the folder set, even if the next parameter is also a folder. In that case, the next parameter will begin a new folder set.

This parameter only has meaning if the parm template is for an actual folder and not for a multiparm block.

Superclasses

hou.ParmTemplate class

hou.FolderParmTemplate class

Methods

Superclasses