CSLCOLLADAScene Class Reference

#include <COLLADAScene.h>

Inheritance diagram for CSLCOLLADAScene:

CSLScene List of all members.

Public Member Functions
virtual SI_Error  Fix ()
virtual SI_Error  Synchronize ()
virtual SI_Error  Write ()
virtual SI_Error  Write (SI_Char *in_szFileName, bool in_bSynchronize=true)
virtual CSLImageLibrary *  CreateImageLibrary ()
virtual CSLEnvelopeList *  CreateEnvelopeList ()
void  AddExtra (CCOLLADATemplate *in_pExtra)
CSLCOLLADALibrary *  GetLibrary (const SI_Char *in_szLibrarySuffix)
SI_Void  ExportExtra (bool in_bExtra)
bool  ExportExtra ()
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)
CCOLLADATemplate *  GetRootTemplate ()

Detailed Description

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]

Cleans invalid data from the template.

Returns:
Success/failure

Reimplemented from CSLScene.

virtual SI_Error Synchronize (  )  [virtual]

Ensures that the animated parameter is up to date.

Returns:
Success/failure

Reimplemented from CSLScene.

virtual SI_Error Write (  )  [virtual]

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

Returns:
Success/failure

virtual SI_Error Write ( SI_Char *  in_szFileName,
bool  in_bSynchronize = true  
) [virtual]

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

Parameters:
[in]  in_szFileName  File to create.
[in]  in_bSynchronize  True to synchronize all data within the Crosswalk SDK
Returns:
Success/failure

Reimplemented from CSLScene.

virtual CSLImageLibrary* CreateImageLibrary (  )  [virtual]

Creates an image library

Returns:
The new image library

Reimplemented from CSLScene.

virtual CSLEnvelopeList* CreateEnvelopeList (  )  [virtual]

Creates an envelope list

Returns:
The new envelope list

Reimplemented from CSLScene.

void AddExtra ( CCOLLADATemplate *  in_pExtra  ) 

Adds a template to the extra list

Parameters:
[in]  in_pExtra  Template to add

CSLCOLLADALibrary* GetLibrary ( const SI_Char *  in_szLibrarySuffix  ) 

Returns a named COLLADA library

Parameters:
[in]  in_szLibrarySuffix  Name of library to retrieve. See the main CSLCOLLADALibrary reference page for a list of valid values
Returns:
Requested library

SI_Void ExportExtra ( bool  in_bExtra  )  [inline]

Sets whether or not to export extra templates

Parameters:
[in]  in_bExtra  True to export extras

bool ExportExtra (  )  [inline]

Returns whether or not to export extra templates

Return values:
true  to export extras
false  otherwise

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

Generates a unique ID for an object and instantiates an element for it in the scene

Parameters:
[in]  in_pNode  Element to instantiate
[in]  in_pLib  Library to associate with this instance
[in]  in_szLibSuffix  Type of associated library. See the main CSLCOLLADALibrary reference page for a list of valid values

SI_Void InstanciateScene ( CCOLLADATemplate *  in_pScene  ) 

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

Parameters:
[in]  in_pScene  Scene to instantiate

CCOLLADATemplate* GetInstanciatedSceneTemplate (  ) 

Returns the instantiated scene template

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

Changes an existing instantiated element to another library and URL (useful for controllers)

Parameters:
[in]  in_szNodeID  Element ID to search for
[in]  in_szNewLib  Name of library to switch to
[in]  in_szNewURL  Name of URL to switch to
Returns:
Success/failure

virtual CSLCOLLADAEffectLibrary* GetEffectLibrary (  )  [virtual]

Returns the Effect Library object associated with this scene.

Returns:
The Effect Library object

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

Connects an existing CSLEffectLibrary object to the scene

Parameters:
[in]  in_pNewEffectLibrary  The new Effect Library
Returns:
The old Effect Library

CCOLLADATemplate* GetRootTemplate (  )  [inline]

Returns the CCOLLADA template that corresponds to the root COLLADA xml elements

Returns:
The root COLLADA xml elements

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