Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::Quake3Shader Class Reference

Class for recording Quake3 shaders. More...

#include <OgreQuake3Shader.h>

Inheritance diagram for Ogre::Quake3Shader:

Ogre::Resource List of all members.

Public Methods

 Quake3Shader (String name)
 Default constructor - used by Quake3ShaderManager (do not call directly). More...

 ~Quake3Shader ()
virtual void load (void)
 Generic load - called by Quake3ShaderManager. More...

virtual void unload (void)
 Generic unload - called by Quake3ShaderManager. More...

MaterialcreateAsMaterial (SceneManager *sm, int lightmapNumber)
 Creates this shader as an OGRE material. More...

virtual size_t getSize (void)
 Retrieves info about the size of the resource. More...

void touch (void)
 'Touches' the resource to indicate it has been used. More...

time_t getLastAccess (void) const
 Gets the last time the resource was 'touched'. More...

const StringgetName (void) const
 Gets resource name. More...

bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...

virtual void destroy ()
 A method to make the resource delete itself. More...


Public Attributes

unsigned int flags
int numPasses
Pass pass [6]
bool farbox
String farboxName
bool skyDome
Real cloudHeight
DeformFunc deformFunc
Real deformParams [5]
ManualCullingMode cullMode
bool fog
ColourValue fogColour
Real fogDistance

Protected Methods

String getAlternateName (String texName)

Protected Attributes

String mName
bool mIsLoaded
time_t mLastAccess
size_t mSize

Detailed Description

Class for recording Quake3 shaders.

This is a temporary holding area since shaders are actually converted into Material objects for use in the engine proper. However, because we have to read in shader definitions en masse (because they are stored in shared .shader files) without knowing which will actually be used, we store their definitions here temporarily since their instantiations as Materials would use precious resources because of the automatic loading of textures etc.


Constructor & Destructor Documentation

Ogre::Quake3Shader::Quake3Shader String    name
 

Default constructor - used by Quake3ShaderManager (do not call directly).

Ogre::Quake3Shader::~Quake3Shader  
 


Member Function Documentation

Material * Ogre::Quake3Shader::createAsMaterial SceneManager   sm,
int    lightmapNumber
 

Creates this shader as an OGRE material.

Creates a new material based on this shaders settings. Registers it with the SceneManager passed in. Material name shader::lightmap.

virtual void Ogre::Resource::destroy void    [inline, virtual, inherited]
 

A method to make the resource delete itself.

Note:
This exists because Resource objects could be created in other processes, and they need to be destroyed in the process that created them.

String Ogre::Quake3Shader::getAlternateName String    texName [protected]
 

time_t Ogre::Resource::getLastAccess void    const [inline, inherited]
 

Gets the last time the resource was 'touched'.

const String& Ogre::Resource::getName void    const [inline, inherited]
 

Gets resource name.

Reimplemented in Ogre::Material.

virtual size_t Ogre::Resource::getSize void    [inline, virtual, inherited]
 

Retrieves info about the size of the resource.

bool Ogre::Resource::isLoaded void    const [inline, inherited]
 

Returns true if the Resource has been loaded, false otherwise.

void Ogre::Quake3Shader::load void    [virtual]
 

Generic load - called by Quake3ShaderManager.

Implements Ogre::Resource.

void Ogre::Resource::touch void    [inline, inherited]
 

'Touches' the resource to indicate it has been used.

void Ogre::Quake3Shader::unload void    [virtual]
 

Generic unload - called by Quake3ShaderManager.

Reimplemented from Ogre::Resource.


Member Data Documentation

Real Ogre::Quake3Shader::cloudHeight
 

ManualCullingMode Ogre::Quake3Shader::cullMode
 

DeformFunc Ogre::Quake3Shader::deformFunc
 

Real Ogre::Quake3Shader::deformParams[5]
 

bool Ogre::Quake3Shader::farbox
 

String Ogre::Quake3Shader::farboxName
 

unsigned int Ogre::Quake3Shader::flags
 

bool Ogre::Quake3Shader::fog
 

ColourValue Ogre::Quake3Shader::fogColour
 

Real Ogre::Quake3Shader::fogDistance
 

bool Ogre::Resource::mIsLoaded [protected, inherited]
 

time_t Ogre::Resource::mLastAccess [protected, inherited]
 

String Ogre::Resource::mName [protected, inherited]
 

size_t Ogre::Resource::mSize [protected, inherited]
 

int Ogre::Quake3Shader::numPasses
 

Pass Ogre::Quake3Shader::pass[6]
 

bool Ogre::Quake3Shader::skyDome
 

Copyright © 2002 by The OGRE Team