FBKeyingGroup Class Reference


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:

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.
FBKeyingGroup GetParentKeyingGroup (int pIndex)
 GetParentKeyingGroup.
int GetSubKeyingGroupCount ()
 GetSubKeyingGroupCount.
FBKeyingGroup 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 
)

Constructor.

Parameters:
pNameGroup name.
pTypeKeying group type.
pObjectFor internal use only.
Examples
Tasks/FBKeyingGroupLocal.py
FBDelete ( )

Virtual FBDelete function.

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

Reimplemented in FBCharacterExtension.

SetObjectType ( FBComponent  pObject)

Set the object type filter for and object type keying group.

Parameters:
pObjectObject that will be used to set the keying group object type. Use NULL to remove the filter.
AddProperty ( FBProperty  pProp)

Add property to be keyed when current keying group is active.

Parameters:
pPropProperty to be added.
RemoveProperty ( FBProperty  pProp)

RemoveProperty from the keyinggroup list.

Parameters:
pPropProperty to be removed.
FBProperty GetProperty ( int  pIndex)

GetProperty from the keyinggroup list.

Parameters:
pIndexindex of the desired property.
Returns:
property coresponding to pIndex.
int GetPropertyCount ( )

GetPropertyCount.

Returns:
the number of properties in the keying group.
int FindPropertyIndex ( FBProperty  pProp)

FindPropertyIndex.

Parameters:
pPropmust be in the list (return -1 if not).
Returns:
the index of pProp in the keyinggroup property list.
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).

Parameters:
pObja Dependency of the keying group.
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).

Parameters:
pObja Dependency of the keying group.
bool IsObjectDependency ( FBComponent  pObj)

IsObjectDependency determine if the pObj is a dependency.

Parameters:
pObjan object to test the Dependency.
Returns:
true if it depend.
bool IsObjectDependencySelected ( )

IsObjectDependencySelected.

Returns:
return true as soon as a Property Owner or another Object Dependency is selected.
RemoveAllProperties ( )

IsObjectDependencySelected empty the property list.

RemoveAllObjectDependency ( )

IsObjectDependencySelected empty the content list.

RemoveAllSubKeyingGroup ( )

RemoveAllSubKeyingGroup empty the child keying group.

int GetParentKeyingGroupCount ( )

GetParentKeyingGroupCount.

Returns:
the number of parent.
FBKeyingGroup GetParentKeyingGroup ( int  pIndex)

GetParentKeyingGroup.

Parameters:
pIndexis the index of the parent list of the current keying group.
Returns:
the parent keying group.
int GetSubKeyingGroupCount ( )

GetSubKeyingGroupCount.

Returns:
the number of child keying group.
FBKeyingGroup GetSubKeyingGroup ( int  pIndex)

GetSubKeyingGroup.

Parameters:
pIndexindex of the desired keying group child.
Returns:
the the child at the index.
int GetSubObjectCount ( )

GetSubObjectCount.

Returns:
the number of ObjectDependency of the keying group.
FBComponent GetSubObject ( int  pIndex)

GetSubObject.

Parameters:
pIndexindex in the content Object Dependency list
Returns:
the desired object at pIndex.
int GetCumulativePropertyCount ( bool  pStopAtVisible = False)

GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.

Parameters:
pStopAtVisibleconsider all keying group and stop to the first visible keying group.
Returns:
he number of ObjectDependency of the keying group.
FBProperty GetCumulativeProperty ( int  pIndex,
bool  pStopAtVisible = False 
)

GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.

Parameters:
pIndexindex in the content Object Dependency list
pStopAtVisibleconsider all keying group and stop to the first visible keying group.
Returns:
he number of ObjectDependency of the 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.


FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup
FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup FBKeyingGroup