Public Member Functions | Public Attributes

FBControlSet Class Reference

Search for all occurrences

Detailed Description

Control set class.

These classes are under development and may change dramatically between versions.

Definition at line 673 of file fbcharacter.h.

#include <fbcharacter.h>

Inheritance diagram for FBControlSet:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBControlSet (const char *pName, HIObject pObject=NULL)
 Constructor.
FBModelGetReferenceModel ()
 Get the reference model associated with this Control Set.
const char * GetReferenceName ()
 Get the reference name associated with this Control Set.
int GetIKEffectorIndex (FBModel *pModel)
 Return the Index of the Given Model.
FBModelGetIKEffectorModel (FBEffectorId pEffectorIndex, int pPivotIndex=0)
 Return the object associated to the given Index.
int GetIKEffectorPivotCount (FBEffectorId pEffectorIndex)
 return the number of IK Effector Slot
const char * GetIKEffectorName (FBEffectorId pEffectorIndex)
 return the name of IK Effector
int GetFKIndex (FBModel *pModel)
 Return The Index of the Given Model.
FBModelGetFKModel (int pIndex)
 Return the object associated to the given Index.
const char * GetFKName (int pIndex)
 return the name of FK Effector at the given index
int GetFKCount ()
 return the number of FK Effector Slot

Public Attributes

FBPropertyControlSetType ControlSetType
 Read Property: the control Set Type (FKIK or IK).
FBPropertyBool UseAxis
 Read Write Property: is using axis.
FBPropertyDouble FKOpacity
 Read Write Property: Opacity value used on FK (between 0 and 100).

Constructor & Destructor Documentation

FBControlSet ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of new control set.
pObjectFor internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

FBModel* GetReferenceModel ( )

Get the reference model associated with this Control Set.

Returns:
The reference model associated with the Control Set.
const char* GetReferenceName ( )

Get the reference name associated with this Control Set.

Returns:
The reference name associated with the Control Set.
int GetIKEffectorIndex ( FBModel pModel)

Return the Index of the Given Model.

Parameters:
pModelGiven Model to Obtain Index
Returns:
The Index of the Given Model.
FBModel* GetIKEffectorModel ( FBEffectorId  pEffectorIndex,
int  pPivotIndex = 0 
)

Return the object associated to the given Index.

Parameters:
pEffectorIndexGiven Index to obtain Model
pPivotIndexIndex of effector pivot
Returns:
return the model at the specified Index.
int GetIKEffectorPivotCount ( FBEffectorId  pEffectorIndex)

return the number of IK Effector Slot

Returns:
return the number of IK Effector Slot
const char* GetIKEffectorName ( FBEffectorId  pEffectorIndex)

return the name of IK Effector

Parameters:
pEffectorIndexGiven Index to obtain Name
Returns:
the name of IK Effector
int GetFKIndex ( FBModel pModel)

Return The Index of the Given Model.

Parameters:
pModelGiven Model to obtain Index
Returns:
The Index of the Given Model.
FBModel* GetFKModel ( int  pIndex)

Return the object associated to the given Index.

Parameters:
pIndexGiven Index to obtain Model
Returns:
return the model at the specified Index.
const char* GetFKName ( int  pIndex)

return the name of FK Effector at the given index

Parameters:
pIndexGiven Index
Returns:
return the name of IK Effector Slot
int GetFKCount ( )

return the number of FK Effector Slot

Returns:
return the number of IK Effector Slot

Member Data Documentation

FBPropertyControlSetType ControlSetType

Read Property: the control Set Type (FKIK or IK).

Definition at line 741 of file fbcharacter.h.

Read Write Property: is using axis.

Definition at line 742 of file fbcharacter.h.

Read Write Property: Opacity value used on FK (between 0 and 100).

Definition at line 743 of file fbcharacter.h.


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

FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet
FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet FBControlSet