FBKeyingGroup Class Reference

KeyingGroup class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBKeyingGroup:

Public Member Functions
	FBKeyingGroup (str pName, FBKeyingGroupType pType)
	Constructor.
	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).
	AddProperty (FBProperty pProp)
	Add property to be keyed when current keying group is active.
	ClearAllItems ()
	ClearAllItems clear object dependency, properties and child keying group.
	DeselectAllAnimatableProperties ()
	FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene.
	FBDelete ()
	Virtual FBDelete function.
int	FindPropertyIndex (FBProperty pProp)
	FindPropertyIndex.
FBProperty	GetCumulativeProperty (int pIndex, bool pStopAtVisible=False)
	GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.
int	GetCumulativePropertyCount (bool pStopAtVisible=False)
	GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.
FBKeyingGroup	GetParentKeyingGroup (int pIndex)
	GetParentKeyingGroup.
int	GetParentKeyingGroupCount ()
	GetParentKeyingGroupCount.
FBProperty	GetProperty (int pIndex)
	GetProperty from the keyinggroup list.
int	GetPropertyCount ()
	GetPropertyCount.
FBKeyingGroup	GetSubKeyingGroup (int pIndex)
	GetSubKeyingGroup.
int	GetSubKeyingGroupCount ()
	GetSubKeyingGroupCount.
FBComponent	GetSubObject (int pIndex)
	GetSubObject.
int	GetSubObjectCount ()
	GetSubObjectCount.
bool	IsObjectDependency (FBComponent pObj)
	IsObjectDependency determine if the pObj is a dependency.
bool	IsObjectDependencySelected ()
	IsObjectDependencySelected.
	RemoveAllObjectDependency ()
	IsObjectDependencySelected empty the content list.
	RemoveAllProperties ()
	IsObjectDependencySelected empty the property list.
	RemoveAllSubKeyingGroup ()
	RemoveAllSubKeyingGroup empty the child 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).
	RemoveProperty (FBProperty pProp)
	RemoveProperty from the keyinggroup list.
	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.
	SetEnabled (bool pEnable)
	SetEnabled, makes the keying group available in keying group list of the key control UI.
	SetObjectType (FBComponent pObject)
	Set the object type filter for and object type keying group.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Additional Inherited Members
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

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.

Constructor & Destructor Documentation

FBKeyingGroup()

FBKeyingGroup	(	str	pName,
		FBKeyingGroupType	pType
	)

Constructor.

Parameters

pName	Group name.
pType	Keying group type.

Member Function Documentation

AddObjectDependency()

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

pObj	a Dependency of the keying group.

AddProperty()

AddProperty

(

FBProperty

pProp

)

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

Parameters

pProp

Property to be added.

ClearAllItems()

ClearAllItems

(

)

ClearAllItems clear object dependency, properties and child keying group.

DeselectAllAnimatableProperties()

DeselectAllAnimatableProperties

(

)

FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene.

FBDelete()

FBDelete

(

)

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

FindPropertyIndex()

int FindPropertyIndex

(

FBProperty

pProp

)

FindPropertyIndex.

Parameters

pProp

must be in the list (return -1 if not).

Returns

the index of pProp in the keyinggroup property list.

GetCumulativeProperty()

FBProperty GetCumulativeProperty	(	int	pIndex,
		bool	pStopAtVisible = False
	)

GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.

Parameters

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

Returns

he number of ObjectDependency of the keying group.

GetCumulativePropertyCount()

int GetCumulativePropertyCount

(

bool

pStopAtVisible = False

)

GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.

Parameters

pStopAtVisible

consider all keying group and stop to the first visible keying group.

Returns

he number of ObjectDependency of the keying group.

GetParentKeyingGroup()

FBKeyingGroup GetParentKeyingGroup

(

int

pIndex

)

GetParentKeyingGroup.

Parameters

pIndex

is the index of the parent list of the current keying group.

Returns

the parent keying group.

GetParentKeyingGroupCount()

int GetParentKeyingGroupCount

(

)

GetParentKeyingGroupCount.

Returns

the number of parent.

GetProperty()

FBProperty GetProperty

(

int

pIndex

)

GetProperty from the keyinggroup list.

Parameters

pIndex

index of the desired property.

Returns

property coresponding to pIndex.

GetPropertyCount()

int GetPropertyCount

(

)

GetPropertyCount.

Returns

the number of properties in the keying group.

GetSubKeyingGroup()

FBKeyingGroup GetSubKeyingGroup

(

int

pIndex

)

GetSubKeyingGroup.

Parameters

pIndex

index of the desired keying group child.

Returns

the the child at the index.

GetSubKeyingGroupCount()

int GetSubKeyingGroupCount

(

)

GetSubKeyingGroupCount.

Returns

the number of child keying group.

GetSubObject()

FBComponent GetSubObject

(

int

pIndex

)

GetSubObject.

Parameters

pIndex

index in the content Object Dependency list

Returns

the desired object at pIndex.

GetSubObjectCount()

int GetSubObjectCount

(

)

GetSubObjectCount.

Returns

the number of ObjectDependency of the keying group.

IsObjectDependency()

bool IsObjectDependency

(

FBComponent

pObj

)

IsObjectDependency determine if the pObj is a dependency.

Parameters

pObj	an object to test the Dependency.

Returns

true if it depend.

IsObjectDependencySelected()

bool IsObjectDependencySelected

(

)

IsObjectDependencySelected.

Returns

return true as soon as a Property Owner or another Object Dependency is selected.

RemoveAllObjectDependency()

RemoveAllObjectDependency

(

)

IsObjectDependencySelected empty the content list.

RemoveAllProperties()

RemoveAllProperties

(

)

IsObjectDependencySelected empty the property list.

RemoveAllSubKeyingGroup()

RemoveAllSubKeyingGroup

(

)

RemoveAllSubKeyingGroup empty the child keying group.

RemoveObjectDependency()

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

pObj	a Dependency of the keying group.

RemoveProperty()

RemoveProperty

(

FBProperty

pProp

)

RemoveProperty from the keyinggroup list.

Parameters

pProp

Property to be removed.

SetActive()

SetActive

(

bool

pActive

)

SetActive, activate the keying group, replacing the other keying group.

SetActiveAppend()

SetActiveAppend

(

bool

pActive

)

SetActiveAppend, activate and append the keying group to the other keying groups.

SetEnabled()

SetEnabled

(

bool

pEnable

)

SetEnabled, makes the keying group available in keying group list of the key control UI.

SetObjectType()

SetObjectType

(

FBComponent

pObject

)

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

Parameters

pObject

Object that will be used to set the keying group object type. Use NULL to remove the filter.