HumanIK Objects

Module description

This section describes the principal objects used by HumanIK.

Classes

struct  HIKCharacter
 Defines a character to be used with HumanIK. More...
 
struct  HIKCharacterDefinition
 Defines which Nodes are to be used by an HIKCharacter. More...
 
struct  HIKCharacterState
 Defines a pose for a character. More...
 
struct  HIKEffectorSetState
 Defines an HIKEffectorSetState. More...
 
struct  HIKPropertySetState
 Defines a character's properties. More...
 

Modules

 Constructors
 This section describes the functions used to create HIK objects.
 
 Destructors
 This section describes the functions used to destroy HIK objects.
 
 Determining Object Size in Memory
 This page describes the functions provided for determining the size in memory of the different HumanIK objects.
 
 Streaming Objects To and From Memory
 
 Load/Store HumanIK Objects
 

Enumerations

enum  HIKNodeFlags {
  HIKNodeNotUsed = 0, HIKNodeUsed = 1 << 0, HIKNodeParentOffset = 1 << 1 | HIKNodeUsed, HIKNodeLimits = 1 << 2 | HIKNodeParentOffset,
  HIKNodeIsLeafRoll = 1 << 3
}
 Flags used in the characterization process, in conjunction with HIKCharacterDefinition. More...
 

Enumeration Type Documentation

Flags used in the characterization process, in conjunction with HIKCharacterDefinition.

Enumerator
HIKNodeNotUsed 

Node is not characterized.

HIKNodeUsed 

Node is characterized.

HIKNodeParentOffset 

Node has a parent unknown to HumanIK, used for local space transform and DoF. Transparently assigns HIKNodeUsed.

HIKNodeLimits 

Node has limits (DoF). Transparently assigns HIKNodeParentOffset, which in turn assigns HIKNodeUsed.

HIKNodeIsLeafRoll 

Node is a leaf roll extraction node (only relevant for arms and legs)