CSLGlobalMaterial Class Reference

Identifies the global material of a model. 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)
  Constructor.
  ~CSLGlobalMaterial ()
  Destructor.
CSLBaseMaterial *  GetMaterial ()
  Get the referenced material.
CSIBCString  GetMaterialName ()
  Get the referenced material name.
SI_Void  SetMaterial (CSLBaseMaterial *in_pNewMaterial)
  Set the referenced material.
SI_Void  SetMaterialName (const CSIBCString &in_szNewMaterialName)
  Set the referenced material name. Should ONLY be called if we don't export the material.
EPropagationType  GetPropagationType ()
  Get the propagation type.
SI_Void  SetPropagationType (EPropagationType in_PropagationType)
  Set the propagation type.
CSLTemplate::ETemplateType  Type ()
  Returns the type of this template (GLOBAL_MATERIAL).
SI_Error  Synchronize ()
  Synchronize with the parent template data.

Detailed Description

Identifies the global material of a model.

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.

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

Member Function Documentation

CSLBaseMaterial* GetMaterial (  ) 

Get the referenced material.

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

CSIBCString GetMaterialName (  ) 

Get the referenced material name.

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

SI_Void SetMaterial ( CSLBaseMaterial *  in_pNewMaterial  ) 

Set the referenced material.

Parameters:
in_pNewMaterial  Pointer to new refered material.

SI_Void SetMaterialName ( const CSIBCString &  in_szNewMaterialName  ) 

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

Parameters:
in_szNewMaterialName  The new refered material name.

EPropagationType GetPropagationType (  ) 

Get the propagation type.

Returns:
EPropagationType The propagation type

SI_Void SetPropagationType ( EPropagationType  in_PropagationType  ) 

Set the propagation type.

Parameters:
in_PropagationType  New type of propagation tp use

CSLTemplate::ETemplateType Type (  )  [virtual]

Returns the type of this template (GLOBAL_MATERIAL).

CSLTemplate::ETemplateType The type of this template (GLOBAL_MATERIAL)

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Synchronize with the parent template data.

Returns:
SI_Error Whether or not data could be updated

Reimplemented from CSLTemplate.

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