FBKeyingGroup Class Reference
FBKeyingGroup Class Reference
#include <mobu-python-api.h>
Class 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.
Inheritance diagram for FBKeyingGroup:
Public Member Functions | |
| __reduce__ () | |
| AddObjectDependency (FBKeyingGroup arg1, FBComponent arg2) | |
| 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). More... | |
| __init__ (object arg1, str arg2, FBKeyingGroupType arg3) | |
| Constructor. More... | |
| AddProperty (FBKeyingGroup arg1, FBProperty arg2) | |
| Add property to be keyed when current keying group is active. More... | |
| ClearAllItems (FBKeyingGroup arg1) | |
| ClearAllItems clear object dependency, properties and child keying group. More... | |
| FBDelete (FBKeyingGroup arg1) | |
| Virtual FBDelete function. More... | |
| int | FindPropertyIndex (FBKeyingGroup arg1, FBProperty arg2) |
| FindPropertyIndex. More... | |
| object | GetCumulativeProperty (FBKeyingGroup arg1, object arg2, object arg3) |
| GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group. More... | |
| int | GetCumulativePropertyCount (FBKeyingGroup arg1, object arg2) |
| GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group. More... | |
| object | GetParentKeyingGroup (FBKeyingGroup arg1, object arg2) |
| GetParentKeyingGroup. More... | |
| int | GetParentKeyingGroupCount (FBKeyingGroup arg1) |
| GetParentKeyingGroupCount. More... | |
| object | GetProperty (FBKeyingGroup arg1, object arg2) |
| GetProperty from the keyinggroup list. More... | |
| int | GetPropertyCount (FBKeyingGroup arg1) |
| GetPropertyCount. More... | |
| object | GetSubKeyingGroup (FBKeyingGroup arg1, object arg2) |
| GetSubKeyingGroup. More... | |
| int | GetSubKeyingGroupCount (FBKeyingGroup arg1) |
| GetSubKeyingGroupCount. More... | |
| object | GetSubObject (FBKeyingGroup arg1, object arg2) |
| GetSubObject. More... | |
| int | GetSubObjectCount (FBKeyingGroup arg1) |
| GetSubObjectCount. More... | |
| bool | IsObjectDependency (FBKeyingGroup arg1, FBComponent arg2) |
IsObjectDependency determine if the pObj is a dependency. More... | |
| bool | IsObjectDependencySelected (FBKeyingGroup arg1) |
| IsObjectDependencySelected. More... | |
| RemoveAllObjectDependency (FBKeyingGroup arg1) | |
| IsObjectDependencySelected empty the content list. More... | |
| RemoveAllProperties (FBKeyingGroup arg1) | |
| IsObjectDependencySelected empty the property list. More... | |
| RemoveAllSubKeyingGroup (FBKeyingGroup arg1) | |
| RemoveAllSubKeyingGroup empty the child keying group. More... | |
| RemoveObjectDependency (FBKeyingGroup arg1, FBComponent arg2) | |
| 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). More... | |
| RemoveProperty (FBKeyingGroup arg1, FBProperty arg2) | |
| RemoveProperty from the keyinggroup list. More... | |
| SetActive (FBKeyingGroup arg1, object arg2) | |
| SetActive, activate the keying group, replacing the other keying group. More... | |
| SetActiveAppend (FBKeyingGroup arg1, object arg2) | |
| SetActiveAppend, activate and append the keying group to the other keying groups. More... | |
| SetEnabled (FBKeyingGroup arg1, object arg2) | |
| SetEnabled, makes the keying group available in keying group list of the key control UI. More... | |
| SetObjectType (FBKeyingGroup arg1, FBComponent arg2) | |
| Set the object type filter for and object type keying group. More... | |
| method | staticmethod (function) |
| FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene. More... | |
| Public Member Functions inherited from FBComponent | |
| __reduce__ () | |
| FBPropertyList | PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2) |
| Get list of properties which have been modified since last loading. More... | |
| str | ClassName (FBComponent arg1) |
| Get the class name. More... | |
| DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate (FBComponent arg1) |
| Open Reality Creation function. More... | |
| FBDelete (FBComponent arg1) | |
| Open Reality deletion function. More... | |
| FBDestroy (FBComponent arg1) | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags (FBComponent arg1) |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBComponent arg1, FBObjectStatus arg2) |
| Check to see if an object status is enabled. More... | |
| bool | HasObjectFlags (FBComponent arg1, FBObjectFlag arg2) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (FBComponent arg1, object arg2) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
| ProcessObjectNamespace. More... | |
| int | PropertyAdd (FBComponent arg1, FBProperty arg2) |
| Add a property to the component's property manager. More... | |
| bool | PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2) |
| Add a reference property to the component's property manager. More... | |
| object | PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7) |
| Create user or dynamic property. More... | |
| PropertyRemove (FBComponent arg1, FBProperty arg2) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3) | |
| Enable/Disable a specific Object Status. More... | |
| HardSelect (FBComponent arg1) | |
| HardSelect. More... | |
| object | GetOwnerFileReference (FBComponent arg1) |
| Get the owner FileReference object. More... | |
| __init__ (...) | |
| Constructor. More... | |
| Public Member Functions inherited from FBPlug | |
| __reduce__ () | |
| bool | BeginChange (FBPlug arg1) |
| Begins a change on multiple plugs. More... | |
| str | ClassName (FBPlug arg1) |
| internal System vars. More... | |
| bool | ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a destination connection. More... | |
| bool | ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a destination connection. More... | |
| bool | ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a source connection. More... | |
| bool | ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a source connection. More... | |
| DisconnectAllDst (FBPlug arg1) | |
| Remove all destination connections. More... | |
| DisconnectAllSrc (FBPlug arg1) | |
| Remove all source connections. More... | |
| bool | DisconnectDst (FBPlug arg1, FBPlug arg2) |
| Remove a destination connection. More... | |
| bool | DisconnectDstAt (FBPlug arg1, object arg2) |
| Remove a destination connection at a specified index. More... | |
| bool | DisconnectSrc (FBPlug arg1, FBPlug arg2) |
| Remove a source connection. More... | |
| bool | DisconnectSrcAt (FBPlug arg1, object arg2) |
| Remove a source connection at a specified index. More... | |
| EndChange (FBPlug arg1) | |
| Ends a change on multiple plugs. More... | |
| object | GetDst (FBPlug arg1, object arg2) |
| Get a destination connection's plug at specified index. More... | |
| int | GetDstCount (FBPlug arg1) |
| Get destination connection count. More... | |
| FBConnectionType | GetDstType (FBPlug arg1, object arg2) |
| Get a destination connection's type at specified index. More... | |
| object | GetOwned (FBPlug arg1, object arg2) |
| Get the owned plug at specified index. More... | |
| int | GetOwnedCount (FBPlug arg1) |
| Get the owned plug count. More... | |
| object | GetOwner (FBPlug arg1) |
| Get the owner of this plug. More... | |
| object | GetSrc (FBPlug arg1, object arg2) |
| Get a source connection's plug at specified index. More... | |
| int | GetSrcCount (FBPlug arg1) |
| Get source connection count. More... | |
| FBConnectionType | GetSrcType (FBPlug arg1, object arg2) |
| Get a source connection's type at specified index. More... | |
| bool | Is (FBPlug arg1, object arg2) |
| Is( int pTypeId ) More... | |
| bool | IsSDKComponent (FBPlug arg1) |
| Return whether or not item is an SDK component. More... | |
| MoveSrcAt (...) | |
| bool | ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a destination connection at a specified index. More... | |
| bool | ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a source connection at a specified index. More... | |
| bool | SwapSrc (FBPlug arg1, object arg2, object arg3) |
| Swap source connection at index A with source connection at index B. More... | |
| SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's self modification flag. More... | |
| bool | GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's self has changed. More... | |
| SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's owned property/object's modification flag. More... | |
| bool | GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's content has changed. More... | |
| int | GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4) |
| Get plug's modified src/dst property/object connection added/removed List. More... | |
| bool | RevertModification (FBPlug arg1, FBPlugModificationFlag arg2) |
| Revert the plug's modification to original status. More... | |
| __init__ (...) | |
| method | staticmethod (function) |
| Public Member Functions inherited from FBPythonWrapper | |
| __reduce__ () | |
| __init__ (...) | |
Additional Inherited Members | |
| Public Attributes inherited from FBComponent | |
| object | OwnerNamespace |
| ORSDK2018::FBPropertyListComponent | Components |
| List: List of components. More... | |
| ORSDK2018::FBPropertyString | Name |
| Read Write Property: Unique name of object. More... | |
| ORSDK2018::FBPropertyString | LongName |
| Read Write Property: Name and namespace for object. More... | |
| object | FullName |
| ORSDK2018::FBPropertyListComponent | Parents |
| List: Parents. More... | |
| ORSDK2018::FBPropertyManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| FBPropertyBool | Selected |
| Read Write Property: Selected property. More... | |
| Public Attributes inherited from FBPythonWrapper | |
| object | OnUnbind |
Member Function Documentation
| __init__ | ( | object | arg1, |
| str | arg2, | ||
| FBKeyingGroupType | arg3 | ||
| ) |
Constructor.
Python Docstring:
__init__( (object)arg1, (str)arg2, (FBKeyingGroupType)arg3) -> None
C++ Signature:
FBKeyingGroup(const char * pName, FBKeyingGroupType pType, HIObject pObject = ((void *) 0))
- Parameters
-
pName Group name. pType Keying group type. pObject For internal use only.
| __reduce__ | ( | ) |
| AddObjectDependency | ( | FBKeyingGroup | arg1, |
| FBComponent | arg2 | ||
| ) |
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).
Python Docstring:
AddObjectDependency( (FBKeyingGroup)arg1, (FBComponent)arg2) -> None
C++ Signature:
void AddObjectDependency(ORSDK2018::FBComponent * pObj)
- Parameters
-
pObj a Dependency of the keying group.
| AddProperty | ( | FBKeyingGroup | arg1, |
| FBProperty | arg2 | ||
| ) |
Add property to be keyed when current keying group is active.
Python Docstring:
AddProperty( (FBKeyingGroup)arg1, (FBProperty)arg2) -> None
C++ Signature:
void AddProperty(ORSDK2018::FBProperty * pProp)
- Parameters
-
pProp Property to be added.
| ClearAllItems | ( | FBKeyingGroup | arg1 | ) |
ClearAllItems clear object dependency, properties and child keying group.
Python Docstring:
ClearAllItems( (FBKeyingGroup)arg1) -> None
C++ Signature:
void ClearAllItems()
| FBDelete | ( | FBKeyingGroup | arg1 | ) |
Virtual FBDelete function.
Python Docstring:
FBDelete( (FBKeyingGroup)arg1) -> None
C++ Signature:
void FBDelete()
| int FindPropertyIndex | ( | FBKeyingGroup | arg1, |
| FBProperty | arg2 | ||
| ) |
FindPropertyIndex.
Python Docstring:
FindPropertyIndex( (FBKeyingGroup)arg1, (FBProperty)arg2) -> int
C++ Signature:
int FindPropertyIndex(ORSDK2018::FBProperty * pProp)
- Parameters
-
pProp must be in the list (return -1 if not).
- Returns
- the index of pProp in the keyinggroup property list.
| object GetCumulativeProperty | ( | FBKeyingGroup | arg1, |
| object | arg2, | ||
| object | arg3 | ||
| ) |
GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.
Python Docstring:
GetCumulativeProperty( (FBKeyingGroup)arg1, (object)arg2, (object)arg3) -> object
C++ Signature:
ORSDK2018::FBProperty * GetCumulativeProperty(int pIndex, bool pStopAtVisible = false)
- 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.
| int GetCumulativePropertyCount | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.
Python Docstring:
GetCumulativePropertyCount( (FBKeyingGroup)arg1 [, (object)arg2]) -> int
C++ Signature:
int GetCumulativePropertyCount(bool pStopAtVisible = false)
- Parameters
-
pStopAtVisible consider all keying group and stop to the first visible keying group.
- Returns
- he number of ObjectDependency of the keying group.
| object GetParentKeyingGroup | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
GetParentKeyingGroup.
Python Docstring:
GetParentKeyingGroup( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
ORSDK2018::FBKeyingGroup * GetParentKeyingGroup(int pIndex)
- Parameters
-
pIndex is the index of the parent list of the current keying group.
- Returns
- the parent keying group.
| int GetParentKeyingGroupCount | ( | FBKeyingGroup | arg1 | ) |
GetParentKeyingGroupCount.
Python Docstring:
GetParentKeyingGroupCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetParentKeyingGroupCount()
- Returns
- the number of parent.
| object GetProperty | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
GetProperty from the keyinggroup list.
Python Docstring:
GetProperty( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
ORSDK2018::FBProperty * GetProperty(int pIndex)
- Parameters
-
pIndex index of the desired property.
- Returns
- property coresponding to pIndex.
| int GetPropertyCount | ( | FBKeyingGroup | arg1 | ) |
GetPropertyCount.
Python Docstring:
GetPropertyCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetPropertyCount()
- Returns
- the number of properties in the keying group.
| object GetSubKeyingGroup | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
GetSubKeyingGroup.
Python Docstring:
GetSubKeyingGroup( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
ORSDK2018::FBKeyingGroup * GetSubKeyingGroup(int pIndex)
- Parameters
-
pIndex index of the desired keying group child.
- Returns
- the the child at the index.
| int GetSubKeyingGroupCount | ( | FBKeyingGroup | arg1 | ) |
GetSubKeyingGroupCount.
Python Docstring:
GetSubKeyingGroupCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetSubKeyingGroupCount()
- Returns
- the number of child keying group.
| object GetSubObject | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
GetSubObject.
Python Docstring:
GetSubObject( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
ORSDK2018::FBComponent * GetSubObject(int pIndex)
- Parameters
-
pIndex index in the content Object Dependency list
- Returns
- the desired object at
pIndex.
| int GetSubObjectCount | ( | FBKeyingGroup | arg1 | ) |
GetSubObjectCount.
Python Docstring:
GetSubObjectCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetSubObjectCount()
- Returns
- the number of ObjectDependency of the keying group.
| bool IsObjectDependency | ( | FBKeyingGroup | arg1, |
| FBComponent | arg2 | ||
| ) |
IsObjectDependency determine if the pObj is a dependency.
Python Docstring:
IsObjectDependency( (FBKeyingGroup)arg1, (FBComponent)arg2) -> bool
C++ Signature:
bool IsObjectDependency(ORSDK2018::FBComponent * pObj)
- Parameters
-
pObj an object to test the Dependency.
- Returns
- true if it depend.
| bool IsObjectDependencySelected | ( | FBKeyingGroup | arg1 | ) |
IsObjectDependencySelected.
Python Docstring:
IsObjectDependencySelected( (FBKeyingGroup)arg1) -> bool
C++ Signature:
bool IsObjectDependencySelected()
- Returns
- return true as soon as a Property Owner or another Object Dependency is selected.
| RemoveAllObjectDependency | ( | FBKeyingGroup | arg1 | ) |
IsObjectDependencySelected empty the content list.
Python Docstring:
RemoveAllObjectDependency( (FBKeyingGroup)arg1) -> None
C++ Signature:
void RemoveAllObjectDependency()
| RemoveAllProperties | ( | FBKeyingGroup | arg1 | ) |
IsObjectDependencySelected empty the property list.
Python Docstring:
RemoveAllProperties( (FBKeyingGroup)arg1) -> None
C++ Signature:
void RemoveAllProperties()
| RemoveAllSubKeyingGroup | ( | FBKeyingGroup | arg1 | ) |
RemoveAllSubKeyingGroup empty the child keying group.
Python Docstring:
RemoveAllSubKeyingGroup( (FBKeyingGroup)arg1) -> None
C++ Signature:
void RemoveAllSubKeyingGroup()
| RemoveObjectDependency | ( | FBKeyingGroup | arg1, |
| FBComponent | arg2 | ||
| ) |
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).
Python Docstring:
RemoveObjectDependency( (FBKeyingGroup)arg1, (FBComponent)arg2) -> None
C++ Signature:
void RemoveObjectDependency(ORSDK2018::FBComponent * pObj)
- Parameters
-
pObj a Dependency of the keying group.
| RemoveProperty | ( | FBKeyingGroup | arg1, |
| FBProperty | arg2 | ||
| ) |
RemoveProperty from the keyinggroup list.
Python Docstring:
RemoveProperty( (FBKeyingGroup)arg1, (FBProperty)arg2) -> None
C++ Signature:
void RemoveProperty(ORSDK2018::FBProperty * pProp)
- Parameters
-
pProp Property to be removed.
| SetActive | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
SetActive, activate the keying group, replacing the other keying group.
Python Docstring:
SetActive( (FBKeyingGroup)arg1, (object)arg2) -> None
C++ Signature:
void SetActive(bool pActive)
| SetActiveAppend | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
SetActiveAppend, activate and append the keying group to the other keying groups.
Python Docstring:
SetActiveAppend( (FBKeyingGroup)arg1, (object)arg2) -> None
C++ Signature:
void SetActiveAppend(bool pActive)
| SetEnabled | ( | FBKeyingGroup | arg1, |
| object | arg2 | ||
| ) |
SetEnabled, makes the keying group available in keying group list of the key control UI.
Python Docstring:
SetEnabled( (FBKeyingGroup)arg1, (object)arg2) -> None
C++ Signature:
void SetEnabled(bool pEnable)
| SetObjectType | ( | FBKeyingGroup | arg1, |
| FBComponent | arg2 | ||
| ) |
Set the object type filter for and object type keying group.
Python Docstring:
SetObjectType( (FBKeyingGroup)arg1, (FBComponent)arg2) -> None
C++ Signature:
void SetObjectType(ORSDK2018::FBComponent * pObject)
- Parameters
-
pObject Object that will be used to set the keying group object type. Use NULL to remove the filter.
| method staticmethod | ( | function | ) |
FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene.
Python Docstring:
staticmethod(function) -> method
Convert a function to be a static method.
A static method does not receive an implicit first argument.
To declare a static method, use this idiom:
class C:
def f(arg1, arg2, ...): ...
f = staticmethod(f)
It can be called either on the class (e.g. C.f()) or on an instance
(e.g. C().f()). The instance is ignored except for its class.
Static methods in Python are similar to those found in Java or C++.
For a more advanced concept, see the classmethod builtin. C++ Signature:
void DeselectAllAnimatableProperties()