HIKEffectorDataDescription Struct Reference

#include <humanik.h>

Class Description

A description of a data set that contains separate translation, quaternion rotation, and scaling values for multiple Effectors in an HIKEffectorSetState.

A data set is a memory buffer containing many data blocks, where each block contains the animation data for one of your character's Effectors. This structure contains metadata about the data set, its stride (the total size of each data block), a set of HumanIK Effector IDs that indicates how your data blocks map onto HumanIK Effectors, the offsets of the translation, rotation and scaling data within each data block, and the offset of the IK constraint data within each data block.

Remarks

Because HumanIK uses SIMD instructions to load data, your translation, quaternion, scaling and IK constraint values must be aligned on 16 bytes.

Public Attributes
int *	mHIKEffectorId
size_t	mParameterOffset
size_t	mQOffset
size_t	mSOffset
size_t	mStride
size_t	mTOffset

Member Data Documentation

int* HIKEffectorDataDescription::mHIKEffectorId

A list of HumanIK Effector IDs indicating which Effector each of your data blocks applies to. The last value in this list must be the special token HIKLastNode. See the HIKToken enumeration.

size_t HIKEffectorDataDescription::mParameterOffset

Specifies the offset of the IK constraint data within each data block. Must be a 4x1 vector, aligned on 16 bytes. The format of this data must be {ReachT, ReachR, Pull, Resist}, and each value must be between 0.0 and 1.0.

size_t HIKEffectorDataDescription::mQOffset

Specifies the offset of the quaternion rotation data within each data block. Must be a 4x1 vector, aligned on 16 bytes.

size_t HIKEffectorDataDescription::mSOffset

Specifies the offset of the scaling data within each data block. Must be a 4x1 vector, aligned on 16 bytes.

size_t HIKEffectorDataDescription::mStride

Specifies the total size of each data block.

size_t HIKEffectorDataDescription::mTOffset

Specifies the offset of the translation data within each data block. Must be a 4x1 vector, aligned on 16 bytes.

---

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

• humanik.h