Ogre::Material

Ogre::Material Class Reference

Class encapsulates rendering properties of an object. More...

#include <OgreMaterial.h>

Inheritance diagram for Ogre::Material:

Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector
< Real > 		LodDistanceList
 distance list used to specify LOD
typedef
ConstVectorIterator
< LodDistanceList > 		LodDistanceIterator
typedef
VectorIterator
< Techniques > 		TechniqueIterator
enum  LoadingState {
  LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING,
  LOADSTATE_PREPARED, LOADSTATE_PREPARING
}
 Enum identifying the loading state of the resource. More...

Public Member Functions

 Material (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
 Constructor - use resource manager's create method rather than this.
 ~Material ()
Material & operator= (const Material &rhs)
 Assignment operator to allow easy copying between materials.
bool isTransparent (void) const
 Determines if the material has any transparency with the rest of the scene (derived from whether any Techniques say they involve transparency).
void setReceiveShadows (bool enabled)
 Sets whether objects using this material will receive shadows.
bool getReceiveShadows (void) const
 Returns whether or not objects using this material will receive shadows.
void setTransparencyCastsShadows (bool enabled)
 Sets whether objects using this material be classified as opaque to the shadow caster system.
bool getTransparencyCastsShadows (void) const
 Returns whether or not objects using this material be classified as opaque to the shadow caster system.
Technique * createTechnique (void)
 Creates a new Technique for this Material.
Technique * getTechnique (unsigned short index)
 Gets the indexed technique.
Technique * getTechnique (const String &name)
 searches for the named technique.
unsigned short getNumTechniques (void) const
 Retrieves the number of techniques.
void removeTechnique (unsigned short index)
 Removes the technique at the given index.
void removeAllTechniques (void)
 Removes all the techniques in this Material.
TechniqueIterator getTechniqueIterator (void)
 Get an iterator over the Techniques in this Material.
TechniqueIterator getSupportedTechniqueIterator (void)
 Gets an iterator over all the Techniques which are supported by the current card.
Technique * getSupportedTechnique (unsigned short index)
 Gets the indexed supported technique.
unsigned short getNumSupportedTechniques (void) const
 Retrieves the number of supported techniques.
const String & getUnsupportedTechniquesExplanation () const
 Gets a string explaining why any techniques are not supported.
unsigned short getNumLodLevels (unsigned short schemeIndex) const
 Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex.
unsigned short getNumLodLevels (const String &schemeName) const
 Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex.
Technique * getBestTechnique (unsigned short lodIndex=0, const Renderable *rend=0)
 Gets the best supported technique.
MaterialPtr clone (const String &newName, bool changeGroup=false, const String &newGroup=StringUtil::BLANK) const
 Creates a new copy of this material with the same settings but a new name.
void copyDetailsTo (MaterialPtr &mat) const
 Copies the details of this material into another, preserving the target's handle and name (unlike operator=) but copying everything else.
void compile (bool autoManageTextureUnits=true)
 'Compiles' this Material.
void setPointSize (Real ps)
 Sets the point size properties for every Pass in every Technique.
void setAmbient (Real red, Real green, Real blue)
 Sets the ambient colour reflectance properties for every Pass in every Technique.
void setAmbient (const ColourValue &ambient)
 Sets the ambient colour reflectance properties for every Pass in every Technique.
void setDiffuse (Real red, Real green, Real blue, Real alpha)
 Sets the diffuse colour reflectance properties of every Pass in every Technique.
void setDiffuse (const ColourValue &diffuse)
 Sets the diffuse colour reflectance properties of every Pass in every Technique.
void setSpecular (Real red, Real green, Real blue, Real alpha)
 Sets the specular colour reflectance properties of every Pass in every Technique.
void setSpecular (const ColourValue &specular)
 Sets the specular colour reflectance properties of every Pass in every Technique.
void setShininess (Real val)
 Sets the shininess properties of every Pass in every Technique.
void setSelfIllumination (Real red, Real green, Real blue)
 Sets the amount of self-illumination of every Pass in every Technique.
void setSelfIllumination (const ColourValue &selfIllum)
 Sets the amount of self-illumination of every Pass in every Technique.
void setDepthCheckEnabled (bool enabled)
 Sets whether or not each Pass renders with depth-buffer checking on or not.
void setDepthWriteEnabled (bool enabled)
 Sets whether or not each Pass renders with depth-buffer writing on or not.
void setDepthFunction (CompareFunction func)
 Sets the function used to compare depth values when depth checking is on.
void setColourWriteEnabled (bool enabled)
 Sets whether or not colour buffer writing is enabled for each Pass.
void setCullingMode (CullingMode mode)
 Sets the culling mode for each pass based on the 'vertex winding'.
void setManualCullingMode (ManualCullingMode mode)
 Sets the manual culling mode, performed by CPU rather than hardware.
void setLightingEnabled (bool enabled)
 Sets whether or not dynamic lighting is enabled for every Pass.
void setShadingMode (ShadeOptions mode)
 Sets the type of light shading required.
void setFog (bool overrideScene, FogMode mode=FOG_NONE, const ColourValue &colour=ColourValue::White, Real expDensity=0.001, Real linearStart=0.0, Real linearEnd=1.0)
 Sets the fogging mode applied to each pass.
void setDepthBias (float constantBias, float slopeScaleBias)
 Sets the depth bias to be used for each Pass.
void setTextureFiltering (TextureFilterOptions filterType)
 Set texture filtering for every texture unit in every Technique and Pass.
void setTextureAnisotropy (int maxAniso)
 Sets the anisotropy level to be used for all textures.
void setSceneBlending (const SceneBlendType sbt)
 Sets the kind of blending every pass has with the existing contents of the scene.
void setSeparateSceneBlending (const SceneBlendType sbt, const SceneBlendType sbta)
 Sets the kind of blending every pass has with the existing contents of the scene, using individual factors for color and alpha channels.
void setSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor)
 Allows very fine control of blending every Pass with the existing contents of the scene.
void setSeparateSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor, const SceneBlendFactor sourceFactorAlpha, const SceneBlendFactor destFactorAlpha)
 Allows very fine control of blending every Pass with the existing contents of the scene, using individual factors for color and alpha channels.
void _notifyNeedsRecompile (void)
 Tells the material that it needs recompilation.
void setLodLevels (const LodDistanceList &lodDistances)
 Sets the distance at which level-of-detail (LOD) levels come into effect.
LodDistanceIterator getLodDistanceIterator (void) const
 Gets an iterator over the list of distances at which each LOD comes into effect.
unsigned short getLodIndex (Real d) const
 Gets the LOD index to use at the given distance.
unsigned short getLodIndexSquaredDepth (Real squaredDepth) const
 Gets the LOD index to use at the given squared distance.
void touch (void)
 'Touches' the resource to indicate it has been used.
bool applyTextureAliases (const AliasTextureNamePairList &aliasList, const bool apply=true) const
 Applies texture names to Texture Unit State with matching texture name aliases.
bool getCompilationRequired () const
 Gets the compilation status of the material.
virtual void prepare ()
 Prepares the resource for load, if it is not already.
virtual void load (bool backgroundThread=false)
 Loads the resource, if it is not already.
virtual void reload (void)
 Reloads the resource, if it is already loaded.
virtual bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise.
virtual bool isManuallyLoaded (void) const
 Is this resource manually loaded?
virtual void unload (void)
 Unloads the resource; this is not permanent, the resource can be reloaded later if required.
virtual size_t getSize (void) const
 Retrieves info about the size of the resource.
virtual const String & getName (void) const
 Gets resource name.
virtual ResourceHandle getHandle (void) const
virtual bool isPrepared (void) const
 Returns true if the Resource has been prepared, false otherwise.
virtual bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise.
virtual bool isLoading () const
 Returns whether the resource is currently in the process of background loading.
virtual LoadingState getLoadingState () const
 Returns the current loading state.
virtual bool isBackgroundLoaded (void) const
 Returns whether this Resource has been earmarked for background loading.
virtual void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not.
virtual void escalateLoading ()
 Escalates the loading of a background loaded resource.
virtual void addListener (Listener *lis)
 Register a listener on this resource.
virtual void removeListener (Listener *lis)
 Remove a listener on this resource.
virtual const String & getGroup (void)
 Gets the group which this resource is a member of.
virtual void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource.
virtual ResourceManager * getCreator (void)
 Gets the manager which created this resource.
virtual const String & getOrigin (void) const
 Get the origin of this resource, e.g.
virtual void _notifyOrigin (const String &origin)
 Notify this resource of it's origin.
virtual size_t getStateCount () const
 Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
virtual void _dirtyState ()
 Manually mark the state of this resource as having been changed.
virtual void _fireBackgroundLoadingComplete (void)
 Firing of background loading complete event.
virtual void _fireBackgroundPreparingComplete (void)
 Firing of background preparing complete event.
ParamDictionary * getParamDictionary (void)
 Retrieves the parameter dictionary for this class.
const ParamDictionary * getParamDictionary (void) const
const ParameterList & getParameters (void) const
 Retrieves a list of parameters valid for this object.
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method.
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method.
virtual String getParameter (const String &name) const
 Generic parameter retrieval method.
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object.
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
void * operator new (size_t sz)
void * operator new (size_t sz, void *ptr)
 placement operator new
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
void * operator new[] (size_t sz)
void operator delete (void *ptr)
void operator delete (void *ptr, const char *, int, const char *)
void operator delete[] (void *ptr)
void operator delete[] (void *ptr, const char *, int, const char *)

Static Public Member Functions

static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

Protected Types

typedef std::vector
< Technique * > 		Techniques
typedef std::map
< unsigned short,
Technique * > 		LodTechniques
typedef std::map
< unsigned short,
LodTechniques * > 		BestTechniquesBySchemeList
typedef std::list
< Listener * > 		ListenerList

Protected Member Functions

void applyDefaults (void)
 Internal method which sets the material up from the default settings.
void insertSupportedTechnique (Technique *t)
 Insert a supported technique into the local collections.
void clearBestTechniqueList (void)
 Clear the best technique list.
void prepareImpl (void)
 Overridden from Resource.
void unprepareImpl (void)
 Overridden from Resource.
void loadImpl (void)
 Overridden from Resource.
void unloadImpl (void)
 Unloads the material, frees resources etc.
size_t calculateSize (void) const
 Calculate the size of a resource; this will only be called after 'load'.
virtual void preLoadImpl (void)
 Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
virtual void postLoadImpl (void)
 Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
virtual void preUnloadImpl (void)
 Internal hook to perform actions before the unload process.
virtual void postUnloadImpl (void)
 Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
virtual void queueFireBackgroundLoadingComplete (void)
 Queue the firing of background loading complete event.
virtual void queueFireBackgroundPreparingComplete (void)
 Queue the firing of background preparing complete event.
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist.

Protected Attributes

Techniques mTechniques
 All techniques, supported and unsupported.
Techniques mSupportedTechniques
 Supported techniques of any sort.
BestTechniquesBySchemeList mBestTechniquesBySchemeList
 Map of scheme -> list of LOD techniques.
LodDistanceList mLodDistances
bool mReceiveShadows
bool mTransparencyCastsShadows
bool mCompilationRequired
 Does this material require compilation?
String mUnsupportedReasons
 Text description of why any techniques are not supported.
ResourceManager * mCreator
 Creator.
String mName
 Unique name of the resource.
String mGroup
 The name of the resource group.
ResourceHandle mHandle
 Numeric handle for more efficient look up than name.
AtomicScalar
< LoadingState > 		mLoadingState
 Is the resource currently loaded?
volatile bool mIsBackgroundLoaded
 Is this resource going to be background loaded? Only applicable for multithreaded.
size_t mSize
 The size of the resource in bytes.
bool mIsManual
 Is this file manually loaded?
String mOrigin
 Origin of this resource (e.g. script name) - optional.
ManualResourceLoader * mLoader
 Optional manual loader; if provided, data is loaded from here instead of a file.
size_t mStateCount
 State count, the number of times this resource has changed state.
ListenerList mListenerList
String mParamDictName
 Class name for this instance to be used as a lookup (must be initialised by subclasses).

Static Protected Attributes

static ParamDictionaryMap msDictionary
 Dictionary of parameters.

Friends

class SceneManager
class MaterialManager

Detailed Description

Class encapsulates rendering properties of an object.

Remarks:
Ogre's material class encapsulates ALL aspects of the visual appearance, of an object. It also includes other flags which might not be traditionally thought of as material properties such as culling modes and depth buffer settings, but these affect the appearance of the rendered object and are convenient to attach to the material since it keeps all the settings in one place. This is different to Direct3D which treats a material as just the colour components (diffuse, specular) and not texture maps etc. An Ogre Material can be thought of as equivalent to a 'Shader'.
A Material can be rendered in multiple different ways depending on the hardware available. You may configure a Material to use high-complexity fragment shaders, but these won't work on every card; therefore a Technique is an approach to creating the visual effect you are looking for. You are advised to create fallback techniques with lower hardware requirements if you decide to use advanced features. In addition, you also might want lower-detail techniques for distant geometry.
Each technique can be made up of multiple passes. A fixed-function pass may combine multiple texture layers using multitexrtuing, but Ogre can break that into multiple passes automatically if the active card cannot handle that many simultaneous textures. Programmable passes, however, cannot be split down automatically, so if the active graphics card cannot handle the technique which contains these passes, OGRE will try to find another technique which the card can do. If, at the end of the day, the card cannot handle any of the techniques which are listed for the material, the engine will render the geometry plain white, which should alert you to the problem.
Ogre comes configured with a number of default settings for a newly created material. These can be changed if you wish by retrieving the default material settings through SceneManager::getDefaultMaterialSettings. Any changes you make to the Material returned from this method will apply to any materials created from this point onward.

Definition at line 83 of file OgreMaterial.h.

Member Typedef Documentation

typedef std::vector<Real> Ogre::Material::LodDistanceList

distance list used to specify LOD

Definition at line 90 of file OgreMaterial.h.

typedef ConstVectorIterator<LodDistanceList> Ogre::Material::LodDistanceIterator

Definition at line 91 of file OgreMaterial.h.

typedef std::vector<Technique*> Ogre::Material::Techniques [protected]

Definition at line 99 of file OgreMaterial.h.

typedef std::map<unsigned short, Technique*> Ogre::Material::LodTechniques [protected]

Definition at line 104 of file OgreMaterial.h.

typedef std::map<unsigned short, LodTechniques*> Ogre::Material::BestTechniquesBySchemeList [protected]

Definition at line 105 of file OgreMaterial.h.

typedef VectorIterator<Techniques> Ogre::Material::TechniqueIterator

Definition at line 219 of file OgreMaterial.h.

typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited]

Definition at line 148 of file OgreResource.h.

Member Enumeration Documentation

enum Ogre::Resource::LoadingState [inherited]

Enum identifying the loading state of the resource.

Enumerator:
LOADSTATE_UNLOADED  Not loaded.
LOADSTATE_LOADING  Loading is in progress.
LOADSTATE_LOADED  Fully loaded.
LOADSTATE_UNLOADING  Currently unloading.
LOADSTATE_PREPARED  Fully prepared.
LOADSTATE_PREPARING  Preparing is in progress.

Definition at line 109 of file OgreResource.h.

Constructor & Destructor Documentation

Ogre::Material::Material ( ResourceManager *  creator,
const String &  name,
ResourceHandle  handle,
const String &  group,
bool  isManual = false,
ManualResourceLoader *  loader = 0 
)

Constructor - use resource manager's create method rather than this.

Ogre::Material::~Material (  ) 

Member Function Documentation

void Ogre::Material::applyDefaults ( void   )  [protected]

Internal method which sets the material up from the default settings.

void Ogre::Material::insertSupportedTechnique ( Technique *  t  )  [protected]

Insert a supported technique into the local collections.

void Ogre::Material::clearBestTechniqueList ( void   )  [protected]

Clear the best technique list.

void Ogre::Material::prepareImpl ( void   )  [protected, virtual]

Overridden from Resource.

Reimplemented from Ogre::Resource.

void Ogre::Material::unprepareImpl ( void   )  [protected, virtual]

Overridden from Resource.

Reimplemented from Ogre::Resource.

void Ogre::Material::loadImpl ( void   )  [protected, virtual]

Overridden from Resource.

Implements Ogre::Resource.

void Ogre::Material::unloadImpl ( void   )  [protected, virtual]

Unloads the material, frees resources etc.

See also:
Resource

Implements Ogre::Resource.

size_t Ogre::Material::calculateSize ( void   )  const [protected, virtual]

Calculate the size of a resource; this will only be called after 'load'.

Implements Ogre::Resource.

Definition at line 145 of file OgreMaterial.h.

Material& Ogre::Material::operator= ( const Material &  rhs  ) 

Assignment operator to allow easy copying between materials.

bool Ogre::Material::isTransparent ( void   )  const

Determines if the material has any transparency with the rest of the scene (derived from whether any Techniques say they involve transparency).

void Ogre::Material::setReceiveShadows ( bool  enabled  ) 

Sets whether objects using this material will receive shadows.

Remarks:
This method allows a material to opt out of receiving shadows, if it would otherwise do so. Shadows will not be cast on any objects unless the scene is set up to support shadows (
See also:
SceneManager::setShadowTechnique), and not all techniques cast shadows on all objects. In any case, if you have a need to prevent shadows being received by material, this is the method you call to do it.
Note:
Transparent materials never receive shadows despite this setting. The default is to receive shadows.

Definition at line 176 of file OgreMaterial.h.

bool Ogre::Material::getReceiveShadows ( void   )  const

Returns whether or not objects using this material will receive shadows.

Definition at line 178 of file OgreMaterial.h.

void Ogre::Material::setTransparencyCastsShadows ( bool  enabled  ) 

Sets whether objects using this material be classified as opaque to the shadow caster system.

Remarks:
This method allows a material to cast a shadow, even if it is transparent. By default, transparent materials neither cast nor receive shadows. Shadows will not be cast on any objects unless the scene is set up to support shadows (
See also:
SceneManager::setShadowTechnique), and not all techniques cast shadows on all objects.

Definition at line 188 of file OgreMaterial.h.

bool Ogre::Material::getTransparencyCastsShadows ( void   )  const

Returns whether or not objects using this material be classified as opaque to the shadow caster system.

Definition at line 190 of file OgreMaterial.h.

Technique* Ogre::Material::createTechnique ( void   ) 

Creates a new Technique for this Material.

Remarks:
A Technique is a single way of rendering geometry in order to achieve the effect you are intending in a material. There are many reason why you would want more than one - the main one being to handle variable graphics card abilities; you might have one technique which is impressive but only runs on 4th-generation graphics cards, for example. In this case you will want to create at least one fallback Technique. OGRE will work out which Techniques a card can support and pick the best one.
If multiple Techniques are available, the order in which they are created is important - the engine will consider lower-indexed Techniques to be preferable to higher-indexed Techniques, ie when asked for the 'best' technique it will return the first one in the technique list which is supported by the hardware.

Technique* Ogre::Material::getTechnique ( unsigned short  index  ) 

Gets the indexed technique.

Technique* Ogre::Material::getTechnique ( const String &  name  ) 

searches for the named technique.

Return 0 if technique with name is not found

unsigned short Ogre::Material::getNumTechniques ( void   )  const

Retrieves the number of techniques.

void Ogre::Material::removeTechnique ( unsigned short  index  ) 

Removes the technique at the given index.

void Ogre::Material::removeAllTechniques ( void   ) 

Removes all the techniques in this Material.

TechniqueIterator Ogre::Material::getTechniqueIterator ( void   ) 

Get an iterator over the Techniques in this Material.

TechniqueIterator Ogre::Material::getSupportedTechniqueIterator ( void   ) 

Gets an iterator over all the Techniques which are supported by the current card.

Remarks:
The supported technique list is only available after this material has been compiled, which typically happens on loading the material. Therefore, if this method returns an empty list, try calling Material::load.

Technique* Ogre::Material::getSupportedTechnique ( unsigned short  index  ) 

Gets the indexed supported technique.

unsigned short Ogre::Material::getNumSupportedTechniques ( void   )  const

Retrieves the number of supported techniques.

const String& Ogre::Material::getUnsupportedTechniquesExplanation (  )  const

Gets a string explaining why any techniques are not supported.

Definition at line 235 of file OgreMaterial.h.

unsigned short Ogre::Material::getNumLodLevels ( unsigned short  schemeIndex  )  const

Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex.

Remarks:
Note that this will not be up to date until the material has been compiled.

unsigned short Ogre::Material::getNumLodLevels ( const String &  schemeName  )  const

Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex.

Remarks:
Note that this will not be up to date until the material has been compiled.

Technique* Ogre::Material::getBestTechnique ( unsigned short  lodIndex = 0,
const Renderable *  rend = 0 
)

Gets the best supported technique.

Remarks:
This method returns the lowest-index supported Technique in this material (since lower-indexed Techniques are considered to be better than higher-indexed ones).
The best supported technique is only available after this material has been compiled, which typically happens on loading the material. Therefore, if this method returns NULL, try calling Material::load.
Parameters:
lodIndex The material lod index to use
rend Optional parameter specifying the Renderable that is requesting this technique. Only used if no valid technique for the active material scheme is found, at which point it is passed to MaterialManager::Listener::handleSchemeNotFound as information.

MaterialPtr Ogre::Material::clone ( const String &  newName,
bool  changeGroup = false,
const String &  newGroup = StringUtil::BLANK 
) const

Creates a new copy of this material with the same settings but a new name.

Parameters:
newName The name for the cloned material
changeGroup If true, the resource group of the clone is changed
newGroup Only required if changeGroup is true; the new group to assign

void Ogre::Material::copyDetailsTo ( MaterialPtr &  mat  )  const

Copies the details of this material into another, preserving the target's handle and name (unlike operator=) but copying everything else.

Parameters:
mat Weak reference to material which will receive this material's settings.

void Ogre::Material::compile ( bool  autoManageTextureUnits = true  ) 

'Compiles' this Material.

Remarks:
Compiling a material involves determining which Techniques are supported on the card on which OGRE is currently running, and for fixed-function Passes within those Techniques, splitting the passes down where they contain more TextureUnitState instances than the current card has texture units.
This process is automatically done when the Material is loaded, but may be repeated if you make some procedural changes.
Parameters:
autoManageTextureUnits If true, when a fixed function pass has too many TextureUnitState entries than the card has texture units, the Pass in question will be split into more than one Pass in order to emulate the Pass. If you set this to false and this situation arises, an Exception will be thrown.

void Ogre::Material::setPointSize ( Real  ps  ) 

Sets the point size properties for every