#include <HAPI_Common.h>

Public Attributes
HAPI_ParmId	id

HAPI_ParmId	parentId
	Parameter id of the parent of this parameter. More...

int	childIndex
	Child index within its immediate parent parameter. More...

HAPI_ParmType	type
	The HAPI type of the parm. More...

HAPI_PrmScriptType	scriptType
	The Houdini script-type of the parm. More...

HAPI_StringHandle	typeInfoSH

HAPI_Permissions	permissions

int	tagCount
	Number of tags on this paramter. More...

int	size

HAPI_ChoiceListType	choiceListType

int	choiceCount

HAPI_StringHandle	nameSH

HAPI_StringHandle	labelSH
	The label string for the parameter. More...

HAPI_StringHandle	templateNameSH

HAPI_StringHandle	helpSH
	The help string for this parameter. More...

HAPI_Bool	invisible

HAPI_Bool	disabled
	Whether this parm should appear enabled or disabled. More...

HAPI_Bool	spare

HAPI_Bool	joinNext

HAPI_Bool	labelNone
	the next parm. More...

HAPI_NodeType	inputNodeType

HAPI_NodeFlags	inputNodeFlag

HAPI_StringHandle	visibilityConditionSH

HAPI_StringHandle	disabledConditionSH

HAPI_Bool	useMenuItemTokenAsValue
	Whether or not the "Use Menu Item Token As Value" checkbox was checked in a integer menu item. More...


HAPI_Bool	hasMin

HAPI_Bool	hasMax

HAPI_Bool	hasUIMin

HAPI_Bool	hasUIMax


float	min

float	max

float	UIMin

float	UIMax


int	intValuesIndex
	Whether the label should be displayed. More...

int	floatValuesIndex
	Whether the label should be displayed. More...

int	stringValuesIndex
	Whether the label should be displayed. More...

int	choiceIndex
	Whether the label should be displayed. More...


HAPI_Bool	isChildOfMultiParm

int	instanceNum

int	instanceLength
	The index of the instance in the multiparm. More...

int	instanceCount
	The number of parms in a multiparm instance. More...

int	instanceStartOffset
	The number of instances in a multiparm. More...

HAPI_RampType	rampType

Detailed Description

Contains parameter information like name, label, type, and size.

Definition at line 1412 of file HAPI_Common.h.

Member Data Documentation

int HAPI_ParmInfo::childIndex

Child index within its immediate parent parameter.

Definition at line 1422 of file HAPI_Common.h.

int HAPI_ParmInfo::choiceCount

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_Parameters_ChoiceLists.

Definition at line 1465 of file HAPI_Common.h.

int HAPI_ParmInfo::choiceIndex

Whether the label should be displayed.

The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.

Definition at line 1534 of file HAPI_Common.h.

HAPI_ChoiceListType HAPI_ParmInfo::choiceListType

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_Parameters_ChoiceLists.

Definition at line 1458 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::disabled

Whether this parm should appear enabled or disabled.

Definition at line 1516 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::disabledConditionSH

Provides the raw condition string which is used to evalute whether a parm is enabled or disabled

Definition at line 1568 of file HAPI_Common.h.

int HAPI_ParmInfo::floatValuesIndex

Whether the label should be displayed.

The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.

Definition at line 1532 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasMax

Whether min/max exists for the parameter values.

Definition at line 1497 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasMin

Whether min/max exists for the parameter values.

Definition at line 1496 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasUIMax

Whether min/max exists for the parameter values.

Definition at line 1499 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasUIMin

Whether min/max exists for the parameter values.

Definition at line 1498 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::helpSH

The help string for this parameter.

Definition at line 1492 of file HAPI_Common.h.

HAPI_ParmId HAPI_ParmInfo::id

The parent id points to the id of the parent parm of this parm. The parent parm is something like a folder.

Definition at line 1416 of file HAPI_Common.h.

HAPI_NodeFlags HAPI_ParmInfo::inputNodeFlag

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.

Definition at line 1546 of file HAPI_Common.h.

HAPI_NodeType HAPI_ParmInfo::inputNodeType

If this is a HAPI_PARMTYPE_NODE, this tells you what node types this parameter accepts.

Definition at line 1539 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceCount

The number of parms in a multiparm instance.

Definition at line 1554 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceLength

The index of the instance in the multiparm.

Definition at line 1553 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceNum

See HAPI_Parameters_MultiParms.

Definition at line 1552 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceStartOffset

The number of instances in a multiparm.

First instance's HAPI_ParmInfo::instanceNum. Either 0 or 1.

Definition at line 1557 of file HAPI_Common.h.

int HAPI_ParmInfo::intValuesIndex

Whether the label should be displayed.

The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.

Definition at line 1531 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::invisible

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.

Definition at line 1513 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::isChildOfMultiParm

See HAPI_Parameters_MultiParms.

Definition at line 1550 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::joinNext

Definition at line 1524 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::labelNone

the next parm.

Whether this parm should be on the same line as

Definition at line 1526 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::labelSH

The label string for the parameter.

Definition at line 1479 of file HAPI_Common.h.

float HAPI_ParmInfo::max

Parameter value range, shared between int and float parameters.

Definition at line 1505 of file HAPI_Common.h.

float HAPI_ParmInfo::min

Parameter value range, shared between int and float parameters.

Definition at line 1504 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::nameSH

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.

Definition at line 1476 of file HAPI_Common.h.

HAPI_ParmId HAPI_ParmInfo::parentId

Parameter id of the parent of this parameter.

Definition at line 1419 of file HAPI_Common.h.

HAPI_Permissions HAPI_ParmInfo::permissions

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.

Definition at line 1443 of file HAPI_Common.h.

HAPI_RampType HAPI_ParmInfo::rampType

See HAPI_Parameters_MultiParms.

Definition at line 1559 of file HAPI_Common.h.

HAPI_PrmScriptType HAPI_ParmInfo::scriptType

The Houdini script-type of the parm.

Definition at line 1428 of file HAPI_Common.h.

int HAPI_ParmInfo::size

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.

Definition at line 1452 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::spare

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.

Definition at line 1522 of file HAPI_Common.h.

int HAPI_ParmInfo::stringValuesIndex

Whether the label should be displayed.

The index to use to look into the values array in order to retrieve the actual value(s) of this parameter.

Definition at line 1533 of file HAPI_Common.h.

int HAPI_ParmInfo::tagCount

Number of tags on this paramter.

Definition at line 1446 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::templateNameSH

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.

Definition at line 1489 of file HAPI_Common.h.

HAPI_ParmType HAPI_ParmInfo::type

The HAPI type of the parm.

Definition at line 1425 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::typeInfoSH

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"

Definition at line 1436 of file HAPI_Common.h.

float HAPI_ParmInfo::UIMax

Parameter value range, shared between int and float parameters.

Definition at line 1507 of file HAPI_Common.h.

float HAPI_ParmInfo::UIMin

Parameter value range, shared between int and float parameters.

Definition at line 1506 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::useMenuItemTokenAsValue

Whether or not the "Use Menu Item Token As Value" checkbox was checked in a integer menu item.

Definition at line 1571 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::visibilityConditionSH

Provides the raw condition string which is used to evaluate the the visibility of a parm

Definition at line 1564 of file HAPI_Common.h.

The documentation for this struct was generated from the following file:

HAPI/HAPI_Common.h

Public Attributes

Detailed Description

Member Data Documentation