Contains parameter information like name, label, type, and size.
Methods ¶
id
: int
Property
The parent id points to the id of the parent parm of this parm. The parent parm is something like a folder.
parentId
: int
Property
Parameter id of the parent of this parameter.
childIndex
: int
Property
Child index within its immediate parent parameter.
scriptType
: hapi.prmScriptType
Property
The Houdini script-type of the parm
typeInfoSH
: int
Property
Some parameter types require additional type information.
-
File path parameters will indicate what file extensions they expect in a space-separated list of wild-cards. This is set in the Operator Type Properties using the File Pattern parameter property. For example, for filtering by PNG and JPG only: “.png .jpg”
permissions
: hapi.permissions
Property
For the majority of parameter types permission will not be applicable. For file path parameters these permissions will indicate how the asset plans to use the file: whether it will only read it, only write to it, or both. This is set in the Operator Type Properties using the Browse Mode parameter property.
tagCount
: int
Property
Number of tags on this parameter.
size
: int
Property
Tuple size. For scalar parameters this value is 1, but for vector parameters this value can be greater. For example, a 3 vector would have a size of 3. For folders and folder lists, this value is the number of children they own.
choiceListType
: hapi.choiceListType
Property
Any hapi.parmType can be a choice list. If this is set to hapi.choiceListType._None than this parameter is NOT a choice list. Otherwise, the parameter is a choice list of the indicated type. See hapi.getParmChoiceLists.
choiceCount
: int
Property
Any hapi.parmType can be a choice list. If the parameter is a choice list, this tells you how many choices it currently has. Note that some menu parameters can have a dynamic number of choices so it is important that this count is re-checked after every cook. See hapi.getParmChoiceLists.
nameSH
: int
Property
Note that folders are not real parameters in Houdini so they do not have names. The folder names given here are generated from the name of the folderlist (or switcher) parameter which is a parameter. The folderlist parameter simply defines how many of the “next” parameters belong to the first folder, how many of the parameters after that belong to the next folder, and so on. This means that folder names can change just by reordering the folders around so don’t rely on them too much. The only guarantee here is that the folder names will be unique among all other parameter names.
labelSH
: int
Property
The label string for the parameter
templateNameSH
: int
Property
If this parameter is a multiparm instance than the hapi.ParmInfo.templateNameSH will be the hash-templated parm name, containing #'s for the parts of the name that use the instance number. Compared to the hapi.ParmInfo.nameSH the hapi.ParmInfo.nameSH will be the hapi.ParmInfo.templateNameSH but with the #'s replaced by the instance number. For regular parms, the hapi.ParmInfo.templateNameSH is identical to the hapi.ParmInfo.nameSH.
helpSH
: int
Property
The help string for this parameter
hasMin
: bool
Property
Whether min/max exists for the parameter values.
hasMax
: bool
Property
Whether min/max exists for the parameter values.
hasUIMin
: bool
Property
Whether min/max exists for the parameter values.
hasUIMax
: bool
Property
Whether min/max exists for the parameter values.
min
: float
Property
Parameter value range, shared between int and float parameters.
max
: float
Property
Parameter value range, shared between int and float parameters.
UIMin
: float
Property
Parameter value range, shared between int and float parameters.
UIMax
: float
Property
Parameter value range, shared between int and float parameters.
invisible
: bool
Property
Whether this parm should be hidden from the user entirely. This is mostly used to expose parameters as asset meta-data but not allow the user to directly modify them.
disabled
: bool
Property
Whether this parm should appear enabled or disabled.
spare
: bool
Property
If true, it means this parameter doesn’t actually exist on the node in Houdini but was added by Houdini Engine as a spare parameter. This is just for your information. The behaviour of this parameter is not any different than a non-spare parameter.
joinNext
: bool
Property
Whether this parm should be on the same line as
labelNone
: bool
Property
Whether the label should be displayed.
intValuesIndex
: int
Property
The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.
floatValuesIndex
: int
Property
The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.
stringValuesIndex
: int
Property
The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.
choiceIndex
: int
Property
The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.
inputNodeType
: hapi.nodeType
Property
If this is a hapi.parmType.Node this tells you what node types this parameter accepts.
inputNodeFlag
: hapi.nodeFlags
Property
The node input parameter could have another subtype filter specified, like “Object: Geometry Only”. In this case, this value will specify that extra filter. If the filter demands a node that HAPI does not support, both this and hapi.ParmInfo.inputNodeType will be set to NONE as such a node is not settable through HAPI.
isChildOfMultiParm
: bool
Property
instanceNum
: int
Property
The index of the instance in the multiparm.
instanceLength
: int
Property
The number of parms in a multiparm instance.
instanceCount
: int
Property
The number of instances in a multiparm.
instanceStartOffset
: int
Property
First instance’s hapi.ParmInfo.instanceNum. Either 0 or 1.
visibilityConditionSH
: int
Property
Provides the raw condition string which is used to evaluate the the visibility of a parm
disabledConditionSH
: int
Property
Provides the raw condition string which is used to evalute whether a parm is enabled or disabled
useMenuItemTokenAsValue
: bool
Property
Whether or not the “Use Menu Item Token As Value” checkbox was checked in a integer menu item.