Read HIKEffectorSetState Data

Read HIKEffectorSetState Data

Module description

This section describes the functions used to read data from an HIKEffectorSetState.

All of these functions return translation.w = 0.f and scale.w = 1.f.

Functions

void HIKGetEffectorPivotStateTQSfv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, float pT[4], float pQ[4], float pS[4], const float pIKPivot[4])
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot. More...
 
void HIKGetEffectorPivotStateTQSdv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, double pT[4], double pQ[4], double pS[4], const double pIKPivot[4])
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot. More...
 
void HIKGetEffectorPivotStatefv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, float pXForm[16], const float pIKPivot[4])
 Retrieve the transform matrix for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot. More...
 
void HIKGetEffectorPivotStatedv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, double pXForm[16], const double pIKPivot[4])
 Retrieve the transform matrix for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot. More...
 
void HIKGetCharacterSpaceEffectorStateTQSfv (const HIKCharacter *pCharacter, int pEffectorIndex, HIKEffectorSetState *pEffectorSetState, float pT[4], float pQ[4], float pS[4])
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector. More...
 
void HIKGetCharacterSpaceEffectorStateTQSdv (const HIKCharacter *pCharacter, int pEffectorIndex, HIKEffectorSetState *pEffectorSetState, double pT[4], double pQ[4], double pS[4])
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector. More...
 
void HIKGetCharacterSpaceEffectorStatefv (const HIKCharacter *pCharacter, int pEffectorIndex, HIKEffectorSetState *pEffectorSetState, float pXForm[16])
 Retrieve the transform matrix in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector. More...
 
void HIKGetCharacterSpaceEffectorStatedv (const HIKCharacter *pCharacter, int pEffectorIndex, HIKEffectorSetState *pEffectorSetState, double pXForm[16])
 Retrieve the transform matrix in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector. More...
 
void HIKGetCharacterSpaceEffectorStateDataTQ (const HIKCharacter *pCharacter, const HIKEffectorSetState *pEffectorSetState, const HIKEffectorDataDescription *pDataDescription, void *pDataSet)
 Retrieve the translation (T), quaternion rotation (Q) and IK constraint values for all Effectors specified in data description pDataDescription, applying any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of each Effector. More...
 
void HIKGetEffectorStatefv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, float pXForm[16])
 Retrieve the transform matrix of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState. More...
 
void HIKGetEffectorStatedv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, double pXForm[16])
 Retrieve the transform matrix of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState. More...
 
void HIKGetEffectorStateTQSfv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, float pT[4], float pQ[4], float pS[4])
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState. More...
 
void HIKGetEffectorStateTQfv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, float pT[4], float pQ[4])
 Retrieve the translation (T) and quaternion rotation (Q) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState. More...
 
void HIKGetEffectorStateTQSdv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, double pT[4], double pQ[4], double pS[4])
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState. More...
 
void HIKGetEffectorStateTQSAlignfv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, float *pTQS, size_t pTOffset, size_t pQOffset, size_t pSOffset)
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState. More...
 
void HIKGetEffectorStateTQAlignfv (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex, float *pTQ, size_t pTOffset, size_t pQOffset)
 Retrieve the translation (T) and quaternion rotation (Q) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState. More...
 
float HIKGetTranslationActive (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex)
 Retrieve the Reach Translation constraint for Effector pEffectorIndex. More...
 
float HIKGetRotationActive (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex)
 Retrieve the Reach Rotation constraint for Effector pEffectorIndex. More...
 
float HIKGetPull (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex)
 Retrieve the Pull constraint for Effector pEffectorIndex. More...
 
float HIKGetResist (const HIKEffectorSetState *pEffectorSetState, int pEffectorIndex)
 Retrieve the Resist constraint for Effector pEffectorIndex. More...
 
float HIKGetHandPullHips (const HIKEffectorSetState *pEffectorSetState, int pLeft)
 Retrieve the amount of pull the left or right hand can exert on the hips. More...
 
int HIKGetIKSolvingStep (const HIKEffectorSetState *pEffectorSetState)
 Retrieve the IK solving steps currently set for HIKEffectorSetState pEffectorSetState. More...
 
void HIKGetEffectorStateDataTQS (const HIKEffectorSetState *pEffectorSetState, const HIKEffectorDataDescription *pDataDescription, void *pDataSet)
 Retrieve the translation (T), quaternion rotation (Q), scaling (S), and IK constraints of multiple Effectors from HIKEffectorSetState pEffectorSetState, writing them to memory in data set pDataSet according to data description pDataDescription. More...
 
void HIKGetEffectorStateData (const HIKEffectorSetState *pEffectorSetState, const HIKEffectorDataDescriptionMatrix *pDataDescription, void *pDataSet)
 Retrieve the transform matrix and IK constraints of multiple Effectors from HIKEffectorSetState pEffectorSetState, writing them to memory in data set pDataSet according to data description pDataDescription. More...
 
void HIKCreatureGetEffectorStateTQSfv (const HIKCreatureEffectorSetState *pEffectorSetState, int pEffectorIndex, float pT[4], float pQ[4], float pS[4])
 Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKCreatureEffectorSetState pEffectorSetState. More...
 

Function Documentation

void HIKCreatureGetEffectorStateTQSfv ( const HIKCreatureEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float  pT[4],
float  pQ[4],
float  pS[4] 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKCreatureEffectorSetState pEffectorSetState.

Values are expressed using separate arrays.

Parameters
pEffectorSetStateHIKCreatureEffectorSetState containing the Effector whose translation, rotation and scaling you want to retrieve.
pEffectorIndexUnique ID of the Effector whose translation, rotation and scaling you want to retrieve.
[out]pTStores the translation value, in global space.
[out]pQStores the rotation value, in global space.
[out]pSStores the scaling value, in global space.
void HIKGetCharacterSpaceEffectorStateDataTQ ( const HIKCharacter pCharacter,
const HIKEffectorSetState pEffectorSetState,
const HIKEffectorDataDescription pDataDescription,
void *  pDataSet 
)

Retrieve the translation (T), quaternion rotation (Q) and IK constraint values for all Effectors specified in data description pDataDescription, applying any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of each Effector.

You can use this function to retrieve the rotation of multiple Effectors in local space. This function is faster than retrieving values for each Effector individually through iterative calls to HIKGetCharacterSpaceEffectorStateTQSfv().

Parameters
pCharacterRetrieve the Effectors from this character space.
pEffectorSetStateHIKEffectorSetState to retrieve data from.
pDataDescriptionData description for your data set.
pDataSetvoid pointer to the beginning of your first data block.
void HIKGetCharacterSpaceEffectorStatedv ( const HIKCharacter pCharacter,
int  pEffectorIndex,
HIKEffectorSetState pEffectorSetState,
double  pXForm[16] 
)

Retrieve the transform matrix in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector.

You can use this function to retrieve the rotation of an Effector in character space.

Parameters
pCharacterRetrieve the Effector from this character's local space.
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the effector whose TQS values are to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pXFormStores the retrieved global transform matrix. This function converts floating-point numbers internally to double-precision. For best performance, use the HIKGetCharacterSpaceEffectorStatefv() function instead wherever possible.
void HIKGetCharacterSpaceEffectorStatefv ( const HIKCharacter pCharacter,
int  pEffectorIndex,
HIKEffectorSetState pEffectorSetState,
float  pXForm[16] 
)

Retrieve the transform matrix in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector.

You can use this function to retrieve the rotation of an Effector in character space.

Parameters
pCharacterRetrieve the Effector from this character's local space.
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the effector whose TQS values are to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pXFormStores the retrieved global transform matrix.
void HIKGetCharacterSpaceEffectorStateTQSdv ( const HIKCharacter pCharacter,
int  pEffectorIndex,
HIKEffectorSetState pEffectorSetState,
double  pT[4],
double  pQ[4],
double  pS[4] 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector.

You can use this function to retrieve the rotation of an Effector in character space.

Parameters
pCharacterRetrieve the Effector from this character's local space.
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the Effector whose TQS values are to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pTStores the retrieved global translation value.
[out]pQStores the retrieved global rotation value.
[out]pSStores the retrieved global scaling value. This function converts floating-point numbers internally to double-precision. For best performance, use the HIKGetCharacterSpaceEffectorStateTQSfv() function instead wherever possible.
void HIKGetCharacterSpaceEffectorStateTQSfv ( const HIKCharacter pCharacter,
int  pEffectorIndex,
HIKEffectorSetState pEffectorSetState,
float  pT[4],
float  pQ[4],
float  pS[4] 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, and applies any rotation and scale offsets contained in the character's characterization pose (its default T-stance) to the final rotation of the Effector.

You can use this function to retrieve the rotation of an Effector in character space.

Parameters
pCharacterRetrieve the Effector from this character's local space.
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the Effector whose TQS values are to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pTStores the retrieved global translation value.
[out]pQStores the retrieved global rotation value.
[out]pSStores the retrieved global scaling value.
void HIKGetEffectorPivotStatedv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
double  pXForm[16],
const double  pIKPivot[4] 
)

Retrieve the transform matrix for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot.

The final position of the Effector is computed as follows:
final_position = effector_position + effector_q * pivot

Parameters
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the Effector whose matrix is to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pXFormTransform matrix of the Effector.
pIKPivotLocal position of the IK pivot.

This function converts floating-point numbers internally to double-precision. For best performance, use the HIKGetEffectorPivotStatefv() function instead wherever possible.

void HIKGetEffectorPivotStatefv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float  pXForm[16],
const float  pIKPivot[4] 
)

Retrieve the transform matrix for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot.

The final position of the Effector is computed as follows:
final_position = effector_position + effector_q * pivot

Parameters
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the Effector whose matrix is to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pXFormTransform matrix of the Effector.
pIKPivotLocal position of the IK pivot.
void HIKGetEffectorPivotStateTQSdv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
double  pT[4],
double  pQ[4],
double  pS[4],
const double  pIKPivot[4] 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot.

The final position of the Effector is computed as follows:
final_position = effector_position + effector_q * pivot

Parameters
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the Effector whose TQS values are to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pTGlobal translation values of the Effector.
[out]pQGlobal rotation values of the Effector.
[out]pSGlobal scaling values of the Effector.
pIKPivotLocal position of the IK pivot.

This function converts floating-point numbers internally to double-precision. For best performance, use the HIKGetEffectorPivotStateTQSfv() function instead wherever possible.

void HIKGetEffectorPivotStateTQSfv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float  pT[4],
float  pQ[4],
float  pS[4],
const float  pIKPivot[4] 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) values in global space for Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState, taking into account the IK pivot pIKPivot.

The final position of the Effector is computed as follows:
final_position = effector_position + effector_q * pivot

Parameters
pEffectorSetStateHIKEffectorSetState.
pEffectorIndexIndex of the Effector whose TQS values are to be retrieved. See the HIKEffectorId enumeration for possible values.
[out]pTGlobal translation values of the Effector.
[out]pQGlobal rotation values of the Effector.
[out]pSGlobal scaling values of the Effector.
pIKPivotLocal position of the IK pivot.
void HIKGetEffectorStateData ( const HIKEffectorSetState pEffectorSetState,
const HIKEffectorDataDescriptionMatrix pDataDescription,
void *  pDataSet 
)

Retrieve the transform matrix and IK constraints of multiple Effectors from HIKEffectorSetState pEffectorSetState, writing them to memory in data set pDataSet according to data description pDataDescription.

This function is faster than retrieving the matrix of each Effector individually using functions such as HIKGetEffectorState().

Parameters
pEffectorSetStateHIKEffectorSetState from which to retrieve the data.
pDataDescriptionData description defining the memory layout of your data set.
pDataSetVoid pointer to the beginning of your first data block.
void HIKGetEffectorStateDataTQS ( const HIKEffectorSetState pEffectorSetState,
const HIKEffectorDataDescription pDataDescription,
void *  pDataSet 
)

Retrieve the translation (T), quaternion rotation (Q), scaling (S), and IK constraints of multiple Effectors from HIKEffectorSetState pEffectorSetState, writing them to memory in data set pDataSet according to data description pDataDescription.

This function is faster than retrieving the matrix of each Effector individually using functions such as HIKGetEffectorState().

Parameters
pEffectorSetStateHIKEffectorSetState from which to retrieve the data.
pDataDescriptionData description defining the memory layout of your data set.
pDataSetVoid pointer to the beginning of your first data block.
void HIKGetEffectorStatedv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
double  pXForm[16] 
)

Retrieve the transform matrix of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose matrix you want to retrieve.
pEffectorIndexUnique ID of the Effector whose matrix you want to retrieve. See the HIKEffectorId enumeration for possible values.
[out]pXFormStores the transform matrix of the Effector in global space (4x4 column major matrix).

This function converts the double-precision numbers internally to floating-point numbers. It is intended for use only where floating-point values are unavailable. For best performance, use the HIKSetEffectorStatefv() function instead wherever possible.

+ Examples:
void HIKGetEffectorStatefv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float  pXForm[16] 
)

Retrieve the transform matrix of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose matrix you want to retrieve.
pEffectorIndexUnique ID of the Effector whose matrix you want to retrieve. See the HIKEffectorId enumeration for possible values.
[out]pXFormStores the transform matrix of the Effector in global space (4x4 column major matrix).
void HIKGetEffectorStateTQAlignfv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float *  pTQ,
size_t  pTOffset,
size_t  pQOffset 
)

Retrieve the translation (T) and quaternion rotation (Q) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState.

Values are stored at specified offsets within a single array.

The T and Q values are each stored as an array of four floating-point numbers within the pTQ array, and the offset of each of these arrays must be aligned on 16 bytes. The arrays containing the T and Q values may be in any order within the larger array. For example, the offset of the quaternion rotation data may be less than the offset of the translation data. The pTQ array may also contain other arbitrary data values interspersed between the arrays containing the T and Q values, if that is convenient.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose translation and rotation you want to retrieve.
pEffectorIndexUnique ID of the Effector whose translation and rotation you want to retrieve. See the HIKEffectorId enumeration for possible values.
[out]pTQStores the translation, rotation and scaling values of the Effector, in global space.
pTOffsetOffset for the translation values within pTQ. This offset must be aligned on 16 bytes.
pQOffsetOffset for the rotation values within pTQ. This offset must be aligned on 16 bytes.
void HIKGetEffectorStateTQfv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float  pT[4],
float  pQ[4] 
)

Retrieve the translation (T) and quaternion rotation (Q) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState.

Values are expressed using separate arrays.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose translation and rotation values you want to retrieve.
pEffectorIndexUnique ID of the Effector whose translation and rotation values you want to retrieve. See the HIKEffectorId enumeration for possible values.
[out]pTStores the translation value, in global space.
[out]pQStores the rotation value, in global space.
void HIKGetEffectorStateTQSAlignfv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float *  pTQS,
size_t  pTOffset,
size_t  pQOffset,
size_t  pSOffset 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState.

Values are stored at specified offsets within a single array.

The T, Q and S values are each stored as an array of four floating-point numbers within the pTQS array, and the offset of each of these arrays must be aligned on 16 bytes. The arrays containing the T, Q and S values may be stored in any order within the larger array. For example, the offset of the scaling data may be less than the offset of the translation data. The pTQS array may also contain other arbitrary data values interspersed between the arrays containing the T, Q and S values, if that is convenient.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose translation, rotation and scaling you want to retrieve.
pEffectorIndexUnique ID of the Effector whose translation, rotation and scaling you want to retrieve. See the HIKEffectorId enumeration for possible values.
[out]pTQSStores the translation, rotation and scaling values of the Effector, in global space.
pTOffsetOffset for the translation values within pTQS. This offset must be aligned on 16 bytes.
pQOffsetOffset for the rotation values within pTQS. This offset must be aligned on 16 bytes.
pSOffsetOffset for the scaling values within pTQS. This offset must be aligned on 16 bytes.
void HIKGetEffectorStateTQSdv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
double  pT[4],
double  pQ[4],
double  pS[4] 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState.

Values are expressed using separate arrays.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose translation, rotation and scaling you want to retrieve.
pEffectorIndexUnique ID of the Effector whose translation, rotation and scaling you want to retrieve. See the HIKEffectorId enumeration for possible values.
[out]pTStores the translation value, in global space.
[out]pQStores the rotation value, in global space.
[out]pSStores the scaling value, in global space.

This function converts the double-precision numbers internally to floating-point numbers. For best performance, use the HIKGetEffectorStateTQSfv() function instead wherever possible.

+ Examples:
void HIKGetEffectorStateTQSfv ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex,
float  pT[4],
float  pQ[4],
float  pS[4] 
)

Retrieve the translation (T), quaternion rotation (Q) and scaling (S) in global space of Effector pEffectorIndex in HIKEffectorSetState pEffectorSetState.

Values are expressed using separate arrays.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose translation, rotation and scaling you want to retrieve.
pEffectorIndexUnique ID of the Effector whose translation, rotation and scaling you want to retrieve. See the HIKEffectorId enumeration for possible values.
[out]pTStores the translation value, in global space.
[out]pQStores the rotation value, in global space.
[out]pSStores the scaling value, in global space.
float HIKGetHandPullHips ( const HIKEffectorSetState pEffectorSetState,
int  pLeft 
)

Retrieve the amount of pull the left or right hand can exert on the hips.

Parameters
pEffectorSetStateHIKEffectorSetState containing the left or right hand Effector whose Pull you want to retrieve.
pLeftIndicates whether to retrieve the pull for the left hand or right hand. 0 = right, 1 = left.
Returns
Value is between 0.0 (the hand cannot pull the hips) and 1.0 (the hand has full priority over the hips).
+ Examples:
int HIKGetIKSolvingStep ( const HIKEffectorSetState pEffectorSetState)

Retrieve the IK solving steps currently set for HIKEffectorSetState pEffectorSetState.

Parameters
pEffectorSetStateHIKEffectorSetState that you want to query.
Returns
Bit mask indicating the active steps. See the HIKSolvingStep enumeration for descriptions of the bit values.
+ Examples:
float HIKGetPull ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex 
)

Retrieve the Pull constraint for Effector pEffectorIndex.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose value you want to retrieve.
pEffectorIndexUnique ID of the Effector whose Pull you want to retrieve. See the HIKEffectorId enumeration for possible values.
Returns
alue is between 0.0 (the joint does not pull other joints in order to reach its target) and 1.0 (the joint has maximum priority for reaching its target).
+ Examples:
float HIKGetResist ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex 
)

Retrieve the Resist constraint for Effector pEffectorIndex.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose value you want to retrieve.
pEffectorIndexUnique ID of the Effector whose Resist you want to retrieve. See the HIKEffectorId enumeration for possible values.
Returns
Value is between 0.0 (the joint moves freely) and 1.0 (the joint is constrained to its original rotation).
+ Examples:
float HIKGetRotationActive ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex 
)

Retrieve the Reach Rotation constraint for Effector pEffectorIndex.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose value you want to retrieve.
pEffectorIndexUnique ID of the Effector whose Reach Rotation you want to retrieve. See the HIKEffectorId enumeration for possible values.
Returns
Value is between 0.0 (the joint is pinned to the rotation of the FK pose) and 1.0 (the joint is pinned to the rotation of the Effector)
+ Examples:
float HIKGetTranslationActive ( const HIKEffectorSetState pEffectorSetState,
int  pEffectorIndex 
)

Retrieve the Reach Translation constraint for Effector pEffectorIndex.

Parameters
pEffectorSetStateHIKEffectorSetState containing the Effector whose value you want to retrieve.
pEffectorIndexUnique ID of the Effector whose Reach Translation you want to retrieve. See the HIKEffectorId enumeration for possible values.
Returns
Value is between 0.0 (the joint is pinned to the translation of the FK pose) and 1.0 (the joint is pinned to the translation of the Effector)
+ Examples: