CSLCOLLADAScene Class Reference



Your Ad Here

#include <COLLADAScene.h>

Inheritance diagram for CSLCOLLADAScene:

CSLScene List of all members.

Public Member Functions

virtual SI_Error  Fix ()
virtual SI_Error  Write ()
virtual SI_Error  Write (SI_Char *in_szFileName)
virtual CSLImageLibrary CreateImageLibrary ()
virtual CSLEnvelopeList CreateEnvelopeList ()
void  AddExtra (CCOLLADATemplate *in_pExtra)
CSLCOLLADALibrary GetLibrary (const SI_Char *in_szLibrarySuffix)
SI_Void  ExportExtra (bool in_bExtra)
SI_Void  GenerateIDAndInstanciate (CCOLLADATemplate *in_pNode, CCOLLADATemplate *in_pLib, const SI_Char *in_szLibSuffix)
SI_Void  InstanciateScene (CCOLLADATemplate *in_pScene)
CCOLLADATemplate *  GetInstanciatedSceneTemplate ()
SI_Bool  ChangeNodeInstanciation (SI_Char *in_szNodeID, SI_Char *in_szNewLib, SI_Char *in_szNewURL)
virtual CSLCOLLADAEffectLibrary *  GetEffectLibrary ()
virtual CSLCOLLADAEffectLibrary *  ConnectEffectLibrary (CSLCOLLADAEffectLibrary *in_pNewEffectLibrary)

Detailed Description

CSLCOLLADAScene Class

This is the top level object for a dotXSI abstraction using the SemanticLayer. From this class, you can access all the models, primitives, material etc. contained in the dotXSI.


Member Function Documentation

virtual SI_Error Fix (  )  [virtual]

CSLTemplate overrides

Reimplemented from CSLScene.

virtual SI_Error Write (  )  [virtual]

Write a dotXSI file containing the data present in the semantic layer.

Returns:
SI_Error Error code.

Reimplemented from CSLScene.

virtual SI_Error Write ( SI_Char *  in_szFileName  )  [virtual]

Write a dotXSI file containing the data present in the semantic layer.

Parameters:
SI_Char*  File to create.
Returns:
SI_Error Error code.

Reimplemented from CSLScene.

virtual CSLImageLibrary* CreateImageLibrary (  )  [virtual]

Creation of an Image Library

Returns:
CSLImageLibrary*
Note:
Introduced in 3.6

Reimplemented from CSLScene.

virtual CSLEnvelopeList* CreateEnvelopeList (  )  [virtual]

Creation of envelope list

Returns:
CSLEnvelopeList*

Reimplemented from CSLScene.

void AddExtra ( CCOLLADATemplate *  in_pExtra  ) 

Adds a template to the extra list

CSLCOLLADALibrary* GetLibrary ( const SI_Char *  in_szLibrarySuffix  ) 

Returns a named COLLADA library

SI_Void ExportExtra ( bool  in_bExtra  )  [inline]

Sets wether to export extra templates or not

SI_Void GenerateIDAndInstanciate ( CCOLLADATemplate *  in_pNode,
CCOLLADATemplate *  in_pLib,
const SI_Char *  in_szLibSuffix  
)

Generates a unique ID for an object and instanciate a node in the scene

SI_Void InstanciateScene ( CCOLLADATemplate *  in_pScene  ) 

Generates a unique ID for a scene and instanciate the visual scene in the scene template

CCOLLADATemplate* GetInstanciatedSceneTemplate (  ) 

Returns the instanciated scene template()

SI_Bool ChangeNodeInstanciation ( SI_Char *  in_szNodeID,
SI_Char *  in_szNewLib,
SI_Char *  in_szNewURL  
)

Changes an existing instanciated node to another lib and URL (useful for controllers)

virtual CSLCOLLADAEffectLibrary* GetEffectLibrary (  )  [virtual]

Gets the EffectLibrary object

Returns:
CSLCOLLADAEffectLibrary* The Effect Library object

virtual CSLCOLLADAEffectLibrary* ConnectEffectLibrary ( CSLCOLLADAEffectLibrary *  in_pNewEffectLibrary  )  [virtual]

Connect an existing CSLEffectLibrary object to the scene

Parameters:
CSLCOLLADAEffectLibrary*  The new CSLCOLLADAEffectLibrary
Returns:
CSLCOLLADAEffectLibrary* The old CSLCOLLADAEffectLibrary


The documentation for this class was generated from the following file:

Return to Softimage XSI Index


Your Ad Here