Houdini Engine 1.9
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
HAPI_ParmInfo Struct Reference

#include <HAPI_Common.h>

Public Attributes

HAPI_ParmId id
 
HAPI_ParmId parentId
 Parameter id of the parent of this parameter. More...
 
HAPI_ParmType type
 
HAPI_StringHandle typeInfoSH
 
HAPI_Permissions permissions
 
int size
 
int choiceCount
 
HAPI_StringHandle nameSH
 
HAPI_StringHandle labelSH
 
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
 the next parm. More...
 
HAPI_Bool labelNone
 Whether the label should be displayed. More...
 
HAPI_Bool hasMin
 
HAPI_Bool hasMax
 
HAPI_Bool hasUIMin
 
HAPI_Bool hasUIMax
 
float min
 
float max
 
float UIMin
 
float UIMax
 
int intValuesIndex
 
int floatValuesIndex
 
int stringValuesIndex
 
int choiceIndex
 
HAPI_Bool isChildOfMultiParm
 
int instanceNum
 The index of the instance in the multiparm. More...
 
int instanceLength
 The number of parms in a multiparm instance. More...
 
int instanceCount
 The number of instances in a multiparm. More...
 
int instanceStartOffset
 First instance's HAPI_ParmInfo::instanceNum. Either 0 or 1. More...
 
HAPI_RampType rampType
 

Detailed Description

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

Definition at line 791 of file HAPI_Common.h.

Member Data Documentation

int HAPI_ParmInfo::choiceCount

Any HAPI_ParmType can be a choice list. If this is zero then this parameter is not a choice list. Otherwise, it is one. See Choice Lists.

Definition at line 830 of file HAPI_Common.h.

int HAPI_ParmInfo::choiceIndex

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

Definition at line 898 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::disabled

Whether this parm should appear enabled or disabled.

Definition at line 880 of file HAPI_Common.h.

int HAPI_ParmInfo::floatValuesIndex

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

Definition at line 896 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasMax

Whether min/max exists for the parameter values.

Definition at line 861 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasMin

Whether min/max exists for the parameter values.

Definition at line 860 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasUIMax

Whether min/max exists for the parameter values.

Definition at line 863 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::hasUIMin

Whether min/max exists for the parameter values.

Definition at line 862 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::helpSH

The help string for this parameter.

Definition at line 856 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 795 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceCount

The number of instances in a multiparm.

Definition at line 907 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceLength

The number of parms in a multiparm instance.

Definition at line 906 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceNum

The index of the instance in the multiparm.

Definition at line 905 of file HAPI_Common.h.

int HAPI_ParmInfo::instanceStartOffset

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

Definition at line 910 of file HAPI_Common.h.

int HAPI_ParmInfo::intValuesIndex

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

Definition at line 895 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 877 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::isChildOfMultiParm

See MultiParms.

Definition at line 903 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::joinNext

the next parm.

Whether this parm should be on the same line as

Definition at line 888 of file HAPI_Common.h.

HAPI_Bool HAPI_ParmInfo::labelNone

Whether the label should be displayed.

Definition at line 890 of file HAPI_Common.h.

HAPI_StringHandle HAPI_ParmInfo::labelSH

Definition at line 843 of file HAPI_Common.h.

float HAPI_ParmInfo::max

Parameter value range, shared between int and float parameters.

Definition at line 869 of file HAPI_Common.h.

float HAPI_ParmInfo::min

Parameter value range, shared between int and float parameters.

Definition at line 868 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 841 of file HAPI_Common.h.

HAPI_ParmId HAPI_ParmInfo::parentId

Parameter id of the parent of this parameter.

Definition at line 798 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 Properpties using the Browse Mode parameter property.

Definition at line 819 of file HAPI_Common.h.

HAPI_RampType HAPI_ParmInfo::rampType

See MultiParms.

Definition at line 912 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 825 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 886 of file HAPI_Common.h.

int HAPI_ParmInfo::stringValuesIndex

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

Definition at line 897 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 853 of file HAPI_Common.h.

HAPI_ParmType HAPI_ParmInfo::type

Definition at line 800 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 Properpties using the File Pattern parameter property. For example, for filtering by PNG and JPG only: "*.png *.jpg"
  • Node path parameters will indicate what type of nodes they expect in an all-caps "NETWORKTYPE/NODETYPE" pattern. This is set in the Operator Type Properpties using the Op Filter parameter property.

Definition at line 812 of file HAPI_Common.h.

float HAPI_ParmInfo::UIMax

Parameter value range, shared between int and float parameters.

Definition at line 871 of file HAPI_Common.h.

float HAPI_ParmInfo::UIMin

Parameter value range, shared between int and float parameters.

Definition at line 870 of file HAPI_Common.h.


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