CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

csMaterialWrapper Class Reference

csMaterialWrapper represents a texture and its link to the iMaterialHandle as returned by iTextureManager. More...

#include <material.h>

Inheritance diagram for csMaterialWrapper:

csObject iObject iBase List of all members.

Public Methods

 csMaterialWrapper (iMaterial *Image)
 Construct a material handle given a material. More...

 csMaterialWrapper (iMaterialHandle *ith)
 Construct a csMaterialWrapper from a pre-registered material handle. More...

 csMaterialWrapper (csMaterialWrapper &)
 Copy constructor. More...

void SetMaterialHandle (iMaterialHandle *mat)
 Change the material handle. More...

iMaterialHandleGetMaterialHandle ()
 Get the material handle. More...

void SetMaterial (iMaterial *material)
 Change the base material. More...

iMaterialGetMaterial ()
 Get the original material. More...

void Register (iTextureManager *txtmng)
 Register the material with the texture manager. More...

void Visit ()
 Visit this material. More...


Detailed Description

csMaterialWrapper represents a texture and its link to the iMaterialHandle as returned by iTextureManager.

Definition at line 173 of file csengine/material.h.


Constructor & Destructor Documentation

csMaterialWrapper::csMaterialWrapper iMaterial   Image
 

Construct a material handle given a material.

csMaterialWrapper::csMaterialWrapper iMaterialHandle   ith
 

Construct a csMaterialWrapper from a pre-registered material handle.

csMaterialWrapper::csMaterialWrapper csMaterialWrapper &   
 

Copy constructor.


Member Function Documentation

iMaterial* csMaterialWrapper::GetMaterial   [inline]
 

Get the original material.

Definition at line 207 of file csengine/material.h.

iMaterialHandle* csMaterialWrapper::GetMaterialHandle   [inline]
 

Get the material handle.

Definition at line 199 of file csengine/material.h.

void csMaterialWrapper::Register iTextureManager   txtmng
 

Register the material with the texture manager.

void csMaterialWrapper::SetMaterial iMaterial   material
 

Change the base material.

Note: The changes will not be visible until you re-register the material.

void csMaterialWrapper::SetMaterialHandle iMaterialHandle   mat
 

Change the material handle.

Note: This will also change the base material to NULL.

void csMaterialWrapper::Visit  
 

Visit this material.

This should be called by the engine right before using the material. It will call Visit() on all textures that are used.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14