This reference page is linked to from the following overview topics: Your First Python Program, Naming Conventions, FBSystem - The System Class, Scene Elements, FBScene - The Scene Class, FBModel - Transformation Data and the Scene Graph.
Detailed 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.
#include <fbscene.h>
Public Member Functions |
|
| FBScene (HIObject pObject) | |
| Constructor. |
|
| virtual void | FBDelete () |
| Virtual FBDelete function. |
|
| K_DEPRECATED void | Clear () |
| bool | Evaluate () |
| Evaluate the scene. |
|
| bool | EvaluateDeformations () |
| Evaluate the deformations of the scene.
|
|
Public Attributes |
|
| FBPropertyListTake | Takes |
| List: Takes for scene. |
|
| FBPropertyModel | RootModel |
| Read Only Property: Scene Root model
for that scene |
|
| FBPropertyListCamera | Cameras |
| List: Cameras in scene. |
|
| FBPropertyListMaterial | Materials |
| List: Materials for scene. |
|
| FBPropertyListTexture | Textures |
| List: Textures for scene. |
|
| FBPropertyListShader | Shaders |
| List: Shaders for scene. |
|
| FBPropertyListDeformer | Deformers |
| List: Deformers for scene. |
|
| FBPropertyListDevice | Devices |
| List: Devices for scene. |
|
| FBPropertyListConstraint | Constraints |
| List: Constraints in scene. |
|
| FBPropertyListLight | Lights |
| List: Lights in scene. |
|
| FBPropertyListAudioClip | AudioClips |
| List: Audio clips in scene. |
|
| FBPropertyListVideoClip | VideoClips |
| List: Video clips in scene. |
|
| FBPropertyListMotionClip | MotionClips |
| List: Motion clips in scene. |
|
| FBPropertyListFolder | Folders |
| List: Folders in scene. |
|
| FBPropertyListNote | Notes |
| List: Notes in scene. |
|
| FBPropertyListPose | Poses |
| List: Poses in scene. |
|
| FBPropertyListObjectPose | ObjectPoses |
| List: ObjectPoses in scene. |
|
| FBPropertyListActor | Actors |
| List: Actors in scene. |
|
| FBPropertyListActorFace | ActorFaces |
| List: ActorFaces in scene. |
|
| FBPropertyListMarkerSet | MarkerSets |
| List: Marker sets in scene. |
|
| FBPropertyListControlSet | ControlSets |
| List: Control set rigs in scene.
|
|
| FBPropertyListCharacter | Characters |
| List: Characters in scene. |
|
| FBPropertyListCharacterFace | CharacterFaces |
| List: Character faces in scene.
|
|
| FBPropertyListCharacterPose | CharacterPoses |
| List: Character poses in scene.
|
|
| FBPropertyListCharacterExtension | CharacterExtensions |
| List: Character extensions available
in the scene. |
|
| FBPropertyListUserObject | UserObjects |
| List: User objects |
|
| FBPropertyProjectSettings | ProjectSettings |
| Read Only Property: Local project
settings |
|
| FBPropertyRenderer | Renderer |
| Read Only Property: Local renderer
|
|
| FBPropertyListComponent | Components |
| List: Generic List of components.
|
|
| FBPropertyListGroup | Groups |
| List: Groups available in the scene.
|
|
| FBPropertyListSet | Sets |
| List: Sets available in the scene.
|
|
| FBPropertyListHandle | Handles |
| List: Handles present in the scene.
|
|
| FBPropertyListConstraintSolver | ConstraintSolvers |
| List: Constraint Solvers present in
the scene. |
|
| FBPropertyListPhysicalProperties | PhysicalProperties |
| List: PhysicalProperties present in
the scene. |
|
| FBPropertyTime | LocalTime |
| Read Write Property: Local time in
the scene. |
|
| FBPropertyEvent | OnChange |
| Event: Something in the scene has
happened. |
|
| FBPropertyEvent | OnTakeChange |
| Event: Something related to a take
has happened. |
|
Constructor & Destructor Documentation
| FBScene | ( | HIObject | pObject | ) |
Constructor.
Client code cannot instantiate objects of this class. The FBSystem class provides access to the current scene object.
- Parameters:
-
pObject Internal parent object.
Member Function Documentation
| virtual void FBDelete | ( | ) | [virtual] |
| K_DEPRECATED void Clear | ( | ) |
- Deprecated:
- Use FBApplication::FileNew() instead.
Clears the elements part of the scene. Not those that belong to all the scenes.
| bool Evaluate | ( | ) |
| bool EvaluateDeformations | ( | ) |
Member Data Documentation
| FBPropertyModel RootModel |
Read Only Property: Scene Root model for that scene
List: Control set rigs in scene.
List: Character faces in scene.
List: Character poses in scene.
List: Character extensions available in the scene.
| FBPropertyProjectSettings ProjectSettings |
Read Only Property: Local project settings
| FBPropertyRenderer Renderer |
Read Only Property: Local renderer
List: Generic List of components.
Reimplemented from FBComponent.
List: Groups available in the scene.
List: Sets available in the scene.
List: Handles present in the scene.
List: Constraint Solvers present in the scene.
List: PhysicalProperties present in the scene.
Read Write Property: Local time in the scene.
Event: Something in the scene has happened.
Event: Something related to a take has happened.
The documentation for this class was generated from the following file:
- fbsdk/fbscene.h
