FBScene Class Reference
#include <mobu-python-api.h>
Class Description
Access to the MotionBuilder scene.
In MotionBuilder, the scene is the environment where your models exist. The scene contains models which you can import, select, transform, copy, tweak, and animate. The FBScene object is obtained from the scene attribute of FBSystem. The FBScene class contains many attributes that you can use to access objects, e.g cameras, characters, lights, and takes, essentially everything you see in the Navigator in the UI. A project can only contain one scene, and if you try to create an instance of a scene you will get an error, so you must access the scene by getting a handle through FBSystem.
See also the C++ code sample in toolscene.
Inheritance diagram for FBScene:
Public Member Functions | |
| __reduce__ () | |
| FBStringList | GetScriptsPaths (FBScene arg1) |
| Get paths of all the python scripts object in the scene. More... | |
| bool | Evaluate (FBScene arg1) |
| Evaluate the scene. More... | |
| Clear (FBScene arg1) | |
| Clears the elements part of the scene. More... | |
| bool | CandidateEvaluationAndResolve (FBScene arg1) |
| Resolving the Candidate. More... | |
| bool | EvaluateDeformations (FBScene arg1) |
| Evaluate the deformations of the scene. More... | |
| FBDelete (FBScene arg1) | |
| Virtual FBDelete function. More... | |
| int | NamespaceGetChildrenList (FBScene arg1, FBStringList arg2, str arg3, object arg4) |
| Get list of children namespaces in the given namespace. More... | |
| object | NamespaceGet (FBScene arg1, str arg2) |
| Get Namespace object. More... | |
| object | NamespaceGetOwnerFileReference (FBScene arg1, str arg2) |
| Get Owner FileReference object if the namespace is originated from File Reference. More... | |
| bool | NamespaceExist (FBScene arg1, str arg2) |
| Query if namespace exists. More... | |
| bool | NamespaceEmpty (FBScene arg1, str arg2) |
| Query if namespace is empty. More... | |
| NamespaceGetContentList (FBScene arg1, FBComponentList arg2, str arg3, FBPlugModificationFlag arg4, object arg5, object arg6, object arg7) | |
| Get List of the namespace content. More... | |
| NamespaceSelectContent (FBScene arg1, str arg2, object arg3, FBPlugModificationFlag arg4, object arg5, object arg6, object arg7) | |
| Select (or de-select) the namespace content. More... | |
| bool | NamespaceRename (FBScene arg1, str arg2, str arg3, object arg4, object arg5, object arg6) |
| Rename the namespace. More... | |
| bool | NamespaceDelete (FBScene arg1, str arg2) |
| Delete the namespace & all its content. More... | |
| bool | NamespaceCleanup (FBScene arg1) |
| Remove all empty namespaces. More... | |
| bool | NamespaceDeleteContent (FBScene arg1, str arg2, FBPlugModificationFlag arg3, object arg4, object arg5, object arg6) |
| Delete the namespace content. More... | |
| bool | NamespaceImport (FBScene arg1, str arg2, str arg3, object arg4) |
| Import file into Namespace (or as file reference) More... | |
| bool | NamespaceImportToMultiple (FBScene arg1, FBStringList arg2, str arg3, object arg4) |
| Import file into multiple Namespaces (or as file references) More... | |
| bool | NamespaceExport (FBScene arg1, str arg2, str arg3, object arg4) |
| Export scene content within namespace to file. More... | |
| __init__ (...) | |
| 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__ (...) | |
Public Attributes | |
| ORSDK2018::FBPropertyListActorFace | ActorFaces |
| List: ActorFaces in scene. More... | |
| ORSDK2018::FBPropertyListActor | Actors |
| List: Actors in scene. More... | |
| ORSDK2018::FBPropertyListAudioClip | AudioClips |
| List: Audio clips in scene. More... | |
| ORSDK2018::FBPropertyListCamera | Cameras |
| List: Cameras in scene. More... | |
| ORSDK2018::FBPropertyListCharacterExtension | CharacterExtensions |
| List: Character extensions available in the scene. More... | |
| ORSDK2018::FBPropertyListCharacterFace | CharacterFaces |
| List: Character faces in scene. More... | |
| ORSDK2018::FBPropertyListCharacterPose | CharacterPoses |
| List: Character poses in scene. More... | |
| ORSDK2018::FBPropertyListCharacter | Characters |
| List: Characters in scene. More... | |
| ORSDK2018::FBPropertyListComponent | Components |
| List: Generic List of components. More... | |
| ORSDK2018::FBPropertyListConstraint | Constraints |
| List: Constraints in scene. More... | |
| ORSDK2018::FBPropertyListControlSet | ControlSets |
| List: Control set rigs in scene. More... | |
| ORSDK2018::FBPropertyListDevice | Devices |
| List: Devices for scene. More... | |
| ORSDK2018::FBPropertyListFolder | Folders |
| List: Folders in scene. More... | |
| ORSDK2018::FBPropertyListGroup | Groups |
| List: Groups available in the scene. More... | |
| ORSDK2018::FBPropertyListHandle | Handles |
| List: Handles present in the scene. More... | |
| ORSDK2018::FBPropertyListHUD | HUDs |
| Read Only Property: Heads Up Displays in the scene. More... | |
| ORSDK2018::FBPropertyListLight | Lights |
| List: Lights in scene. More... | |
| ORSDK2018::FBPropertyListMarkerSet | MarkerSets |
| List: Marker sets in scene. More... | |
| ORSDK2018::FBPropertyListCharacterMarkerSet | CharacterMarkerSets |
| List: Character marker sets in scene. More... | |
| ORSDK2018::FBPropertyListMaterial | Materials |
| List: Materials for scene. More... | |
| ORSDK2018::FBPropertyListMotionClip | MotionClips |
| List: Motion clips in scene. More... | |
| ORSDK2018::FBPropertyListNote | Notes |
| List: Notes in scene. More... | |
| ORSDK2018::FBPropertyListObjectPose | ObjectPoses |
| List: ObjectPoses in scene. More... | |
| ORSDK2018::FBPropertyListPose | Poses |
| List: Poses in scene. More... | |
| ORSDK2018::FBPropertyListPhysicalProperties | PhysicalProperties |
| List: PhysicalProperties present in the scene. More... | |
| FBPropertyRenderer | Renderer |
| Read Only Property: Local renderer. More... | |
| FBPropertyModel | RootModel |
| Read Only Property: Scene Root model for that scene More... | |
| ORSDK2018::FBPropertyListSet | Sets |
| List: Sets available in the scene. More... | |
| ORSDK2018::FBPropertyListNamespace | Namespaces |
| List: Namespace (include FileReference) available in the scene More... | |
| ORSDK2018::FBPropertyListFileReference | FileReferences |
| List: FileReference available in the scene. More... | |
| ORSDK2018::FBPropertyListShader | Shaders |
| List: Shaders for scene. More... | |
| ORSDK2018::FBPropertyListDeformer | Deformers |
| List: Deformers for scene. More... | |
| ORSDK2018::FBPropertyListConstraintSolver | ConstraintSolvers |
| List: Constraint Solvers present in the scene. More... | |
| ORSDK2018::FBPropertyListTake | Takes |
| List: Takes for scene. More... | |
| ORSDK2018::FBPropertyListTexture | Textures |
| List: Textures for scene. More... | |
| ORSDK2018::FBPropertyListUserObject | UserObjects |
| List: User objects More... | |
| ORSDK2018::FBPropertyListVideoClip | VideoClips |
| List: Video clips in scene. More... | |
| ORSDK2018::FBPropertyListKeyingGroup | KeyingGroups |
| Read Write Property: Keying Groups in the scene. More... | |
| ORSDK2018::FBPropertyListModelSkeleton | ModelSkeletons |
| Read Write Property: Bones (Skeletons) in the scene. More... | |
| ORSDK2018::FBPropertyListModelOptical | ModelOpticals |
| Read Write Property: Optical Data in the scene. More... | |
| ORSDK2018::FBPropertyEvent | OnChange |
| Event: Something in the scene has happened. More... | |
| ORSDK2018::FBPropertyEvent | OnTakeChange |
| Event: Something related to a take has happened. More... | |
| 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__ | ( | ... | ) |
Python Docstring:
Raises an exception This class cannot be instantiated from Python
C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.
| __reduce__ | ( | ) |
| bool CandidateEvaluationAndResolve | ( | FBScene | arg1 | ) |
Resolving the Candidate.
Python Docstring:
CandidateEvaluationAndResolve( (FBScene)arg1) -> bool
C++ Signature:
bool CandidateEvaluationAndResolve()
- Returns
- true if successful.
| Clear | ( | FBScene | arg1 | ) |
Clears the elements part of the scene.
Python Docstring:
Clear( (FBScene)arg1) -> None
C++ Signature:
void Clear()
Not those that belong to all the scenes.
| bool Evaluate | ( | FBScene | arg1 | ) |
Evaluate the scene.
Python Docstring:
Evaluate( (FBScene)arg1) -> bool
C++ Signature:
bool Evaluate()
- Note
- MoBu's is highly optimized for real-time performance, due to its multi-thread, double buffer and lazy-evaluation architecture, complex scripts are often required to call FBScene::Evaluate() to commit previous scene change commands before execute following operations. Also, certain operations in SDK may require cached data to be reevaluated. In typical large scenes this call may be consider as very costly. That's why user is responsible to design code in the way that requires as little as possible calls to FBScene::Evaluate. We should consider use FBScene::Evaluate() between scene change commands as "common scripting practice
- Returns
- true if successful.
| bool EvaluateDeformations | ( | FBScene | arg1 | ) |
Evaluate the deformations of the scene.
Python Docstring:
EvaluateDeformations( (FBScene)arg1) -> bool
C++ Signature:
bool EvaluateDeformations()
- Returns
- true if successful.
| FBDelete | ( | FBScene | arg1 | ) |
Virtual FBDelete function.
Python Docstring:
FBDelete( (FBScene)arg1) -> None
C++ Signature:
void FBDelete()
| FBStringList GetScriptsPaths | ( | FBScene | arg1 | ) |
Get paths of all the python scripts object in the scene.
Python Docstring:
GetScriptsPaths( (FBScene)arg1) -> FBStringList
C++ Signature:
void GetScriptsPaths(ORSDK2018::FBStringList & pPathList)
- Parameters
-
pPathList Out parameter, to collect the path of python scripts.
| bool NamespaceCleanup | ( | FBScene | arg1 | ) |
Remove all empty namespaces.
Python Docstring:
NamespaceCleanup( (FBScene)arg1) -> bool
C++ Signature:
bool NamespaceCleanup()
During some namespace operations, empty namespace may left over, while this is not harmful but could be annoying. Save the scene and load it back those empty namespaces will disappear. And this function also allow user to remove all empty namespaces from the scene easily via SDK.
- Returns
- True if operation successfully.
| bool NamespaceDelete | ( | FBScene | arg1, |
| str | arg2 | ||
| ) |
Delete the namespace & all its content.
Python Docstring:
NamespaceDelete( (FBScene)arg1, (str)arg2) -> bool
C++ Signature:
bool NamespaceDelete(const char * pNamespace)
- Parameters
-
pNamespace the namespace to work on
- Returns
- True if operation successfully, False is this namespace doesn't exist, or is locked (by FileReferencing or etc.,)
| bool NamespaceDeleteContent | ( | FBScene | arg1, |
| str | arg2, | ||
| FBPlugModificationFlag | arg3, | ||
| object | arg4, | ||
| object | arg5, | ||
| object | arg6 | ||
| ) |
Delete the namespace content.
Python Docstring:
NamespaceDeleteContent( (FBScene)arg1, (str)arg2 [, (FBPlugModificationFlag)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6]]]]) -> bool
C++ Signature:
bool NamespaceDeleteContent(const char * pNamespace, FBPlugModificationFlag pModificationFlags = kFBPlugAllContent, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false)
- Parameters
-
pNamespace the namespace to work on pModificationFlags bitwise combination of kFBConnectionSrcObjectModified, kFBConnectionDstObjectModified, kFBConnectionSrcPropertyModified, kFBConnectionDstPropertyModified flags. kFBPlugAllContent means all the content. Modification flags beside kFBPlugAllContent will only work on FileReference Namespace. pRecursive True only work on the direct children level namespace, otherwise will work on the children namespace hierarchy recursively. pTypeInfo the typeInfo of the type of interested object, default for all the objects. pExactTypeMatch if True, the derived typeInfo won't be considered (For example, FBCamera won't be considered when passing FBModel::TypeInfo).
- Returns
- False is the given namespace doesn't exist, or is locked (by FileRef or etc.,), True otherwise.
- Note
- Not all the objects will be deletable (system objects and etc.,). Deletion of partial FileRef content isn't prevented, however the behavior is undefined.
| bool NamespaceEmpty | ( | FBScene | arg1, |
| str | arg2 | ||
| ) |
Query if namespace is empty.
Python Docstring:
NamespaceEmpty( (FBScene)arg1, (str)arg2) -> bool
C++ Signature:
bool NamespaceEmpty(const char * pNamespace)
- Parameters
-
pNamespace the namespace to query, NULL for whole scene.
- Returns
- True if the namespace (don't include nested children namespace) is empty
| bool NamespaceExist | ( | FBScene | arg1, |
| str | arg2 | ||
| ) |
Query if namespace exists.
Python Docstring:
NamespaceExist( (FBScene)arg1, (str)arg2) -> bool
C++ Signature:
bool NamespaceExist(const char * pNamespace)
- Parameters
-
pNamespace the namespace to query
- Returns
- True if the namespace exist, otherwise return False.
| bool NamespaceExport | ( | FBScene | arg1, |
| str | arg2, | ||
| str | arg3, | ||
| object | arg4 | ||
| ) |
Export scene content within namespace to file.
Python Docstring:
NamespaceExport( (FBScene)arg1, (str)arg2, (str)arg3 [, (object)arg4]) -> bool
C++ Signature:
bool NamespaceExport(const char * pNamespace, const char * pFilePath, bool pASCIIFormat = false)
- Parameters
-
pNamespace the namespace to use, must exist pFilePath the referenced file path to export. pASCIIFormat save the file in ASCII format.
- Returns
- True if successfully.
| object NamespaceGet | ( | FBScene | arg1, |
| str | arg2 | ||
| ) |
Get Namespace object.
Python Docstring:
NamespaceGet( (FBScene)arg1, (str)arg2) -> object
C++ Signature:
ORSDK2018::FBNamespace * NamespaceGet(const char * pNamespace)
- Parameters
-
pNamespace the namespace to query
- Returns
- Namespace with exact name matching
| int NamespaceGetChildrenList | ( | FBScene | arg1, |
| FBStringList | arg2, | ||
| str | arg3, | ||
| object | arg4 | ||
| ) |
Get list of children namespaces in the given namespace.
Python Docstring:
NamespaceGetChildrenList( (FBScene)arg1, (FBStringList)arg2 [, (str)arg3 [, (object)arg4]]) -> int
C++ Signature:
int NamespaceGetChildrenList(ORSDK2018::FBStringList & pNamespaceList, const char * pNamespace = ((void *) 0), bool pRecursive = true)
- Parameters
-
pNamespaceList the list of namespace to return. pNamespace specify the parent namespace, NULL for the whole scene. pRecursive True only work on the direct children level namespace, otherwise will work on the whole children namespace hierarchy recursively.
- Returns
- the list of children namespaces.
| NamespaceGetContentList | ( | FBScene | arg1, |
| FBComponentList | arg2, | ||
| str | arg3, | ||
| FBPlugModificationFlag | arg4, | ||
| object | arg5, | ||
| object | arg6, | ||
| object | arg7 | ||
| ) |
Get List of the namespace content.
Python Docstring:
NamespaceGetContentList( (FBScene)arg1, (FBComponentList)arg2, (str)arg3 [, (FBPlugModificationFlag)arg4 [, (object)arg5 [, (object)arg6 [, (object)arg7]]]]) -> None
C++ Signature:
void NamespaceGetContentList(FBComponentList & pContentList, const char * pNamespace, FBPlugModificationFlag pModificationFlags = kFBPlugAllContent, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false)
- Parameters
-
pContentList the list of content to return. pNamespace the namespace to work on, NULL for whole scene. pModificationFlags bitwise combination of kFBConnectionSrcObjectModified, kFBConnectionDstObjectModified, kFBConnectionSrcPropertyModified, kFBConnectionDstPropertyModified flags. kFBPlugAllContent means all the content. Modification flags beside kFBPlugAllContent will only work on FileReference Namespace. pRecursive True only work on the direct children level namespace, otherwise will work on the whole children namespace hierarchy recursively. pTypeInfo the typeInfo of the type of interested object, 0 for all the objects. pExactTypeMatch if True, the derived typeInfo won't be considered (For example, FBCamera won't be considered when passing FBModel::TypeInfo).
| object NamespaceGetOwnerFileReference | ( | FBScene | arg1, |
| str | arg2 | ||
| ) |
Get Owner FileReference object if the namespace is originated from File Reference.
Python Docstring:
NamespaceGetOwnerFileReference( (FBScene)arg1, (str)arg2) -> object
C++ Signature:
ORSDK2018::FBFileReference * NamespaceGetOwnerFileReference(const char * pNamespace)
- Parameters
-
pNamespace the namespace to work on, could be nested namespace inside the FileReference's namespace.
- Returns
- the FileReference object is the namespace is originated from. NULL otherwise.
| bool NamespaceImport | ( | FBScene | arg1, |
| str | arg2, | ||
| str | arg3, | ||
| object | arg4 | ||
| ) |
Import file into Namespace (or as file reference)
Python Docstring:
NamespaceImport( (FBScene)arg1, (str)arg2, (str)arg3 [, (object)arg4]) -> bool
C++ Signature:
bool NamespaceImport(const char * pNamespace, const char * pFilePath, bool pAsFileReference = false)
- Parameters
-
pNamespace the namespace to import to, must be in editable scope. pFilePath the referenced file path to import. pAsFileReference import the file as file reference. The default value is false.
- Returns
- True if successfully.
| bool NamespaceImportToMultiple | ( | FBScene | arg1, |
| FBStringList | arg2, | ||
| str | arg3, | ||
| object | arg4 | ||
| ) |
Import file into multiple Namespaces (or as file references)
Python Docstring:
NamespaceImportToMultiple( (FBScene)arg1, (FBStringList)arg2, (str)arg3 [, (object)arg4]) -> bool
C++ Signature:
bool NamespaceImportToMultiple(const ORSDK2018::FBStringList & pDstNamespaceList, const char * pFilePath, bool pAsFileReference = false)
- Parameters
-
pDstNamespaceList the Dst namespaces list to import, must not exist or be self contained. pFilePath the referenced file path to import. pAsFileReference import the file as file reference. The default value is false.
- Returns
- True if successfully.
- Note
- Nested destination namespaces are not allowed (e.g. a DstNamespaceList contains "NS1" and "NS1:NS2" will return False).
| bool NamespaceRename | ( | FBScene | arg1, |
| str | arg2, | ||
| str | arg3, | ||
| object | arg4, | ||
| object | arg5, | ||
| object | arg6 | ||
| ) |
Rename the namespace.
Python Docstring:
NamespaceRename( (FBScene)arg1, (str)arg2, (str)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6]]]) -> bool
C++ Signature:
bool NamespaceRename(const char * pNameSpace, const char * pNewNamespace, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false)
- Parameters
-
pNameSpace the namespace to work on, NULL for whole scene. pNewNamespace the new namespace pRecursive True only work on the direct children level namespace, otherwise will work on the children namespace hierarchy recursively. pTypeInfo the typeInfo of the type of interested object, default for all the objects. pExactTypeMatch if True, the derived typeInfo won't be considered (For example, FBCamera won't be considered when passing FBModel::TypeInfo).
- Returns
- True if operation successfully, False is this namespace (or pTypeInfo type of objects) doesn't exist, or locked (by FileReferencing or etc.,)
- Note
- call with default parameters is considered as renaming of the whole namespace structure, otherwise will be considered as partially renaming individual objects. Renaming permission will be validated accordingly.
| NamespaceSelectContent | ( | FBScene | arg1, |
| str | arg2, | ||
| object | arg3, | ||
| FBPlugModificationFlag | arg4, | ||
| object | arg5, | ||
| object | arg6, | ||
| object | arg7 | ||
| ) |
Select (or de-select) the namespace content.
Python Docstring:
NamespaceSelectContent( (FBScene)arg1, (str)arg2, (object)arg3 [, (FBPlugModificationFlag)arg4 [, (object)arg5 [, (object)arg6 [, (object)arg7]]]]) -> None
C++ Signature:
void NamespaceSelectContent(const char * pNamespace, bool pSelect, FBPlugModificationFlag pModificationFlags = kFBPlugAllContent, bool pRecursive = true, int pTypeInfo = FBPlug::TypeInfo, bool pExactTypeMatch = false)
- Parameters
-
pNamespace the namespace to work on, NULL for whole scene. pSelect True (or False) indicate to select (or de-select) pModificationFlags bitwise combination of kFBConnectionSrcObjectModified, kFBConnectionDstObjectModified, kFBConnectionSrcPropertyModified, kFBConnectionDstPropertyModified flags. kFBPlugAllContent means all the content. Modification flags beside kFBPlugAllContent will only work on FileReference Namespace. pRecursive True only work on the direct children level namespace, otherwise will work on the children namespace hierarchy recursively. pTypeInfo the typeInfo of the type of interested object, default for all the objects. pExactTypeMatch if True, the derived typeInfo won't be considered (For example, FBCamera won't be considered when passing FBModel::TypeInfo).
Member Data Documentation
| ORSDK2018::FBPropertyListActorFace ActorFaces |
List: ActorFaces in scene.
| ORSDK2018::FBPropertyListActor Actors |
List: Actors in scene.
| ORSDK2018::FBPropertyListAudioClip AudioClips |
List: Audio clips in scene.
| ORSDK2018::FBPropertyListCamera Cameras |
List: Cameras in scene.
| ORSDK2018::FBPropertyListCharacterExtension CharacterExtensions |
List: Character extensions available in the scene.
| ORSDK2018::FBPropertyListCharacterFace CharacterFaces |
List: Character faces in scene.
| ORSDK2018::FBPropertyListCharacterMarkerSet CharacterMarkerSets |
List: Character marker sets in scene.
| ORSDK2018::FBPropertyListCharacterPose CharacterPoses |
List: Character poses in scene.
| ORSDK2018::FBPropertyListCharacter Characters |
List: Characters in scene.
| ORSDK2018::FBPropertyListComponent Components |
List: Generic List of components.
| ORSDK2018::FBPropertyListConstraint Constraints |
List: Constraints in scene.
| ORSDK2018::FBPropertyListConstraintSolver ConstraintSolvers |
List: Constraint Solvers present in the scene.
| ORSDK2018::FBPropertyListControlSet ControlSets |
List: Control set rigs in scene.
| ORSDK2018::FBPropertyListDeformer Deformers |
List: Deformers for scene.
| ORSDK2018::FBPropertyListDevice Devices |
List: Devices for scene.
| ORSDK2018::FBPropertyListFileReference FileReferences |
List: FileReference available in the scene.
| ORSDK2018::FBPropertyListFolder Folders |
List: Folders in scene.
| ORSDK2018::FBPropertyListGroup Groups |
List: Groups available in the scene.
| ORSDK2018::FBPropertyListHandle Handles |
List: Handles present in the scene.
| ORSDK2018::FBPropertyListHUD HUDs |
Read Only Property: Heads Up Displays in the scene.
| ORSDK2018::FBPropertyListKeyingGroup KeyingGroups |
Read Write Property: Keying Groups in the scene.
| ORSDK2018::FBPropertyListLight Lights |
List: Lights in scene.
| ORSDK2018::FBPropertyListMarkerSet MarkerSets |
List: Marker sets in scene.
| ORSDK2018::FBPropertyListMaterial Materials |
List: Materials for scene.
| ORSDK2018::FBPropertyListModelOptical ModelOpticals |
Read Write Property: Optical Data in the scene.
| ORSDK2018::FBPropertyListModelSkeleton ModelSkeletons |
Read Write Property: Bones (Skeletons) in the scene.
| ORSDK2018::FBPropertyListMotionClip MotionClips |
List: Motion clips in scene.
| ORSDK2018::FBPropertyListNamespace Namespaces |
List: Namespace (include FileReference) available in the scene
| ORSDK2018::FBPropertyListNote Notes |
List: Notes in scene.
| ORSDK2018::FBPropertyListObjectPose ObjectPoses |
List: ObjectPoses in scene.
| ORSDK2018::FBPropertyEvent OnChange |
| ORSDK2018::FBPropertyEvent OnTakeChange |
| ORSDK2018::FBPropertyListPhysicalProperties PhysicalProperties |
List: PhysicalProperties present in the scene.
| ORSDK2018::FBPropertyListPose Poses |
List: Poses in scene.
| FBPropertyRenderer Renderer |
Read Only Property: Local renderer.
| FBPropertyModel RootModel |
Read Only Property: Scene Root model for that scene
| ORSDK2018::FBPropertyListSet Sets |
List: Sets available in the scene.
| ORSDK2018::FBPropertyListShader Shaders |
List: Shaders for scene.
| ORSDK2018::FBPropertyListTake Takes |
List: Takes for scene.
| ORSDK2018::FBPropertyListTexture Textures |
List: Textures for scene.
| ORSDK2018::FBPropertyListUserObject UserObjects |
List: User objects
| ORSDK2018::FBPropertyListVideoClip VideoClips |
List: Video clips in scene.