OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::MaterialSerializer::Listener Class Reference

Class that allows listening in on the various stages of material serialization process. More...

#include <OgreMaterialSerializer.h>

+ Inheritance diagram for Ogre::MaterialSerializer::Listener:

Public Member Functions

virtual ~Listener ()
 
void gpuProgramRefEventRaised (MaterialSerializer *ser, SerializeEvent event, bool &skip, const String &attrib, const GpuProgramPtr &program, const GpuProgramParametersSharedPtr &params, GpuProgramParameters *defaultParams)
 Called when GPU program reference section event raised. More...
 
virtual void materialEventRaised (MaterialSerializer *ser, SerializeEvent event, bool &skip, const Material *mat)
 Called when material section event raised. More...
 
virtual void passEventRaised (MaterialSerializer *ser, SerializeEvent event, bool &skip, const Pass *pass)
 Called when pass section event raised. More...
 
virtual void techniqueEventRaised (MaterialSerializer *ser, SerializeEvent event, bool &skip, const Technique *tech)
 Called when technique section event raised. More...
 
virtual void textureUnitStateEventRaised (MaterialSerializer *ser, SerializeEvent event, bool &skip, const TextureUnitState *textureUnit)
 Called when texture unit state section event raised. More...
 

Detailed Description

Class that allows listening in on the various stages of material serialization process.

Sub-classing it enable extending the attribute set of any part in the material.

Definition at line 118 of file OgreMaterialSerializer.h.

Constructor & Destructor Documentation

virtual Ogre::MaterialSerializer::Listener::~Listener ( )
inlinevirtual

Definition at line 121 of file OgreMaterialSerializer.h.

Member Function Documentation

void Ogre::MaterialSerializer::Listener::gpuProgramRefEventRaised ( MaterialSerializer ser,
SerializeEvent  event,
bool &  skip,
const String attrib,
const GpuProgramPtr program,
const GpuProgramParametersSharedPtr params,
GpuProgramParameters defaultParams 
)
inline

Called when GPU program reference section event raised.

Parameters
serThe MaterialSerializer instance that writes the given material.
eventThe current section writing stage.
skipMay set to true by sub-class instances in order to skip the following section write. This parameter relevant only when stage equals MSE_PRE_WRITE.
attribThe GPU program reference description (vertex_program_ref, fragment_program_ref, etc).
programThe program being written.
paramsThe program parameters.
defaultParamsThe default program parameters.

Definition at line 166 of file OgreMaterialSerializer.h.

virtual void Ogre::MaterialSerializer::Listener::materialEventRaised ( MaterialSerializer ser,
SerializeEvent  event,
bool &  skip,
const Material mat 
)
inlinevirtual

Called when material section event raised.

Parameters
serThe MaterialSerializer instance that writes the given material.
eventThe current section writing stage.
skipMay set to true by sub-class instances in order to skip the following section write. This parameter relevant only when stage equals MSE_PRE_WRITE.
matThe material that is being written.

Reimplemented in Ogre::RTShader::SGMaterialSerializerListener.

Definition at line 130 of file OgreMaterialSerializer.h.

virtual void Ogre::MaterialSerializer::Listener::passEventRaised ( MaterialSerializer ser,
SerializeEvent  event,
bool &  skip,
const Pass pass 
)
inlinevirtual

Called when pass section event raised.

Parameters
serThe MaterialSerializer instance that writes the given material.
eventThe current section writing stage.
skipMay set to true by sub-class instances in order to skip the following section write. This parameter relevant only when stage equals MSE_PRE_WRITE.
passThe pass that is being written.

Reimplemented in Ogre::RTShader::SGMaterialSerializerListener.

Definition at line 152 of file OgreMaterialSerializer.h.

virtual void Ogre::MaterialSerializer::Listener::techniqueEventRaised ( MaterialSerializer ser,
SerializeEvent  event,
bool &  skip,
const Technique tech 
)
inlinevirtual

Called when technique section event raised.

Parameters
serThe MaterialSerializer instance that writes the given material.
eventThe current section writing stage.
skipMay set to true by sub-class instances in order to skip the following section write. This parameter relevant only when stage equals MSE_PRE_WRITE.
techThe technique that is being written.

Reimplemented in Ogre::RTShader::SGMaterialSerializerListener.

Definition at line 141 of file OgreMaterialSerializer.h.

virtual void Ogre::MaterialSerializer::Listener::textureUnitStateEventRaised ( MaterialSerializer ser,
SerializeEvent  event,
bool &  skip,
const TextureUnitState textureUnit 
)
inlinevirtual

Called when texture unit state section event raised.

Parameters
serThe MaterialSerializer instance that writes the given material.
eventThe current section writing stage.
skipMay set to true by sub-class instances in order to skip the following section write. This parameter relevant only when stage equals MSE_PRE_WRITE.
textureUnitThe texture unit state that is being written.

Reimplemented in Ogre::RTShader::SGMaterialSerializerListener.

Definition at line 189 of file OgreMaterialSerializer.h.


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