FBScene Class Reference

FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene FBScene
Inheritance diagram for FBScene:
Inheritance graph
[legend]

List of all members.


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.

See samples: InsertCurrentTake.py, DeleteUnusedMedia.py, MirrorPoseOverTime.py, SelectModelsWithNameContainingSubstring.py, SetAllCamerasBackgroundColorFromFirstSelectedCamera.py, StartDevice.py.


Public Member Functions

  FBScene ()
  Constructor.
K_DEPRECATED void  Clear ()
  Clear the elements part of the scene.
bool  Evaluate ()
  Evaluate the scene.
bool  EvaluateDeformations ()
  Evaluate the deformations of the scene.
  FBDelete ()
  Virtual FBDelete function.

Public Attributes

FBListActorFace  ActorFaces
  List: ActorFaces in scene.
FBListActor  Actors
  List: Actors in scene.
FBListAudioClip  AudioClips
  List: Audio clips in scene.
FBListCamera  Cameras
  List: Cameras in scene.
FBListCharacterExtension  CharacterExtensions
  List: Character extensions available in the scene.
FBListCharacterFace  CharacterFaces
  List: Character faces in scene.
FBListCharacterPose  CharacterPoses
  List: Character poses in scene.
FBListCharacter  Characters
  List: Characters in scene.
FBListComponent  Components
  List: Generic List of components.
FBListConstraintSolver  ConstraintSolvers
  List: Constraint Solvers present in the scene.
FBListConstraint  Constraints
  List: Constraints in scene.
FBListControlSet  ControlSets
  List: Control set rigs in scene.
FBListDevice  Devices
  List: Devices for scene.
FBListFolder  Folders
  List: Folders in scene.
FBListGroup  Groups
  List: Groups available in the scene.
FBListHandle  Handles
  List: Handles present in the scene.
FBListLight  Lights
  List: Lights in scene.
FBTime  LocalTime
  Read Write Property: Local time in the scene.
FBListMarkerSet  MarkerSets
  List: Marker sets in scene.
FBListMaterial  Materials
  List: Materials for scene.
FBListMotionClip  MotionClips
  List: Motion clips in scene.
FBListNote  Notes
  List: Notes in scene.
FBListObjectPose  ObjectPoses
  List: ObjectPoses in scene.
FBEvent  OnChange
  Event: Something in the scene has happened.(FBEventSceneChange)
FBEvent  OnTakeChange
  Event: Something related to a take has happened.(FBEventTakeChange)
FBListPhysicalProperties  PhysicalProperties
  List: PhysicalProperties present in the scene.
FBListPose  Poses
  List: Poses in scene.
FBRenderer  Renderer
  Read Only Property: Local renderer
FBModel  RootModel
  Read Only Property: Scene Root model for that scene
FBListSet  Sets
  List: Sets available in the scene.
FBListShader  Shaders
  List: Shaders for scene.
FBListTake  Takes
  List: Takes for scene.
FBListTexture  Textures
  List: Textures for scene.
FBListUserObject  UserObjects
  List: User objects
FBListVideoClip  VideoClips
  List: Video clips in scene.

Constructor & Destructor Documentation

FBScene (  ) 

Constructor.

Client code cannot instantiate objects of this class. The FBSystem class provides access to the current scene object.


Member Function Documentation

K_DEPRECATED void Clear (  ) 

Clear the elements part of the scene.

Not those that belong to all the scenes. Deprecated. Use FBApplication::FileNew() instead.

bool Evaluate (  ) 

Evaluate the scene.

Returns:
true if successful.

bool EvaluateDeformations (  ) 

Evaluate the deformations of the scene.

Returns:
true if successful.

FBDelete (  ) 

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

Reimplemented from FBComponent.


Member Data Documentation

FBListActorFace ActorFaces

List: ActorFaces in scene.

FBListActor Actors

List: Actors in scene.

FBListAudioClip AudioClips

List: Audio clips in scene.

FBListCamera Cameras

List: Cameras in scene.

FBListCharacterExtension CharacterExtensions

List: Character extensions available in the scene.

FBListCharacterFace CharacterFaces

List: Character faces in scene.

FBListCharacterPose CharacterPoses

List: Character poses in scene.

FBListCharacter Characters

List: Characters in scene.

FBListComponent Components

List: Generic List of components.

Reimplemented from FBComponent.

FBListConstraintSolver ConstraintSolvers

List: Constraint Solvers present in the scene.

FBListConstraint Constraints

List: Constraints in scene.

FBListControlSet ControlSets

List: Control set rigs in scene.

FBListDevice Devices

List: Devices for scene.

FBListFolder Folders

List: Folders in scene.

FBListGroup Groups

List: Groups available in the scene.

FBListHandle Handles

List: Handles present in the scene.

FBListLight Lights

List: Lights in scene.

FBTime LocalTime

Read Write Property: Local time in the scene.

FBListMarkerSet MarkerSets

List: Marker sets in scene.

FBListMaterial Materials

List: Materials for scene.

FBListMotionClip MotionClips

List: Motion clips in scene.

FBListNote Notes

List: Notes in scene.

FBListObjectPose ObjectPoses

List: ObjectPoses in scene.

FBEvent OnChange

Event: Something in the scene has happened.(FBEventSceneChange)

FBEvent OnTakeChange

Event: Something related to a take has happened.(FBEventTakeChange)

FBListPhysicalProperties PhysicalProperties

List: PhysicalProperties present in the scene.

FBListPose Poses

List: Poses in scene.

FBRenderer Renderer

Read Only Property: Local renderer

FBModel RootModel

Read Only Property: Scene Root model for that scene

FBListSet Sets

List: Sets available in the scene.

FBListShader Shaders

List: Shaders for scene.

FBListTake Takes

List: Takes for scene.

FBListTexture Textures

List: Textures for scene.

FBListUserObject UserObjects

List: User objects

FBListVideoClip VideoClips

List: Video clips in scene.


Generated on Tue Feb 9 19:34:35 2010 for Python Reference Guide by  doxygen 1.5.3