This reference page is linked to from the following overview topics: MotionBuilder 2013, 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.

    myScene = FBSystem().Scene

See also the C++ code sample in toolscene.

Definition at line 276 of file fbscene.h.

#include <fbscene.h>

Inheritance diagram for FBScene:

[legend]

List of all members.

Public Member Functions
	FBScene (HIObject pObject)
	Constructor.
virtual void	FBDelete ()
	Virtual FBDelete function.
void	Clear ()
	Clears the elements part of the scene.
bool	Evaluate ()
	Evaluate the scene.
bool	CandidateEvaluationAndResolve ()
	Resolving the Candidate.
bool	EvaluateDeformations ()
	Evaluate the deformations of the scene.
Namespace Management
int	NamespaceGetChildrenList (FBStringList &pNamespaceList, const char *pNamespace=NULL, bool pRecursive=true)
	Get list of children namespaces in the given namespace.
HFBNamespace	NamespaceGet (const char *pNamespace)
	Get Namespace object.
bool	NamespaceExist (const char *pNamespace)
	Query if namespace exists.
bool	NamespaceEmpty (const char *pNamespace)
	Query if namespace is empty.
void	NamespaceGetContentList (FBComponentList &pContentList, const char *pNamespace, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
	Get List of the namespace content.
void	NamespaceSelectContent (const char *pNamespace, bool pSelect, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
	Select the namespace content.
bool	NamespaceRename (const char pNameSpace, const char pNewNamespace, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
	Rename the namespace.
bool	NamespaceDelete (const char *pNamespace)
	Delete the namespace & all its content.
bool	NamespaceDeleteContent (const char *pNamespace, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
	Delete the namespace content.
bool	NamespaceImport (const char pNamespace, const char pFilePath)
	Import file into Namespace.
bool	NamespaceImportToMultiple (const FBStringList &pDstNamespaceList, const char *pFilePath)
	Import file into multiple Namespaces.
bool	NamespaceExport (const char pNamespace, const char pFilePath, bool pASCIIFormat=false)
	Export scene content within namespace to file.
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.
FBPropertyListNamespace	Namespaces
	List: Namespace available in the scene
FBPropertyListHandle	Handles
	List: Handles present in the scene.
FBPropertyListHUD	HUDs
	Read Only Property: Heads Up Displays in the scene.
FBPropertyListConstraintSolver	ConstraintSolvers
	List: Constraint Solvers present in the scene.
FBPropertyListPhysicalProperties	PhysicalProperties
	List: PhysicalProperties present in the scene.
FBPropertyString	FilePath
	Read Write Property: File path of 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]

int NamespaceGetChildrenList	(	FBStringList &	pNamespaceList,
		const char *	pNamespace = `NULL`,
		bool	pRecursive = `true`
	)

pNamespaceList	the list of namespace to return.
pNamespace	specify the parent namespace, NULL mean for the whole scene.
pRecursive	True only work on the direct children level namespace, otherwise will work on the whole children namespace hierarchy recursively.

void NamespaceGetContentList	(	FBComponentList &	pContentList,
		const char *	pNamespace,
		FBPlugModificationFlag	pModificationFlags = `kFBPlugAllContent`,
		bool	pRecursive = `true`,
		int	pTypeInfo = `FBPlug::TypeInfo`,
		bool	pExactTypeMatch = `false`
	)

pContentList	the list of content to return.
pNamespace	the namespace to work on
pModificationFlags	bitwise combination of kFBConnectionSrcObjectModified, kFBConnectionDstObjectModified, kFBConnectionSrcPropertyModified, kFBConnectionDstPropertyModified flags. kFBPlugAllContent means all the content.
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).

void NamespaceSelectContent	(	const char *	pNamespace,
		bool	pSelect,
		FBPlugModificationFlag	pModificationFlags = `kFBPlugAllContent`,
		bool	pRecursive = `true`,
		int	pTypeInfo = `FBPlug::TypeInfo`,
		bool	pExactTypeMatch = `false`
	)

pNamespace	the namespace to work on
pSelect	True (or False) indicate to select (or unselect)
pModificationFlags	bitwise combination of kFBConnectionSrcObjectModified, kFBConnectionDstObjectModified, kFBConnectionSrcPropertyModified, kFBConnectionDstPropertyModified flags. kFBPlugAllContent means all the content.
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).

bool NamespaceRename	(	const char *	pNameSpace,
		const char *	pNewNamespace,
		bool	pRecursive = `true`,
		int	pTypeInfo = `FBPlug::TypeInfo`,
		bool	pExactTypeMatch = `false`
	)

pNamespace	the namespace to work on
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).

bool NamespaceDeleteContent	(	const char *	pNamespace,
		FBPlugModificationFlag	pModificationFlags = `kFBPlugAllContent`,
		bool	pRecursive = `true`,
		int	pTypeInfo = `FBPlug::TypeInfo`,
		bool	pExactTypeMatch = `false`
	)

bool NamespaceImport	(	const char *	pNamespace,
		const char *	pFilePath
	)

pNamespace	the namespace to import to, must be in editable scope.
pFilePath	the referenced file path to import.

pDstNamespaceList	the Dst namespaces list to import, must not exist or be self contained.
pFilePath	the referenced file path to import.

pNamespace	the namespace to use, must exist
pFilePath	the referenced file path to export.
pASCIIFormat	save the file in ASCII format.

bool NamespaceImportToMultiple	(	const FBStringList &	pDstNamespaceList,
		const char *	pFilePath
	)

bool NamespaceExport	(	const char *	pNamespace,
		const char *	pFilePath,
		bool	pASCIIFormat = `false`
	)

FBScene Class Reference

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation