This reference page is linked to from the following overview topics: FBX SDK 2012, Supported Scene Elements, Information and Technical Support, Your First FBX SDK Program, Importing a Scene, Exporting a Scene, Managing Memory with the FBX SDK Manager, FBX Objects, FBX Properties, Connections, FBX Scenes, Merging Two Scenes, FBX Nodes, Transformation Data, Lights, Animation classes and their interrelationships, List of Python FBX classes.

Detailed Description

This class contains the description of a 3D scene.

It contains the nodes (including the root node) (KFbxNode), materials, textures, videos, gobos, poses, characters, character poses, control set plugs, generic nodes, scene information, global settings, and a global evaluator. The nodes are structured in a tree under the scene's root node.

When an object is created using the FBX SDK, a scene is usually passed as argument to the object creation function to specify that the object belongs to this scene. At this point, a connection is made with the object as source and the scene as destination.

All objects in the scene can be queried by connection index. In addition, generic nodes, materials, and textures can also be queried by name. In this latter case, the first object with the queried name will be returned.

The global evaluator (KFbxAnimEvaluator) is used to compute animation values for animated scenes.

Examples:: Animation/main.cxx, Common/AnimationUtility.cxx, Common/AnimationUtility.h, Common/Common.cxx, Common/Common.h, Common/GeometryUtility.cxx, Common/GeometryUtility.h, ConvertScene/main.cxx, ExportScene01/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, ExportScene05/main.cxx, ImportScene/DisplayAnimation.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayHierarchy.cxx, ImportScene/DisplayPose.cxx, ImportScene/main.cxx, Instances/main.cxx, Layers/main.cxx, MyOwnWriterReader/MyOwnReader.cxx, MyOwnWriterReader/MyOwnWriter.cxx, MyOwnWriterReader/MyOwnWriter.h, Normals/main.cxx, Pivot/main.cxx, ProceduralTexture/main.cxx, StereoCamera/main.cxx, SwitchBinding/main.cxx, Transformations/main.cxx, UIExamples/Common/ImportExport.cxx, UIExamples/Common/ImportExport.h, UIExamples/CubeCreator/SDK_Utility.cxx, UIExamples/CubeCreator/SDK_Utility.h, UIExamples/CubeCreator/UI.cxx, UIExamples/SceneTreeView/SDK_Utility.cxx, UIExamples/SceneTreeView/SDK_Utility.h, UIExamples/SceneTreeView/UI.cxx, UserProperties/main.cxx, UVSample/main.cxx, ViewScene/DrawScene.cxx, ViewScene/DrawScene.h, ViewScene/InitScene.cxx, ViewScene/InitScene.h, ViewScene/main.cxx, ViewScene/SetCamera.cxx, ViewScene/SetCamera.h, ViewScene/Texture.cxx, and ViewScene/Texture.h.

Definition at line 82 of file kfbxscene.h.

#include <kfbxscene.h>

Inheritance diagram for KFbxScene:

[legend]

List of all members.

Public Member Functions
K_DEPRECATED void	FillNodeArray (KArrayTemplate< KFbxNode * > &pNodeArray)
void	FillPoseArray (KArrayTemplate< KFbxPose * > &pPoseArray)
	Clear then fill a pose array with all existing pose included in the scene.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
void	ConnectMaterials ()
void	BuildMaterialLayersDirectArray ()
void	ReindexMaterialConnections ()
KSet *	AddTakeTimeWarpSet (char *pTakeName)
KSet *	GetTakeTimeWarpSet (char *pTakeName)
void	ForceKill ()
void	ConvertNurbsSurfaceToNurb ()
void	ConvertMeshNormals ()
void	ConvertNurbCurvesToNulls ()
void	ConnectTextures ()
void	BuildTextureLayersDirectArray ()
void	FixInheritType (KFbxNode *pNode)
void	UpdateScaleCompensate (KFbxNode *pNode, KFbxIOSettings &pIOS)
	Recursively convert transform inherit type from eINHERIT_Rrs to eINHERIT_RSrs by compensating object scale.
kFbxClassId	ConvertAttributeTypeToClassID (KFbxNodeAttribute::EAttributeType pAttributeType)
KFbxGlobalLightSettings &	GlobalLightSettings ()
	Internally used by the FBX version 6.x and earlier readers/writers.
KFbxGlobalCameraSettings &	GlobalCameraSettings ()
	Internally used by the FBX version 6.x and earlier readers/writers.
KFbxGlobalTimeSettings &	GlobalTimeSettings ()
	Internally used by the FBX version 6.x and earlier readers/writers.
Friends
class	KFbxLayerContainer
class	KFbxNodeFinderDuplicateName
Clear scene
void	Clear ()
	Delete the node tree below the root node and restore default settings.
Node Tree Access
KFbxNode *	GetRootNode () const
	Get the root node of the scene.
Texture Material and Video Access
void	FillTextureArray (KArrayTemplate< KFbxTexture * > &pTextureArray)
	Clear, then fill, a texture array with all existing textures included in the scene.
void	FillMaterialArray (KArrayTemplate< KFbxSurfaceMaterial * > &pMaterialArray)
	Clear, then fill, a material array with all existing materials included in the scene.
Generic Node Access
int	GetGenericNodeCount () const
	Get number of generic nodes in the scene.
KFbxGenericNode *	GetGenericNode (int pIndex)
	Get generic node at given index.
KFbxGenericNode *	GetGenericNode (char *pName)
	Access a generic node from its name.
bool	AddGenericNode (KFbxGenericNode *pGenericNode)
	Add a generic node to this scene.
bool	RemoveGenericNode (KFbxGenericNode *pGenericNode)
	Remove the generic node from this scene.
Character Management
int	GetCharacterCount () const
	Get number of characters.
KFbxCharacter *	GetCharacter (int pIndex)
	Get character at given index.
int	CreateCharacter (char *pName)
	Create a new character.
void	DestroyCharacter (int pIndex)
	Destroy character.
ControlSetPlug Management
int	GetControlSetPlugCount () const
	Get number of ControlSetPlugs.
KFbxControlSetPlug *	GetControlSetPlug (int pIndex)
	Get ControlSetPlug at given index.
int	CreateControlSetPlug (char *pName)
	Create a new ControlSetPlug.
void	DestroyControlSetPlug (int pIndex)
	Destroy ControlSetPlug.
Character Pose Management
int	GetCharacterPoseCount () const
	Get number of character poses.
KFbxCharacterPose *	GetCharacterPose (int pIndex)
	Get character pose at given index.
int	CreateCharacterPose (char *pName)
	Create a new character pose.
void	DestroyCharacterPose (int pIndex)
	Destroy character pose.
Pose Management
int	GetPoseCount () const
	Get number of poses.
KFbxPose *	GetPose (int pIndex)
	Get pose at given index.
bool	AddPose (KFbxPose *pPose)
	Add a pose to this scene.
bool	RemovePose (KFbxPose *pPose)
	Remove the specified pose from the scene.
bool	RemovePose (int pIndex)
	Remove the pose at the given index from the scene.
Scene information
KFbxDocumentInfo *	GetSceneInfo ()
	Get the scene information.
void	SetSceneInfo (KFbxDocumentInfo *pSceneInfo)
	Set the scene information.
Global Settings
KFbxGlobalSettings &	GetGlobalSettings ()
	Access global settings.
const KFbxGlobalSettings &	GetGlobalSettings () const
	Const access to global settings.
Global Evaluator
The global evaluator is used to compute animation values for animated scenes.A typical usage would be to compute the global transform matrix of a node `lNode` at a given time `lTime`. KFbxXMatrix& lGlobalMatrix = lNode->GetScene()->GetEvaluator()->GetNodeGlobalTransform(lNode, lTime); or the exact equivalent: KFbxXMatrix& lGlobalMatrix = lNode->EvaluateGlobalTransform(lTime); The user can create one or more evaluators in the scene. The default evaluator is set using SetEvaluator. When GetEvaluator is called, if the scene has no evaluator, an evaluator is created with default values.
void	SetEvaluator (KFbxAnimEvaluator *pEvaluator)
	Set the global evaluator used by this scene evaluation engine.
KFbxAnimEvaluator *	GetEvaluator ()
	Get the global evaluator used by this scene evaluation engine.
Material Access
int	GetMaterialCount () const
	Get number of materials.
KFbxSurfaceMaterial *	GetMaterial (int pIndex)
	Get the material at the given index.
KFbxSurfaceMaterial *	GetMaterial (char *pName)
	Get the material by its name.
bool	AddMaterial (KFbxSurfaceMaterial *pMaterial)
	Add the material to this scene.
bool	RemoveMaterial (KFbxSurfaceMaterial *pMaterial)
	Remove the material from this scene.
Texture Access
int	GetTextureCount () const
	Get number of textures (type KFbxTexture).
KFbxTexture *	GetTexture (int pIndex)
	Get the texture at the given index.
KFbxTexture *	GetTexture (char *pName)
	Get the texture by its name.
bool	AddTexture (KFbxTexture *pTexture)
	Add the texture to this scene.
bool	RemoveTexture (KFbxTexture *pTexture)
	Remove the texture from this scene.
Node Access
int	GetNodeCount () const
	Get number of nodes.
KFbxNode *	GetNode (int pIndex)
	Get the node at the given index.
bool	AddNode (KFbxNode *pNode)
	Add the node to this scene.
bool	RemoveNode (KFbxNode *pNode)
	Remove the node from this scene.
int	GetCurveOnSurfaceCount ()
	Helper method for determining the number of nodes that have curves on surface attributes in the scene.
KFbxNode *	FindNodeByName (const KString &pName)
	Get the first node with this name.
Geometry Access
int	GetGeometryCount () const
	Get number of geometries.
KFbxGeometry *	GetGeometry (int pIndex)
	Get the geometry at the given index.
bool	AddGeometry (KFbxGeometry *pGeometry)
	Add the geometry to this scene.
bool	RemoveGeometry (KFbxGeometry *pGeometry)
	Remove the geometry from this scene.
Video Access
int	GetVideoCount () const
	Get number of videos.
KFbxVideo *	GetVideo (int pIndex)
	Get the video at the given index.
bool	AddVideo (KFbxVideo *pVideo)
	Add the video to this scene.
bool	RemoveVideo (KFbxVideo *pVideo)
	Remove the video from this scene.
Utilities
void	SyncShowPropertyForInstance ()
	Synchronize all the Show properties of node instances.

Member Function Documentation

void Clear ( ) [virtual]

void UpdateScaleCompensate	(	KFbxNode *	pNode,
		KFbxIOSettings &	pIOS
	)

pNode	Root node. Conversion will traverse its children recursively.
pIOS	The IO options.

KFbxScene Class Reference

Detailed Description

Public Member Functions

Friends

Clear scene

Node Tree Access

Texture Material and Video Access

Generic Node Access

Character Management

ControlSetPlug Management

Character Pose Management

Pose Management

Scene information

Global Settings

Global Evaluator

Material Access

Texture Access

Node Access

Geometry Access

Video Access

Utilities

Member Function Documentation

Friends And Related Function Documentation