HIKDataDescriptionMatrix Struct Reference

#include <humanik.h>

Class Description

A description of a data set that contains transform matrices for multiple different Nodes in an HIKCharacterState.

A data set is a memory buffer containing many data blocks, where each block contains the animation data for one of your character's Nodes. This structure contains metadata about the data set, indicating its transform space, its stride (the total size of each data block), a set of HumanIK NodeIDs that indicates how your data blocks map onto HumanIK Nodes, and the offset of the transform matrix data within each data block.

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

Public Types

enum  { HIKGlobalSpace = 0, HIKLocalSpace = 1 }
 

Public Attributes

int * mHIKNodeId
 
size_t mMatrixOffset
 
size_t mStride
 
enum HIKDataDescriptionMatrix:: { ... }  mTransformSpace
 

Member Enumeration Documentation

anonymous enum

Indicates whether your Node data is expressed in local or global space.

Enumerator
HIKGlobalSpace 

Data is expressed in global space.

HIKLocalSpace 

Data is expressed in local space.

Member Data Documentation

int* HIKDataDescriptionMatrix::mHIKNodeId

A list of HumanIK Node IDs indicating which Node 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 HIKDataDescriptionMatrix::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 HIKDataDescriptionMatrix::mStride

Specifies the total size of each data block.

enum { ... } HIKDataDescriptionMatrix::mTransformSpace

Indicates whether your Node data is expressed in local or global space.


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