CatAPI Namespace Reference

Classes
struct	HIKDefinition
class	IBoneGroupManager
class	ICATControl
class	ICATParent
	ICATParent This is the interface class to the manager of the CAT Rig. More...
class	IHub
class	ILayerRoot
class	ILimb
class	INodeControl
class	ISpine
class	ITail

Enumerations
enum	CATColourMode {   COLOURMODE_CLASSIC , COLOURMODE_ACTIVE , COLOURMODE_BLEND , COLOURMODE_SYMMETRY ,   COLOURMODE_STRETCHY }
	The colour modes define how CATs rig nodes will be coloured in the veiwport. More...
enum	CATMode { SETUPMODE , NORMAL }
	The CATMode defines how the character will behave when interacted with. More...

Functions
static const Interface_ID	BONEGROUPMANAGER_INTERFACE_FP (0x202b38a8, 0x2746669a)
static const Interface_ID	CATCONTROL_INTERFACE_FP (0xd83dc1, 0x4c851b6c)
static const Interface_ID	CATPARENT_INTERFACE_FP (0x686d5371, 0xaa835ec)
static const Interface_ID	HUB_INTERFACE_FP (0x230756c7, 0x64d04246)
static const Interface_ID	LAYERROOT_INTERFACE_FP (0x53b56707, 0x26d31718)
static const Interface_ID	LIMB_INTERFACE_FP (0x230756c7, 0x64d04246)
static const Interface_ID	I_NODECONTROL (0x1d956991, 0x7a721746)
static const Interface_ID	I_SPINE_FP (0x5a18648b, 0x43df284a)
static const Interface_ID	TAIL_INTERFACE_FP (0x17392178, 0x3c020f81)

Variables
static const int	MAX_CAT_SPINE_BONES = 9
static const int	DEFAULT_NUM_CAT_BONES = 5
static const DWORD	HUBFLAG_ALLOW_IKCONTRAINT_ROT = (1 << 16)
static const DWORD	HUBFLAG_INSPINE_RESTRICTS_MOVEMENT = (1 << 18)

Enumeration Type Documentation

CATColourMode

enum CATColourMode

The colour modes define how CATs rig nodes will be coloured in the veiwport.

Enumerator
COLOURMODE_CLASSIC
COLOURMODE_ACTIVE	original CAT colourings
COLOURMODE_BLEND	active layer colour shaded with effective weights
COLOURMODE_SYMMETRY	resulting blend of all layer colours with effective weights (aka psycheldelic)
COLOURMODE_STRETCHY	for showing symmetric bone pairs.

                       {
        COLOURMODE_CLASSIC,   
        COLOURMODE_ACTIVE, 
        // The following were never implemented, but might be a good idea some day
        COLOURMODE_BLEND,   
        COLOURMODE_SYMMETRY, 
        COLOURMODE_STRETCHY, 
    };

CATMode

enum CATMode

The CATMode defines how the character will behave when interacted with.

Enumerator
SETUPMODE	SetupMode allows the user to modify the rig, changing dimensions, and adding/removing rig elements.
NORMAL	Normal (Animation) Mode allows a user to animate a rig, setting keyframes, scaling the character etc. It is not possible to enter normal mode without an animation layer

    {
        SETUPMODE,
        NORMAL,
    };

Function Documentation

BONEGROUPMANAGER_INTERFACE_FP()

const Interface_ID BONEGROUPMANAGER_INTERFACE_FP ( 0x202b38a8 , 0x2746669a  )

static

CATCONTROL_INTERFACE_FP()

const Interface_ID CATCONTROL_INTERFACE_FP ( 0xd83dc1 , 0x4c851b6c  )

static

CATPARENT_INTERFACE_FP()

const Interface_ID CATPARENT_INTERFACE_FP ( 0x686d5371 , 0xaa835ec  )

static

HUB_INTERFACE_FP()

const Interface_ID HUB_INTERFACE_FP ( 0x230756c7 , 0x64d04246  )

static

LAYERROOT_INTERFACE_FP()

const Interface_ID LAYERROOT_INTERFACE_FP ( 0x53b56707 , 0x26d31718  )

static

LIMB_INTERFACE_FP()

const Interface_ID LIMB_INTERFACE_FP ( 0x230756c7 , 0x64d04246  )

static

I_NODECONTROL()

const Interface_ID I_NODECONTROL ( 0x1d956991 , 0x7a721746  )

static

I_SPINE_FP()

const Interface_ID I_SPINE_FP ( 0x5a18648b , 0x43df284a  )

static

TAIL_INTERFACE_FP()

const Interface_ID TAIL_INTERFACE_FP ( 0x17392178 , 0x3c020f81  )

static

Variable Documentation

MAX_CAT_SPINE_BONES

const int MAX_CAT_SPINE_BONES = 9

static

DEFAULT_NUM_CAT_BONES

const int DEFAULT_NUM_CAT_BONES = 5

static

HUBFLAG_ALLOW_IKCONTRAINT_ROT

const DWORD HUBFLAG_ALLOW_IKCONTRAINT_ROT = (1 << 16)

static

HUBFLAG_INSPINE_RESTRICTS_MOVEMENT

const DWORD HUBFLAG_INSPINE_RESTRICTS_MOVEMENT = (1 << 18)

static