CSLGlobalMaterial Class Reference

This class represents an SI_GlobalMaterial template. More...

#include <GlobalMaterial.h>

Inheritance diagram for CSLGlobalMaterial:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EPropagationType {
  SI_BRANCH,
  SI_NODE,
  SI_INHERITED
}
  Defines the various propagation types. More...

Public Member Functions
  CSLGlobalMaterial (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
  ~CSLGlobalMaterial ()
  Destructor.
CSLBaseMaterial *  GetMaterial ()
CSIBCString  GetMaterialName ()
SI_Void  SetMaterial (CSLBaseMaterial *in_pNewMaterial)
SI_Void  SetMaterialName (const CSIBCString &in_szNewMaterialName)
EPropagationType  GetPropagationType ()
SI_Void  SetPropagationType (EPropagationType in_PropagationType)
CSLTemplate::ETemplateType  Type ()
SI_Error  Synchronize ()

Detailed Description

This class represents an SI_GlobalMaterial template.

Identifies the global material of a model (see the SI_GlobalMaterial template reference).

Member Enumeration Documentation

enum EPropagationType

Defines the various propagation types.

Enumerator:
SI_BRANCH  Branch propagation
SI_NODE  Node propagation
SI_INHERITED  Inherited propagation

Constructor & Destructor Documentation

CSLGlobalMaterial ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Note:
If the file contains an invalid propagation type, NODE is assumed.
Parameters:
[in]  in_pScene  Parent Scene
[in]  in_pModel  Parent Model
[in]  in_pTemplate  Parent Template
Returns:
an instance of CSLGlobalMaterial

Member Function Documentation

CSLBaseMaterial* GetMaterial (  ) 

Returns the referenced material

Returns:
Pointer to referenced material or null if there's none

CSIBCString GetMaterialName (  ) 

Returns the referenced material name

Returns:
The name of the referenced material or an empty string if there's none

SI_Void SetMaterial ( CSLBaseMaterial *  in_pNewMaterial  ) 

Sets the referenced material

Parameters:
[in]  in_pNewMaterial  Pointer to new refered material.

SI_Void SetMaterialName ( const CSIBCString &  in_szNewMaterialName  ) 

Sets the referenced material name. Should ONLY be called if we don't export the material.

Parameters:
[in]  in_szNewMaterialName  The new refered material name.

EPropagationType GetPropagationType (  ) 

Returns the propagation type

Returns:
The propagation type

SI_Void SetPropagationType ( EPropagationType  in_PropagationType  ) 

Sets the propagation type

Parameters:
[in]  in_PropagationType  New type of propagation tp use

CSLTemplate::ETemplateType Type (  )  [virtual]

Returns the type of this template

Return values:
CSLTemplate::SI_GLOBAL_MATERIAL  The type of this template

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Synchronize with the parent template data

Returns:
Whether or not data could be updated

Reimplemented from CSLTemplate.

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