Detailed Description

KeyingGroup class.

This class is an interface to manipulate which properties will be keyed when active. A derived class could control when the keying group should activate and what content it should have. For example, a derived class could activate based one that is selected in the scene.

To create a custom keying group, use the appropriate FBKeyingGroupType flag. Then, if it is a local keying group, call AddObjectDependency() to add an object to the keying group. You can then add properties belonging to the new object with AddProperty().

If you are creating an object type keying group, call SetObjectType() to specify what kind of object will be keyed by this keying group. Then, add a property from an object, the name of the property will be used by the keying group the find corresponding properties in selected object.

If you create a global keying group, simply properties from an object with AddProperty(). The name of the property will be used by the keying group to find corresponding properties in the selected object.

Examples: Tasks/FBKeyingGroupLocal.py

Inheritance diagram for FBKeyingGroup:

[legend]

List of all members.

Public Member Functions
	__init__ (str pName, FBKeyingGroupType pType, object pObject=None)
	Constructor.
	FBDelete ()
	Virtual FBDelete function.
	SetObjectType (FBComponent pObject)
	Set the object type filter for and object type keying group.
	AddProperty (FBProperty pProp)
	Add property to be keyed when current keying group is active.
	RemoveProperty (FBProperty pProp)
	RemoveProperty from the keyinggroup list.
FBProperty	GetProperty (int pIndex)
	GetProperty from the keyinggroup list.
int	GetPropertyCount ()
	GetPropertyCount.
int	FindPropertyIndex (FBProperty pProp)
	FindPropertyIndex.
	AddObjectDependency (FBComponent pObj)
	AddObjectDependency An object dependency is the content of a keying group and will activate keying group when selected (activation only works if the keying group is a character extension).
	RemoveObjectDependency (FBComponent pObj)
	RemoveObjectDependency An object dependency is the content of a keying group and will activate keying group when selected (activation only works if the keying group is a character extension).
bool	IsObjectDependency (FBComponent pObj)
	IsObjectDependency determine if the `pObj` is a dependency.
bool	IsObjectDependencySelected ()
	IsObjectDependencySelected.
	RemoveAllProperties ()
	IsObjectDependencySelected empty the property list.
	RemoveAllObjectDependency ()
	IsObjectDependencySelected empty the content list.
	RemoveAllSubKeyingGroup ()
	RemoveAllSubKeyingGroup empty the child keying group.
int	GetParentKeyingGroupCount ()
	GetParentKeyingGroupCount.
HFBKeyingGroup	GetParentKeyingGroup (int pIndex)
	GetParentKeyingGroup.
int	GetSubKeyingGroupCount ()
	GetSubKeyingGroupCount.
HFBKeyingGroup	GetSubKeyingGroup (int pIndex)
	GetSubKeyingGroup.
int	GetSubObjectCount ()
	GetSubObjectCount.
FBComponent	GetSubObject (int pIndex)
	GetSubObject.
int	GetCumulativePropertyCount (bool pStopAtVisible=False)
	GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.
FBProperty	GetCumulativeProperty (int pIndex, bool pStopAtVisible=False)
	GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.
	ClearAllItems ()
	ClearAllItems clear object dependency, properties and child keying group.
	SetEnabled (bool pEnable)
	SetEnabled, makes the keying group available in keying group list of the key control UI.
	SetActive (bool pActive)
	SetActive, activate the keying group, replacing the other keying group.
	SetActiveAppend (bool pActive)
	SetActiveAppend, activate and append the keying group to the other keying groups.

Member Function Documentation

__init__	(	str	pName,
		FBKeyingGroupType	pType,
		object	pObject = `None`
	)

pName	Group name.
pType	Keying group type.
pObject	For internal use only.

FBProperty GetCumulativeProperty	(	int	pIndex,
		bool	pStopAtVisible = `False`
	)

pIndex	index in the content Object Dependency list
pStopAtVisible	consider all keying group and stop to the first visible keying group.

FBKeyingGroup Class Reference

Detailed Description

Public Member Functions

Member Function Documentation