This section describes functions for retrieving information about character properties, such as their minimum and maximum values, mode types, current mode, name, etc.
These functions are typically of use when building a graphical user interface for controlling character properties.
For more information on property modes, mode types, and values, see ~{ Character Properties }~.
Enumerations | |
enum | HIKPropertyModeType { HIKPropertyNoMode = 0, HIKPropertyOffOn, HIKPropertyOffAutoUser, HIKPropertyAutoUser, HIKPropertyNoMode = 0, HIKPropertyOffOn, HIKPropertyOffAutoUser, HIKPropertyAutoUser } |
Lists the possible mode types for character properties. More... | |
enum | HIKPropertyValueType { HIKPropertyScalar = 0, HIKPropertyScalar = 0 } |
Lists the possible value types for character properties. More... | |
enum | HIKPropertyUnit { HIKPropertyNoUnit = 0, HIKPropertyPercent, HIKPropertySecond, HIKPropertyCentimeter, HIKPropertyDegree, HIKPropertyEnum, HIKPropertyReal, HIKPropertyNoUnit = 0, HIKPropertyPercent, HIKPropertySecond, HIKPropertyCentimeter, HIKPropertyDegree, HIKPropertyEnum, HIKPropertyReal } |
Lists the possible unit types for character properties. More... | |
Functions | |
const char * | HIKGetPropertyName (int pPropertyId) |
Retrieves a human-readable, English-language string that identifies property pPropertyId . More... | |
int | HIKGetPropertyId (const char *pName) |
Retrieves the unique ID of property pName from its descriptive name. More... | |
eHIKPropertyModeType | HIKGetPropertyInfoModeType (int pPropertyId) |
Retrieves the mode type for property pPropertyId . More... | |
eHIKPropertyValueType | HIKGetPropertyInfoValueType (int pPropertyId) |
Retrieves the value type for property pPropertyId . More... | |
eHIKPropertyUnit | HIKGetPropertyInfoUnit (int pPropertyId) |
Retrieves the unit type for property pPropertyId . More... | |
int | HIKGetPropertyInfoDefaultMode (int pPropertyId) |
Retrieves the default mode for property pPropertyId . More... | |
float | HIKGetPropertyInfoDefaultValue (int pPropertyId) |
Retrieves the default value for property pPropertyId . More... | |
float | HIKGetPropertyInfoDefaultMin (int pPropertyId) |
Retrieves the minimum accepted value for property pPropertyId . More... | |
float | HIKGetPropertyInfoDefaultMax (int pPropertyId) |
Retrieves the maximum accepted value for property pPropertyId . More... | |
const char * | HIKGetPropertyModeName (int pPropertyId, int pMode) |
Retrieves a human-readable, English-language string that identifies mode pMode for property pPropertyId . More... | |
const char * | HIKGetPropertyEnumName (int pPropertyId, int pValue) |
Retrieves a human-readable, English-language string that identifies the enumeration value pValue for property pPropertyId . More... | |
int | HIKIsPropertyDescription (int pPropertyId) |
Indicates whether or not the property is a description. More... | |
enum HIKPropertyModeType |
Lists the possible mode types for character properties.
See HIKGetPropertyInfoModeType().
Possible modes are:
pMode
parameter of the HIKSetPropertyMode() function when the mode is set. See HIKSetPropertyMode() and HIKGetPropertyMode(). Definition at line 528 of file hikproperty.h.
enum HIKPropertyUnit |
Lists the possible unit types for character properties.
Enumerator | |
---|---|
HIKPropertyNoUnit |
Indicates that the value of this property should never be used. Typically used only for properties with mode type HIKPropertyOffOn, to indicate that the property is a simple on/off toggle. |
HIKPropertyPercent |
The value of the property is expressed in the range between 0.0 and 1.0. |
HIKPropertySecond |
The value of the property is stored in seconds. |
HIKPropertyCentimeter |
The value of the property is a scalar distance. The unit of measure should be the same as the unit used when characterizing the geometry of your HIKCharacter. This unit is referred to as a "centimeter" only because the default values of all properties with this value type are sized for characters approximately 180 units tall. |
HIKPropertyDegree |
The value of the property is stored in degrees. |
HIKPropertyEnum |
The value of the property is an integer, whose interpretation is defined by an enumeration specific to that property. See each property description for details. Use the HIKSetPropertyMode() and HIKGetPropertyMode() functions to set and get the enumeration values for these properties. |
HIKPropertyReal |
The value of the property is an arbitrary floating-point number. |
HIKPropertyNoUnit |
Indicates that the value of this property should never be used. Typically used only for properties with mode type HIKPropertyOffOn, to indicate that the property is a simple on/off toggle. |
HIKPropertyPercent |
The value of the property is expressed in the range between 0.0 and 1.0. |
HIKPropertySecond |
The value of the property is stored in seconds. |
HIKPropertyCentimeter |
The value of the property is a scalar distance. The unit of measure should be the same as the unit used when characterizing the geometry of your HIKCharacter. This unit is referred to as a "centimeter" only because the default values of all properties with this value type are sized for characters approximately 180 units tall. |
HIKPropertyDegree |
The value of the property is stored in degrees. |
HIKPropertyEnum |
The value of the property is an integer, whose interpretation is defined by an enumeration specific to that property. See each property description for details. Use the HIKSetPropertyMode() and HIKGetPropertyMode() functions to set and get the enumeration values for these properties. |
HIKPropertyReal |
The value of the property is an arbitrary floating-point number. |
Definition at line 549 of file hikproperty.h.
enum HIKPropertyValueType |
Lists the possible value types for character properties.
See HIKGetPropertyInfoValueType().
Enumerator | |
---|---|
HIKPropertyScalar |
Property is a scalar. |
HIKPropertyScalar |
Property is a scalar. |
Definition at line 540 of file hikproperty.h.
Retrieves a human-readable, English-language string that identifies the enumeration value pValue
for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. This property must have the unit type HIKPropertyEnum. |
pValue | An integer that indicates the enumeration value whose name you want to retrieve. |
int HIKGetPropertyId | ( | const char * | pName | ) |
Retrieves the unique ID of property pName
from its descriptive name.
pName | Unique name of the property. Must match the string returned by HIKGetPropertyName() for the property. |
float HIKGetPropertyInfoDefaultMax | ( | int | pPropertyId | ) |
Retrieves the maximum accepted value for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
float HIKGetPropertyInfoDefaultMin | ( | int | pPropertyId | ) |
Retrieves the minimum accepted value for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
Retrieves the default mode for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
float HIKGetPropertyInfoDefaultValue | ( | int | pPropertyId | ) |
Retrieves the default value for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
eHIKPropertyModeType HIKGetPropertyInfoModeType | ( | int | pPropertyId | ) |
Retrieves the mode type for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
eHIKPropertyUnit HIKGetPropertyInfoUnit | ( | int | pPropertyId | ) |
Retrieves the unit type for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
eHIKPropertyValueType HIKGetPropertyInfoValueType | ( | int | pPropertyId | ) |
Retrieves the value type for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
Retrieves a human-readable, English-language string that identifies mode pMode
for property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
pMode | An integer that indicates the mode whose name you want to retrieve. The interpretation of this integer depends on the mode type of the property. See the HIKPropertyModeType enumeration. |
const char * HIKGetPropertyName | ( | int | pPropertyId | ) |
Retrieves a human-readable, English-language string that identifies property pPropertyId
.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
Indicates whether or not the property is a description.
A property is typically considered to be a "description" if it defines the character's stance or dimensions (such as the properties used to define the outline of the character's feet and hands for the floor contact engine). Non-descriptive properties, by contrast, typically control or constrain the HumanIK solvers in specific ways, as is the case for most other properties.
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |