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.
Definition at line 87 of file fbkeyinggroup.h.
#include <fbkeyinggroup.h>
Public Member Functions | |
FBKeyingGroup (const char *pName, FBKeyingGroupType pType, HIObject pObject=NULL) | |
Constructor. | |
virtual void | FBDelete () |
Virtual FBDelete function. | |
void | SetObjectType (FBComponent *pObject) |
Set the object type filter for and object type keying group. | |
void | AddProperty (FBProperty *pProp) |
Add property to be keyed when current keying group is active. | |
void | 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. | |
void | 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). | |
void | 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. | |
void | RemoveAllProperties () |
IsObjectDependencySelected empty the property list. | |
void | RemoveAllObjectDependency () |
IsObjectDependencySelected empty the content list. | |
void | 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. | |
void | ClearAllItems () |
ClearAllItems clear object dependency, properties and child keying group. | |
void | SetEnabled (bool pEnable) |
SetEnabled, makes the keying group available in keying group list of the key control UI. | |
void | SetActive (bool pActive) |
SetActive, activate the keying group, replacing the other keying group. | |
void | SetActiveAppend (bool pActive) |
SetActiveAppend, activate and append the keying group to the other keying groups. |
FBKeyingGroup | ( | const char * | pName, |
FBKeyingGroupType | pType, | ||
HIObject | pObject = NULL |
||
) |
Constructor.
pName | Group name. |
pType | Keying group type. |
pObject | For internal use only. |
virtual void FBDelete | ( | ) | [virtual] |
void SetObjectType | ( | FBComponent * | pObject | ) |
Set the object type filter for and object type keying group.
pObject | Object that will be used to set the keying group object type. Use NULL to remove the filter. |
void AddProperty | ( | FBProperty * | pProp | ) |
Add property to be keyed when current keying group is active.
pProp | Property to be added. |
void RemoveProperty | ( | FBProperty * | pProp | ) |
RemoveProperty from the keyinggroup list.
pProp | Property to be removed. |
FBProperty* GetProperty | ( | int | pIndex | ) |
GetProperty from the keyinggroup list.
pIndex | index of the desired property. |
int GetPropertyCount | ( | ) |
int FindPropertyIndex | ( | FBProperty * | pProp | ) |
FindPropertyIndex.
pProp | must be in the list (return -1 if not). |
void 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).
pObj | a Dependency of the keying group. |
void 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).
pObj | a Dependency of the keying group. |
bool IsObjectDependency | ( | FBComponent * | pObj | ) |
IsObjectDependency determine if the pObj
is a dependency.
pObj | an object to test the Dependency. |
bool IsObjectDependencySelected | ( | ) |
IsObjectDependencySelected.
void RemoveAllProperties | ( | ) |
IsObjectDependencySelected empty the property list.
void RemoveAllObjectDependency | ( | ) |
IsObjectDependencySelected empty the content list.
void RemoveAllSubKeyingGroup | ( | ) |
RemoveAllSubKeyingGroup empty the child keying group.
int GetParentKeyingGroupCount | ( | ) |
FBKeyingGroup* GetParentKeyingGroup | ( | int | pIndex | ) |
GetParentKeyingGroup.
pIndex | is the index of the parent list of the current keying group. |
int GetSubKeyingGroupCount | ( | ) |
FBKeyingGroup* GetSubKeyingGroup | ( | int | pIndex | ) |
GetSubKeyingGroup.
pIndex | index of the desired keying group child. |
int GetSubObjectCount | ( | ) |
GetSubObjectCount.
FBComponent* GetSubObject | ( | int | pIndex | ) |
GetSubObject.
pIndex | index in the content Object Dependency list |
pIndex
. int GetCumulativePropertyCount | ( | bool | pStopAtVisible = false | ) |
GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.
pStopAtVisible | consider all keying group and stop to the first visible keying group. |
FBProperty* GetCumulativeProperty | ( | int | pIndex, |
bool | pStopAtVisible = false |
||
) |
GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.
pIndex | index in the content Object Dependency list |
pStopAtVisible | consider all keying group and stop to the first visible keying group. |
void ClearAllItems | ( | ) |
ClearAllItems clear object dependency, properties and child keying group.
void SetEnabled | ( | bool | pEnable | ) |
SetEnabled, makes the keying group available in keying group list of the key control UI.
void SetActive | ( | bool | pActive | ) |
SetActive, activate the keying group, replacing the other keying group.
void SetActiveAppend | ( | bool | pActive | ) |
SetActiveAppend, activate and append the keying group to the other keying groups.