FBScene Class Reference


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.

    myScene = FBSystem().Scene

See also the C++ code sample in toolscene.

Examples
Tasks/DeleteUnusedMedia.py, Tasks/MirrorPoseOverTime.py, Tasks/SelectModelsWithNameContainingSubstring.py, Tasks/SetAllCamerasBackgroundColorFromFirstSelectedCamera.py, Tasks/StartDevice.py, BasicOperations/DeletingGroups.py, BasicOperations/FBComponent.py, BasicOperations/InsertCurrentTake.py
Inheritance diagram for FBScene:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ (object pObject)
  Constructor.
  FBDelete ()
  Virtual FBDelete function.
  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.
FBPropertyBase  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.

Member Function Documentation

__init__ ( object  pObject )
FBDelete ( )

Virtual FBDelete function.

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

Clear ( )
Deprecated:
Use FBApplication.FileNew() instead.

Clears the elements part of the scene. Not those that belong to all the scenes.

bool Evaluate ( )

Evaluate the scene.

Returns:
true if successful.
bool EvaluateDeformations ( )

Evaluate the deformations of the scene.

Returns:
true if successful.

Member Data Documentation

FBPropertyModel RootModel

Read Only Property: Scene Root model for that 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.

FBPropertyBase LocalTime

Read Write Property: Local time in the scene.

FBPropertyEvent OnChange

Event: Something in the scene has happened.

(FBEventSceneChange)

FBPropertyEvent OnTakeChange

Event: Something related to a take has happened.

(FBEventTakeChange)


FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene
FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene