HIKEffectorDataDescriptionMatrix Struct Reference

#include <humanik.h>

Class Description

A description of a data set that contains transform matrices for multiple different 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 transform matrix 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 transform matrix and IK constraint values must be aligned on 16 bytes.

Public Attributes
int *	mHIKEffectorId
size_t	mMatrixOffset
size_t	mParameterOffset
size_t	mStride

Member Data Documentation

int* HIKEffectorDataDescriptionMatrix::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 HIKEffectorDataDescriptionMatrix::mMatrixOffset

Specifies the offset of the transform matrix within each data block. Must be a 4x4 column major matrix, aligned on 16 bytes.

size_t HIKEffectorDataDescriptionMatrix::mParameterOffset

pecifies 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 HIKEffectorDataDescriptionMatrix::mStride

Specifies the total size of each data block.

---

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

• humanik.h