#include <OgreMaterial.h>
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 ¶mList) |
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, void *) |
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 |
Friends | |
class | SceneManager |
class | MaterialManager |
Definition at line 83 of file OgreMaterial.h.
typedef std::vector<Real> Ogre::Material::LodDistanceList |
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.
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.
enum Ogre::Resource::LoadingState [inherited] |
Enum identifying the loading state of the resource.
Definition at line 109 of file OgreResource.h.
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 | ( | ) |
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] |
void Ogre::Material::unprepareImpl | ( | void | ) | [protected, virtual] |
void Ogre::Material::loadImpl | ( | void | ) | [protected, virtual] |
void Ogre::Material::unloadImpl | ( | void | ) | [protected, virtual] |
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.
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.
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.
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.
Technique* Ogre::Material::getTechnique | ( | unsigned short | index | ) |
Gets the indexed technique.
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.
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.
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.
Technique* Ogre::Material::getBestTechnique | ( | unsigned short | lodIndex = 0 , |
|
const Renderable * | rend = 0 | |||
) |
Gets the best supported technique.
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.
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.
mat | Weak reference to material which will receive this material's settings. |
void Ogre::Material::compile | ( | bool | autoManageTextureUnits = true |
) |
'Compiles' this Material.
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 Pass in every Technique.
Sets the ambient colour reflectance properties for every Pass in every Technique.
void Ogre::Material::setAmbient | ( | const ColourValue & | ambient | ) |
Sets the ambient colour reflectance properties for every Pass in every Technique.
Sets the diffuse colour reflectance properties of every Pass in every Technique.
void Ogre::Material::setDiffuse | ( | const ColourValue & | diffuse | ) |
Sets the diffuse colour reflectance properties of every Pass in every Technique.
Sets the specular colour reflectance properties of every Pass in every Technique.
void Ogre::Material::setSpecular | ( | const ColourValue & | specular | ) |
Sets the specular colour reflectance properties of every Pass in every Technique.
void Ogre::Material::setShininess | ( | Real | val | ) |
Sets the shininess properties of every Pass in every Technique.
Sets the amount of self-illumination of every Pass in every Technique.
void Ogre::Material::setSelfIllumination | ( | const ColourValue & | selfIllum | ) |
Sets the amount of self-illumination of every Pass in every Technique.
void Ogre::Material::setDepthCheckEnabled | ( | bool | enabled | ) |
Sets whether or not each Pass renders with depth-buffer checking on or not.
void Ogre::Material::setDepthWriteEnabled | ( | bool | enabled | ) |
Sets whether or not each Pass renders with depth-buffer writing on or not.
void Ogre::Material::setDepthFunction | ( | CompareFunction | func | ) |
Sets the function used to compare depth values when depth checking is on.
void Ogre::Material::setColourWriteEnabled | ( | bool | enabled | ) |
Sets whether or not colour buffer writing is enabled for each Pass.
void Ogre::Material::setCullingMode | ( | CullingMode | mode | ) |
Sets the culling mode for each pass based on the 'vertex winding'.
void Ogre::Material::setManualCullingMode | ( | ManualCullingMode | mode | ) |
Sets the manual culling mode, performed by CPU rather than hardware.
void Ogre::Material::setLightingEnabled | ( | bool | enabled | ) |
Sets whether or not dynamic lighting is enabled for every Pass.
void Ogre::Material::setShadingMode | ( | ShadeOptions | mode | ) |
Sets the type of light shading required.
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.
void Ogre::Material::setDepthBias | ( | float | constantBias, | |
float | slopeScaleBias | |||
) |
Sets the depth bias to be used for each Pass.
void Ogre::Material::setTextureFiltering | ( | TextureFilterOptions | filterType | ) |
Set texture filtering for every texture unit in every Technique and Pass.
void Ogre::Material::setTextureAnisotropy | ( | int | maxAniso | ) |
Sets the anisotropy level to be used for all textures.
void Ogre::Material::setSceneBlending | ( | const SceneBlendType | sbt | ) |
Sets the kind of blending every pass has with the existing contents of the scene.
void Ogre::Material::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 Ogre::Material::setSceneBlending | ( | const SceneBlendFactor | sourceFactor, | |
const SceneBlendFactor | destFactor | |||
) |
Allows very fine control of blending every Pass with the existing contents of the scene.
void Ogre::Material::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 Ogre::Material::_notifyNeedsRecompile | ( | void | ) |
Tells the material that it needs recompilation.
void Ogre::Material::setLodLevels | ( | const LodDistanceList & | lodDistances | ) |
Sets the distance at which level-of-detail (LOD) levels come into effect.
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). |
LodDistanceIterator Ogre::Material::getLodDistanceIterator | ( | void | ) | const |
Gets an iterator over the list of distances at which each LOD comes into effect.
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.
void Ogre::Material::touch | ( | void | ) | [virtual] |
'Touches' the resource to indicate it has been used.
Reimplemented from Ogre::Resource.
Definition at line 623 of file OgreMaterial.h.
References Ogre::Resource::touch().
bool Ogre::Material::applyTextureAliases | ( | const AliasTextureNamePairList & | aliasList, | |
const bool | apply = true | |||
) | const |
Applies texture names to Texture Unit State with matching texture name aliases.
All techniques, passes, and Texture Unit States within the material are checked. If matching texture aliases are found then true is returned.
aliasList | is a map container of texture alias, texture name pairs | |
apply | set true to apply the texture aliases else just test to see if texture alias matches are found. |
bool Ogre::Material::getCompilationRequired | ( | ) | const |
Gets the compilation status of the material.
Definition at line 647 of file OgreMaterial.h.
virtual void Ogre::Resource::preLoadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 166 of file OgreResource.h.
virtual void Ogre::Resource::postLoadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh.
Definition at line 173 of file OgreResource.h.
virtual void Ogre::Resource::preUnloadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions before the unload process.
Definition at line 178 of file OgreResource.h.
virtual void Ogre::Resource::postUnloadImpl | ( | void | ) | [protected, virtual, inherited] |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 183 of file OgreResource.h.
virtual void Ogre::Resource::queueFireBackgroundLoadingComplete | ( | void | ) | [protected, virtual, inherited] |
Queue the firing of background loading complete event.
virtual void Ogre::Resource::queueFireBackgroundPreparingComplete | ( | void | ) | [protected, virtual, inherited] |
Queue the firing of background preparing complete event.
virtual void Ogre::Resource::prepare | ( | ) | [virtual, inherited] |
Prepares the resource for load, if it is not already.
One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.
virtual void Ogre::Resource::load | ( | bool | backgroundThread = false |
) | [virtual, inherited] |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::reload | ( | void | ) | [virtual, inherited] |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual bool Ogre::Resource::isReloadable | ( | void | ) | const [virtual, inherited] |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 271 of file OgreResource.h.
virtual bool Ogre::Resource::isManuallyLoaded | ( | void | ) | const [virtual, inherited] |
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::UnifiedHighLevelGpuProgram.
virtual size_t Ogre::Resource::getSize | ( | void | ) | const [virtual, inherited] |
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 290 of file OgreResource.h.
virtual const String& Ogre::Resource::getName | ( | void | ) | const [virtual, inherited] |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 301 of file OgreResource.h.
virtual ResourceHandle Ogre::Resource::getHandle | ( | void | ) | const [virtual, inherited] |
virtual bool Ogre::Resource::isPrepared | ( | void | ) | const [virtual, inherited] |
Returns true if the Resource has been prepared, false otherwise.
Definition at line 313 of file OgreResource.h.
virtual bool Ogre::Resource::isLoaded | ( | void | ) | const [virtual, inherited] |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 321 of file OgreResource.h.
virtual bool Ogre::Resource::isLoading | ( | ) | const [virtual, inherited] |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 330 of file OgreResource.h.
virtual LoadingState Ogre::Resource::getLoadingState | ( | ) | const [virtual, inherited] |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 337 of file OgreResource.h.
virtual bool Ogre::Resource::isBackgroundLoaded | ( | void | ) | const [virtual, inherited] |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 354 of file OgreResource.h.
virtual void Ogre::Resource::setBackgroundLoaded | ( | bool | bl | ) | [virtual, inherited] |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 364 of file OgreResource.h.
virtual void Ogre::Resource::escalateLoading | ( | ) | [virtual, inherited] |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::addListener | ( | Listener * | lis | ) | [virtual, inherited] |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual void Ogre::Resource::removeListener | ( | Listener * | lis | ) | [virtual, inherited] |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
virtual const String& Ogre::Resource::getGroup | ( | void | ) | [virtual, inherited] |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 388 of file OgreResource.h.
virtual void Ogre::Resource::changeGroupOwnership | ( | const String & | newGroup | ) | [virtual, inherited] |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
virtual ResourceManager* Ogre::Resource::getCreator | ( | void | ) | [virtual, inherited] |
virtual const String& Ogre::Resource::getOrigin | ( | void | ) | const [virtual, inherited] |
Get the origin of this resource, e.g.
a script file name.
Definition at line 407 of file OgreResource.h.
virtual void Ogre::Resource::_notifyOrigin | ( | const String & | origin | ) | [virtual, inherited] |
virtual size_t Ogre::Resource::getStateCount | ( | ) | const [virtual, inherited] |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.
Definition at line 418 of file OgreResource.h.
virtual void Ogre::Resource::_dirtyState | ( | ) | [virtual, inherited] |
Manually mark the state of this resource as having been changed.
virtual void Ogre::Resource::_fireBackgroundLoadingComplete | ( | void | ) | [virtual, inherited] |
Firing of background loading complete event.
virtual void Ogre::Resource::_fireBackgroundPreparingComplete | ( | void | ) | [virtual, inherited] |
Firing of background preparing complete event.
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.
className | the name of the class using the dictionary |
Definition at line 179 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 212 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 217 of file OgreStringInterface.h.
const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
const String & | value | |||
) | [virtual, inherited] |
Generic parameter setting method.
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. |
Referenced by Ogre::StringInterface::copyParametersTo().
virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
paramList | Name/value pair list |
virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 265 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
Method for copying this object's parameters to another object.
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().
static 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.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 84 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 89 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 106 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
friend class SceneManager [friend] |
Definition at line 85 of file OgreMaterial.h.
friend class MaterialManager [friend] |
Definition at line 86 of file OgreMaterial.h.
Techniques Ogre::Material::mTechniques [protected] |
Techniques Ogre::Material::mSupportedTechniques [protected] |
Map of scheme -> list of LOD techniques.
Current scheme is set on MaterialManager, and can be set per Viewport for auto activation.
Definition at line 110 of file OgreMaterial.h.
LodDistanceList Ogre::Material::mLodDistances [protected] |
Definition at line 112 of file OgreMaterial.h.
bool Ogre::Material::mReceiveShadows [protected] |
Definition at line 113 of file OgreMaterial.h.
bool Ogre::Material::mTransparencyCastsShadows [protected] |
Definition at line 114 of file OgreMaterial.h.
bool Ogre::Material::mCompilationRequired [protected] |
String Ogre::Material::mUnsupportedReasons [protected] |
Text description of why any techniques are not supported.
Definition at line 118 of file OgreMaterial.h.
ResourceManager* Ogre::Resource::mCreator [protected, inherited] |
String Ogre::Resource::mName [protected, inherited] |
String Ogre::Resource::mGroup [protected, inherited] |
ResourceHandle Ogre::Resource::mHandle [protected, inherited] |
AtomicScalar<LoadingState> Ogre::Resource::mLoadingState [protected, inherited] |
volatile bool Ogre::Resource::mIsBackgroundLoaded [protected, inherited] |
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 136 of file OgreResource.h.
size_t Ogre::Resource::mSize [protected, inherited] |
bool Ogre::Resource::mIsManual [protected, inherited] |
String Ogre::Resource::mOrigin [protected, inherited] |
Origin of this resource (e.g. script name) - optional.
Definition at line 142 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 144 of file OgreResource.h.
size_t Ogre::Resource::mStateCount [protected, inherited] |
State count, the number of times this resource has changed state.
Definition at line 146 of file OgreResource.h.
ListenerList Ogre::Resource::mListenerList [protected, inherited] |
Definition at line 149 of file OgreResource.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:04:03 2009