FBControlSet Class Reference

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.

Public Member Functions
	FBControlSet (str pName)
	Constructor.
int	GetFKIndex (FBModel pModel)
	Return The Index of the Given Model.
FBModel	GetFKModel (int pIndex)
	Return the object associated to the given Index.
str	GetFKName (int pIndex)
	return the name of FK Effector at the given index
int	GetIKEffectorIndex (FBModel pModel)
	Return the Index of the Given Model.
FBModel	GetIKEffectorModel (FBEffectorId pEffectorIndex, int pPivotIndex=0)
	Return the object associated to the given Index.
str	GetIKEffectorName (FBEffectorId pEffectorIndex)
	return the name of IK Effector
int	GetIKEffectorPivotCount (FBEffectorId pEffectorIndex)
	return the number of IK Effector Slot
FBModel	GetReferenceModel ()
	Get the reference model associated with this Control Set.
str	GetReferenceName ()
	Get the reference name associated with this Control Set.
Public Attributes
FBControlSetType	ControlSetType
	Read Property: the control Set Type (FKIK or IK).
bool	UseAxis
	Read Write Property: is using axis.

---

Constructor & Destructor Documentation

FBControlSet

(

str

pName

)

Constructor.

Parameters:

pName

Name of new control set.

---

Member Function Documentation

int GetFKIndex

(

FBModel

pModel

)

Return The Index of the Given Model.

Parameters:

pModel

Given Model to obtain Index

Returns:

The Index of the Given Model.

FBModel 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.

str 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 GetIKEffectorIndex

(

FBModel

pModel

)

Return the Index of the Given Model.

Parameters:

pModel

Given 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:

	pEffectorIndex	Given Index to obtain Model
	pPivotIndex	Index of effector pivot

Returns:

return the model at the specified Index.

str GetIKEffectorName

(

FBEffectorId

pEffectorIndex

)

return the name of IK Effector

Parameters:

pEffectorIndex

Given Index to obtain Name

Returns:

the name of IK Effector

int GetIKEffectorPivotCount

(

FBEffectorId

pEffectorIndex

)

return the number of IK Effector Slot

Returns:

return the number of IK Effector Slot

FBModel GetReferenceModel

(

)

Get the reference model associated with this Control Set.

Returns:

The reference model associated with the Control Set.

str GetReferenceName

(

)

Get the reference name associated with this Control Set.

Returns:

The reference name associated with the Control Set.

---

Member Data Documentation

FBControlSetType ControlSetType

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

bool UseAxis

Read Write Property: is using axis.

---