This section describes the functions provided for setting and retrieving the modes and values of character properties within .
For more information on property modes, mode types, and values, see ~{ Character Properties }~.
Modules | |
Property Descriptions | |
This section offers brief descriptions of all character properties contained in each HIKPropertySetState. | |
Retrieving Property Information | |
This section describes functions for retrieving information about character properties, such as their minimum and maximum values, mode types, current mode, name, etc. | |
Functions | |
int | HIKGetPropertyMode (HIKPropertySetState *pState, int pPropertyId) |
Retrieves the current mode set for property pPropertyId in HIKPropertySetState pState . More... | |
float | HIKGetPropertyValue (HIKPropertySetState *pState, int pPropertyId) |
Retrieves the current value set for property pPropertyId in HIKPropertySetState pState . More... | |
void | HIKSetPropertyMode (HIKPropertySetState *pState, int pPropertyId, int pMode) |
Sets the current mode for property pPropertyId in HIKPropertySetState pState . More... | |
void | HIKSetPropertyValue (HIKPropertySetState *pState, int pPropertyId, float pValue) |
Sets the current value for property pPropertyId in HIKPropertySetState pState . More... | |
void | HIKPropertySetStateCopy (HIKPropertySetState *pStateOut, HIKPropertySetState *pStateIn) |
Copies all values and mode settings from HIKPropertySetState pStateIn to HIKPropertySetState pStateOut . More... | |
int | HIKIsPropertyActive (HIKPropertySetState *pState, int pPropertyId) |
Indicates whether or not property pPropertyId in HIKPropertySetState pState is active–i.e. More... | |
int | HIKIsPropertyAuto (HIKPropertySetState *pState, int pPropertyId) |
Indicates whether or not the current mode of property pPropertyId in HIKPropertySetState pState is "auto". More... | |
int HIKGetPropertyMode | ( | HIKPropertySetState * | pState, |
int | pPropertyId | ||
) |
Retrieves the current mode set for property pPropertyId
in HIKPropertySetState pState
.
See the description of each property for details on interpreting the enumeration values that can be returned by each property.
pState | HIKPropertySetState containing the property. |
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
float HIKGetPropertyValue | ( | HIKPropertySetState * | pState, |
int | pPropertyId | ||
) |
Retrieves the current value set for property pPropertyId
in HIKPropertySetState pState
.
pState | HIKPropertySetState containing the property. |
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
int HIKIsPropertyActive | ( | HIKPropertySetState * | pState, |
int | pPropertyId | ||
) |
Indicates whether or not property pPropertyId
in HIKPropertySetState pState
is active–i.e.
whether its value is currently taken into account by the HumanIK solvers.
pState | HIKPropertySetState containing the property. |
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
int HIKIsPropertyAuto | ( | HIKPropertySetState * | pState, |
int | pPropertyId | ||
) |
Indicates whether or not the current mode of property pPropertyId
in HIKPropertySetState pState
is "auto".
pState | HIKPropertySetState containing the property. |
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
void HIKPropertySetStateCopy | ( | HIKPropertySetState * | pStateOut, |
HIKPropertySetState * | pStateIn | ||
) |
Copies all values and mode settings from HIKPropertySetState pStateIn
to HIKPropertySetState pStateOut
.
pStateIn | Input HIKPropertySetState. |
pStateOut | Output HIKPropertySetState. |
void HIKSetPropertyMode | ( | HIKPropertySetState * | pState, |
int | pPropertyId, | ||
int | pMode | ||
) |
Sets the current mode for property pPropertyId
in HIKPropertySetState pState
.
See the description of each property for details on the enumeration values that can be set for that property.
pState | HIKPropertySetState containing the property. |
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
pMode | An integer that indicates the mode to set for the property. The interpretation of this integer depends on the mode type of the property. See the HIKPropertyModeType enumeration. |
void HIKSetPropertyValue | ( | HIKPropertySetState * | pState, |
int | pPropertyId, | ||
float | pValue | ||
) |
Sets the current value for property pPropertyId
in HIKPropertySetState pState
.
pState | HIKPropertySetState containing the property. |
pPropertyId | Unique ID of the property. See the HIKProperty enumeration for possible values. |
pValue | The current value of the property. |