# Ogre::Material Class Reference

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

`#include <OgreMaterial.h>`

Inheritance diagram for Ogre::Material:

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

## 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.
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.
unsigned short | getNumLodLevels (void) const
| Gets the number of levels-of-detail this material has, based on Technique::setLodIndex.
Technique * | getBestTechnique (unsigned short lodIndex=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 | 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 (ushort bias)
| 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 | setSceneBlending (const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor)
| Allows very fine control of blending every Pass with the existing contents of the scene.
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)
bool | getCompilationRequired () const
| Gets the compilation status of the material.
virtual void | load (void)
| Loads the resource, if it is not already.
virtual void | reload (void)
| Reloads the resource, if it is already loaded.
bool | isReloadable (void) const
| Returns true if the Resource is reloadable, false otherwise.
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.
size_t | getSize (void) const
| Retrieves info about the size of the resource.
const String & | getName (void) const
| Gets resource name.
ResourceHandle | getHandle (void) const
bool | isLoaded (void) const
| Returns true if the Resource has been loaded, false otherwise.
const String & | getGroup (void)
| Gets the group which this resource is a member of.
ResourceManager * | getCreator (void)
| Gets the manager which created this resource.
const String & | getOrigin (void) const
| Get the origin of this resource, e.g.
void | _notifyOrigin (const String &origin)
| Notify this resource of it's origin.
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.

## Static Public Member Functions

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 * > | BestTechniqueList

## Protected Member Functions

void | applyDefaults (void)
| Internal method which sets the material up from the default settings.
void | fixupBestTechniqueList (void)
| Fixup the best technique list guarantees no gaps inside.
void | loadImpl (void)
| Overridden from Resource.
void | unloadImpl (void)
| Unloads the material, frees resources etc.
size_t | calculateSize (void) const
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
Techniques | mSupportedTechniques
BestTechniqueList | mBestTechniqueList
LodDistanceList | mLodDistances
bool | mReceiveShadows
bool | mTransparencyCastsShadows
bool | mCompilationRequired
| Does this material require compilation?
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.
bool | mIsLoaded
| Is the resource currently loaded?
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.
String | mParamDictName
| Class name for this instance to be used as a lookup (must be initialised by subclasses).

## Static Protected Attributes

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 79 of file OgreMaterial.h.

## Member Typedef Documentation

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

| Definition at line 98 of file OgreMaterial.h.

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

| Definition at line 87 of file OgreMaterial.h.

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

| distance list used to specify LOD Definition at line 86 of file OgreMaterial.h.

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

| Definition at line 194 of file OgreMaterial.h.

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

| Definition at line 95 of file OgreMaterial.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::_notifyNeedsRecompile | ( | void |  | ) |

| Tells the material that it needs recompilation.

void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | `[inherited]`

| Notify this resource of it's origin. Definition at line 214 of file OgreResource.h. References Ogre::String.

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

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

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

| Implements Ogre::Resource. Definition at line 124 of file OgreMaterial.h.

void Ogre::StringInterface::cleanupDictionary | ( |  | ) | `[static, inherited]`

| 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. MaterialManager) initializes.

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::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::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.

virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const`[virtual, inherited]`

Method for copying this object's parameters to another object.

Remarks:
  This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

  Any unrecognised parameters will be ignored as with setParameter method.

Parameters:

  dest | Pointer to object to have it's parameters set the same as this object.

Definition at line 296 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | `[protected, inherited]`

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:
  This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters:

  className | the name of the class using the dictionary

Returns:
  true if a new dictionary was created, false if it was already there

Definition at line 172 of file OgreStringInterface.h.

References Ogre::String.

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.

void Ogre::Material::fixupBestTechniqueList | ( | void |  | ) | `[protected]`

Fixup the best technique list guarantees no gaps inside.

Remarks:
  Iterate over the best technique list, looking for gaps and filling them in guarantees we've got a sequential list with entries in all indexes

Technique* Ogre::Material::getBestTechnique | ( | unsigned short | lodIndex = 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

bool Ogre::Material::getCompilationRequired | ( |  | ) | const

Gets the compilation status of the material.

Returns:
  True if the material needs recompilation.

Definition at line 566 of file OgreMaterial.h.

ResourceManager* Ogre::Resource::getCreator | ( | void |  | ) | `[inherited]`

| Gets the manager which created this resource. Definition at line 205 of file OgreResource.h.

const String& Ogre::Resource::getGroup | ( | void |  | ) | `[inherited]`

| Gets the group which this resource is a member of. Definition at line 202 of file OgreResource.h. References Ogre::String.

ResourceHandle Ogre::Resource::getHandle | ( | void |  | ) | const`[inherited]`

| Definition at line 188 of file OgreResource.h. References Ogre::ResourceHandle.

LodDistanceIterator Ogre::Material::getLodDistanceIterator | ( | void |  | ) | const

Gets an iterator over the list of distances at which each LOD comes into effect.

Remarks:
  Note that the iterator returned from this method is not totally anagolous to the one passed in by calling setLodLevels - the list includes a zero entry at the start (since the highest LOD starts at distance 0), and the other distances are held as their squared value for efficiency.

unsigned short Ogre::Material::getLodIndex | ( | Real | d | ) | const

| Gets the LOD index to use at the given distance.

unsigned short Ogre::Material::getLodIndexSquaredDepth | ( | Real | squaredDepth | ) | const

| Gets the LOD index to use at the given squared distance.

const String& Ogre::Resource::getName | ( | void |  | ) | const`[inherited]`

| Gets resource name. Definition at line 183 of file OgreResource.h. References Ogre::String.

unsigned short Ogre::Material::getNumLodLevels | ( | void |  | ) | const

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

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

Definition at line 215 of file OgreMaterial.h.

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

| Retrieves the number of supported techniques.

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

| Retrieves the number of techniques.

const String& Ogre::Resource::getOrigin | ( | void |  | ) | const`[inherited]`

Get the origin of this resource, e.g.

a script file name.

Remarks:
  This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 212 of file OgreResource.h.

References Ogre::String.

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const`[inherited]`

| Definition at line 209 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | `[inherited]`

Retrieves the parameter dictionary for this class.

Remarks:
  Only valid to call this after createParamDictionary.

Returns:
  Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 196 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const`[virtual, inherited]`

Generic parameter retrieval method.

Remarks:
  Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters:

  name | The name of the parameter to get

Returns:
  String value of parameter, blank if not found

Definition at line 265 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::String.

const ParameterList& Ogre::StringInterface::getParameters | ( | void |  | ) | const`[inherited]`

Retrieves a list of parameters valid for this object.

Returns:
  A reference to a static list of ParameterDef objects.

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

| Returns whether or not objects using this material will receive shadows. Definition at line 157 of file OgreMaterial.h.

size_t Ogre::Resource::getSize | ( | void |  | ) | const`[inherited]`

| Retrieves info about the size of the resource. Definition at line 172 of file OgreResource.h.

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

| Gets the indexed supported technique.

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::getTechnique | ( | unsigned short | index | ) |

| Gets the indexed technique.

TechniqueIterator Ogre::Material::getTechniqueIterator | ( | void |  | ) |

| Get an iterator over the Techniques in this Material.

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 169 of file OgreMaterial.h.

bool Ogre::Resource::isLoaded | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource has been loaded, false otherwise. Definition at line 195 of file OgreResource.h. References OGRE_LOCK_AUTO_MUTEX.

bool Ogre::Resource::isManuallyLoaded | ( | void |  | ) | const`[inherited]`

| Is this resource manually loaded? Definition at line 160 of file OgreResource.h.

bool Ogre::Resource::isReloadable | ( | void |  | ) | const`[inherited]`

| Returns true if the Resource is reloadable, false otherwise. Definition at line 153 of file OgreResource.h.

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).

virtual void Ogre::Resource::load | ( | void |  | ) | `[virtual, inherited]`

Loads the resource, if it is not already.

Remarks:
  If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own

Reimplemented in Ogre::Mesh, and Ogre::GLSLGpuProgram.

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

| Overridden from Resource. Implements Ogre::Resource.

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

| Assignment operator to allow easy copying between materials.

virtual void Ogre::Resource::reload | ( | void |  | ) | `[virtual, inherited]`

Reloads the resource, if it is already loaded.

Remarks:
  Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

void Ogre::Material::removeAllTechniques | ( | void |  | ) |

| Removes all the techniques in this Material.

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

| Removes the technique at the given index.

void Ogre::Material::setAmbient | ( | const ColourValue & | ambient | ) |

Sets the ambient colour reflectance properties for every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setAmbient

void Ogre::Material::setAmbient | ( | Real | red,
|  | Real | green,
|  | Real | blue
| ) |

Sets the ambient colour reflectance properties for every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setAmbient

void Ogre::Material::setColourWriteEnabled | ( | bool | enabled | ) |

Sets whether or not colour buffer writing is enabled for each Pass.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setColourWriteEnabled

void Ogre::Material::setCullingMode | ( | CullingMode | mode | ) |

Sets the culling mode for each pass based on the 'vertex winding'.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setCullingMode

void Ogre::Material::setDepthBias | ( | ushort | bias | ) |

Sets the depth bias to be used for each Pass.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setDepthBias

void Ogre::Material::setDepthCheckEnabled | ( | bool | enabled | ) |

Sets whether or not each Pass renders with depth-buffer checking on or not.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setDepthCheckEnabled

void Ogre::Material::setDepthFunction | ( | CompareFunction | func | ) |

Sets the function used to compare depth values when depth checking is on.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setDepthFunction

void Ogre::Material::setDepthWriteEnabled | ( | bool | enabled | ) |

Sets whether or not each Pass renders with depth-buffer writing on or not.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setDepthWriteEnabled

void Ogre::Material::setDiffuse | ( | const ColourValue & | diffuse | ) |

Sets the diffuse colour reflectance properties of every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setDiffuse

void Ogre::Material::setDiffuse | ( | Real | red,
|  | Real | green,
|  | Real | blue,
|  | Real | alpha
| ) |

Sets the diffuse colour reflectance properties of every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setDiffuse

void Ogre::Material::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.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setFog

void Ogre::Material::setLightingEnabled | ( | bool | enabled | ) |

Sets whether or not dynamic lighting is enabled for every Pass.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setLightingEnabled

void Ogre::Material::setLodLevels | ( | const LodDistanceList & | lodDistances | ) |

Sets the distance at which level-of-detail (LOD) levels come into effect.

Remarks:
  You should only use this if you have assigned LOD indexes to the Technique instances attached to this Material. If you have done so, you should call this method to determine the distance at which the lowe levels of detail kick in. The decision about what distance is actually used is a combination of this and the LOD bias applied to both the current Camera and the current Entity.

Parameters:

  lodDistances | A vector of Reals which indicate the distance at which to switch to lower details. They are listed in LOD index order, starting at index 1 (ie the first level down from the highest level 0, which automatically applies from a distance of 0).

void Ogre::Material::setManualCullingMode | ( | ManualCullingMode | mode | ) |

Sets the manual culling mode, performed by CPU rather than hardware.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setManualCullingMode

virtual bool Ogre::StringInterface::setParameter | ( | const String & | name,
|  | const String & | value
| ) | `[virtual, inherited]`

Generic parameter setting method.

Remarks:
  Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  name | The name of the parameter to set
  value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns:
  true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | `[virtual, inherited]`

Generic multiple parameter setting method.

Remarks:
  Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

  paramList | Name/value pair list

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 155 of file OgreMaterial.h.

void Ogre::Material::setSceneBlending | ( | const SceneBlendFactor | sourceFactor,
|  | const SceneBlendFactor | destFactor
| ) |

Allows very fine control of blending every Pass with the existing contents of the scene.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setSceneBlending

void Ogre::Material::setSceneBlending | ( | const SceneBlendType | sbt | ) |

Sets the kind of blending every pass has with the existing contents of the scene.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setSceneBlending

void Ogre::Material::setSelfIllumination | ( | const ColourValue & | selfIllum | ) |

Sets the amount of self-illumination of every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setSelfIllumination

void Ogre::Material::setSelfIllumination | ( | Real | red,
|  | Real | green,
|  | Real | blue
| ) |

Sets the amount of self-illumination of every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setSelfIllumination

void Ogre::Material::setShadingMode | ( | ShadeOptions | mode | ) |

Sets the type of light shading required.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setShadingMode

void Ogre::Material::setShininess | ( | Real | val | ) |

Sets the shininess properties of every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setShininess

void Ogre::Material::setSpecular | ( | const ColourValue & | specular | ) |

Sets the specular colour reflectance properties of every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setSpecular

void Ogre::Material::setSpecular | ( | Real | red,
|  | Real | green,
|  | Real | blue,
|  | Real | alpha
| ) |

Sets the specular colour reflectance properties of every Pass in every Technique.

Note:
  This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there.

See also:
  Pass::setSpecular

void Ogre::Material::setTextureAnisotropy | ( | int | maxAniso | ) |

Sets the anisotropy level to be used for all textures.

Note:
  This property has been moved to the TextureUnitState class, which is accessible via the Technique and Pass. For simplicity, this method allows you to set these properties for every current TeextureUnitState, If you need more precision, retrieve the Technique, Pass and TextureUnitState instances and set the property there.

See also:
  TextureUnitState::setTextureAnisotropy

void Ogre::Material::setTextureFiltering | ( | TextureFilterOptions | filterType | ) |

Set texture filtering for every texture unit in every Technique and Pass.

Note:
  This property has been moved to the TextureUnitState class, which is accessible via the Technique and Pass. For simplicity, this method allows you to set these properties for every current TeextureUnitState, If you need more precision, retrieve the Technique, Pass and TextureUnitState instances and set the property there.

See also:
  TextureUnitState::setTextureFiltering

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 167 of file OgreMaterial.h.

void Ogre::Material::touch | ( | void |  | ) | `[virtual]`

| Reimplemented from Ogre::Resource. Definition at line 555 of file OgreMaterial.h.

virtual void Ogre::Resource::unload | ( | void |  | ) | `[virtual, inherited]`

| Unloads the resource; this is not permanent, the resource can be reloaded later if required. Reimplemented in Ogre::GLSLGpuProgram.

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

Unloads the material, frees resources etc.

See also:
  Resource

Implements Ogre::Resource.

## Friends And Related Function Documentation

friend class MaterialManager `[friend]`

| Definition at line 82 of file OgreMaterial.h.

friend class SceneManager `[friend]`

| Definition at line 81 of file OgreMaterial.h.

## Member Data Documentation

BestTechniqueList Ogre::Material::mBestTechniqueList `[protected]`

| Definition at line 99 of file OgreMaterial.h.

bool Ogre::Material::mCompilationRequired `[protected]`

| Does this material require compilation? Definition at line 105 of file OgreMaterial.h.

ResourceManager* Ogre::Resource::mCreator `[protected, inherited]`

| Creator. Definition at line 73 of file OgreResource.h.

String Ogre::Resource::mGroup `[protected, inherited]`

| The name of the resource group. Definition at line 77 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle `[protected, inherited]`

| Numeric handle for more efficient look up than name. Definition at line 79 of file OgreResource.h.

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

| Is the resource currently loaded? Definition at line 81 of file OgreResource.h.

bool Ogre::Resource::mIsManual `[protected, inherited]`

| Is this file manually loaded? Definition at line 85 of file OgreResource.h.

ManualResourceLoader* Ogre::Resource::mLoader `[protected, inherited]`

| Optional manual loader; if provided, data is loaded from here instead of a file. Definition at line 89 of file OgreResource.h.

LodDistanceList Ogre::Material::mLodDistances `[protected]`

| Definition at line 101 of file OgreMaterial.h.

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

| Unique name of the resource. Definition at line 75 of file OgreResource.h.

String Ogre::Resource::mOrigin `[protected, inherited]`

| Origin of this resource (e.g. script name) - optional. Definition at line 87 of file OgreResource.h.

String Ogre::StringInterface::mParamDictName `[protected, inherited]`

| Class name for this instance to be used as a lookup (must be initialised by subclasses). Definition at line 160 of file OgreStringInterface.h.

bool Ogre::Material::mReceiveShadows `[protected]`

| Definition at line 102 of file OgreMaterial.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary `[static, protected, inherited]`

| Dictionary of parameters. Definition at line 157 of file OgreStringInterface.h.

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

| The size of the resource in bytes. Definition at line 83 of file OgreResource.h.

Techniques Ogre::Material::mSupportedTechniques `[protected]`

| Definition at line 97 of file OgreMaterial.h.

Techniques Ogre::Material::mTechniques `[protected]`

| Definition at line 96 of file OgreMaterial.h.

bool Ogre::Material::mTransparencyCastsShadows `[protected]`

| Definition at line 103 of file OgreMaterial.h.

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

- OgreMaterial.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:00:58 2006