FBControlSet Class Reference

#include <fbcharacter.h>

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

Inheritance diagram for FBControlSet:

[legend]

List of all members.

---

Detailed Description

Control set class.

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

Definition at line 674 of file fbcharacter.h.

Public Member Functions
	FBControlSet (char *pName, HIObject pObject=NULL)
	Constructor.
HFBModel	GetReferenceModel ()
	Get the reference model associated with this Control Set.
char *	GetReferenceName ()
	Get the reference name associated with this Control Set.
int	GetIKEffectorIndex (HFBModel pModel)
	Return the Index of the Given Model.
HFBModel	GetIKEffectorModel (FBEffectorId pEffectorIndex, int pPivotIndex=0)
	Return the object associated to the given Index.
int	GetIKEffectorPivotCount (FBEffectorId pEffectorIndex)
	return the number of IK Effector Slot
char *	GetIKEffectorName (FBEffectorId pEffectorIndex)
	return the name of IK Effector
int	GetFKIndex (HFBModel pModel)
	Return The Index of the Given Model.
HFBModel	GetFKModel (int pIndex)
	Return the object associated to the given Index.
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	(	char *	pName,
		HIObject	pObject = NULL
	)

Constructor.

Parameters:

	pName	Name of new control set.
	pObject	For internal use only. This parameter does not need to be specified by the developer.

---

Member Function Documentation

HFBModel GetReferenceModel

(

)

Get the reference model associated with this Control Set.

Returns:

The reference model associated with the Control Set.

char* GetReferenceName

(

)

Get the reference name associated with this Control Set.

Returns:

The reference name associated with the Control Set.

int GetIKEffectorIndex

(

HFBModel

pModel

)

Return the Index of the Given Model.

Parameters:

pModel

Given Model to Obtain Index

Returns:

The Index of the Given Model.

HFBModel GetIKEffectorModel	(	FBEffectorId	pEffectorIndex,
		int	pPivotIndex = 0
	)

Return the object associated to the given Index.

Parameters:

	pEffectorIndex	Given Index to obtain Model
	pPivotIndex	Index 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

char* GetIKEffectorName

(

FBEffectorId

pEffectorIndex

)

return the name of IK Effector

Parameters:

pEffectorIndex

Given Index to obtain Name

Returns:

the name of IK Effector

int GetFKIndex

(

HFBModel

pModel

)

Return The Index of the Given Model.

Parameters:

pModel

Given Model to obtain Index

Returns:

The Index of the Given Model.

HFBModel GetFKModel

(

int

pIndex

)

Return the object associated to the given Index.

Parameters:

pIndex

Given Index to obtain Model

Returns:

return the model at the specified Index.

char* GetFKName

(

int

pIndex

)

return the name of FK Effector at the given index

Parameters:

pIndex

Given 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 742 of file fbcharacter.h.

FBPropertyBool UseAxis

Read Write Property: is using axis.

Definition at line 743 of file fbcharacter.h.

FBPropertyDouble FKOpacity

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

Definition at line 744 of file fbcharacter.h.

---

Please send us your comments about this page.