FBScene Class Reference

#include <fbscene.h>
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.

Definition at line 272 of file fbscene.h.


Public Member Functions

  FBScene (HIObject pObject)
  Constructor.
virtual void  FBDelete ()
  Virtual FBDelete function.
K_DEPRECATED void  Clear ()
  Clear the elements part of the scene.
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.
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.(FBEventSceneChange)
FBPropertyEvent  OnTakeChange
  Event: Something related to a take has happened.(FBEventTakeChange)

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]

Virtual FBDelete function.

Reimplemented from FBComponent.

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.

Member Data Documentation

FBPropertyListTake Takes

List: Takes for scene.

Definition at line 307 of file fbscene.h.

FBPropertyModel RootModel

Read Only Property: Scene Root model for that scene

Definition at line 308 of file fbscene.h.

FBPropertyListCamera Cameras

List: Cameras in scene.

Definition at line 309 of file fbscene.h.

FBPropertyListMaterial Materials

List: Materials for scene.

Definition at line 310 of file fbscene.h.

FBPropertyListTexture Textures

List: Textures for scene.

Definition at line 311 of file fbscene.h.

FBPropertyListShader Shaders

List: Shaders for scene.

Definition at line 312 of file fbscene.h.

FBPropertyListDevice Devices

List: Devices for scene.

Definition at line 313 of file fbscene.h.

FBPropertyListConstraint Constraints

List: Constraints in scene.

Definition at line 314 of file fbscene.h.

FBPropertyListLight Lights

List: Lights in scene.

Definition at line 316 of file fbscene.h.

FBPropertyListAudioClip AudioClips

List: Audio clips in scene.

Definition at line 318 of file fbscene.h.

FBPropertyListVideoClip VideoClips

List: Video clips in scene.

Definition at line 321 of file fbscene.h.

FBPropertyListMotionClip MotionClips

List: Motion clips in scene.

Definition at line 324 of file fbscene.h.

FBPropertyListFolder Folders

List: Folders in scene.

Definition at line 327 of file fbscene.h.

FBPropertyListNote Notes

List: Notes in scene.

Definition at line 331 of file fbscene.h.

FBPropertyListPose Poses

List: Poses in scene.

Definition at line 335 of file fbscene.h.

FBPropertyListObjectPose ObjectPoses

List: ObjectPoses in scene.

Definition at line 336 of file fbscene.h.

FBPropertyListActor Actors

List: Actors in scene.

Definition at line 340 of file fbscene.h.

FBPropertyListActorFace ActorFaces

List: ActorFaces in scene.

Definition at line 341 of file fbscene.h.

FBPropertyListMarkerSet MarkerSets

List: Marker sets in scene.

Definition at line 345 of file fbscene.h.

FBPropertyListControlSet ControlSets

List: Control set rigs in scene.

Definition at line 346 of file fbscene.h.

FBPropertyListCharacter Characters

List: Characters in scene.

Definition at line 347 of file fbscene.h.

FBPropertyListCharacterFace CharacterFaces

List: Character faces in scene.

Definition at line 348 of file fbscene.h.

FBPropertyListCharacterPose CharacterPoses

List: Character poses in scene.

Definition at line 349 of file fbscene.h.

FBPropertyListCharacterExtension CharacterExtensions

List: Character extensions available in the scene.

Definition at line 350 of file fbscene.h.

FBPropertyListUserObject UserObjects

List: User objects

Definition at line 354 of file fbscene.h.

FBPropertyProjectSettings ProjectSettings

Read Only Property: Local project settings

Definition at line 358 of file fbscene.h.

FBPropertyRenderer Renderer

Read Only Property: Local renderer

Definition at line 361 of file fbscene.h.

FBPropertyListComponent Components

List: Generic List of components.

Reimplemented from FBComponent.

Definition at line 362 of file fbscene.h.

FBPropertyListGroup Groups

List: Groups available in the scene.

Definition at line 363 of file fbscene.h.

FBPropertyListSet Sets

List: Sets available in the scene.

Definition at line 364 of file fbscene.h.

FBPropertyListHandle Handles

List: Handles present in the scene.

Definition at line 367 of file fbscene.h.

FBPropertyListConstraintSolver ConstraintSolvers

List: Constraint Solvers present in the scene.

Definition at line 370 of file fbscene.h.

FBPropertyListPhysicalProperties PhysicalProperties

List: PhysicalProperties present in the scene.

Definition at line 371 of file fbscene.h.

FBPropertyTime LocalTime

Read Write Property: Local time in the scene.

Definition at line 373 of file fbscene.h.

FBPropertyEvent OnChange

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

Definition at line 375 of file fbscene.h.

FBPropertyEvent OnTakeChange

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

Definition at line 376 of file fbscene.h.


Please send us your comments about this page.