OGRE  1.9.0
Ogre::ShadowRenderable Class Referenceabstract

Class which represents the renderable aspects of a set of shadow volume faces. More...

#include <OgreShadowCaster.h>

Inheritance diagram for Ogre::ShadowRenderable:

Public Member Functions

 ShadowRenderable ()
 Used only if isLightCapSeparate == true.
 
virtual ~ShadowRenderable ()
 
virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
 
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow.
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index.
 
ShadowRenderablegetLightCapRenderable (void)
 Get the light cap version of this renderable.
 
const LightListgetLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable.
 
const MaterialPtrgetMaterial (void) const
 Retrieves a weak reference to the material this renderable object uses.
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires.
 
virtual bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
 
void getRenderOperation (RenderOperation &op)
 Gets the render operation required to send this object to the frame buffer.
 
RenderOperationgetRenderOperationForUpdate (void)
 Get the internal render operation for set up.
 
virtual RenderSystemDatagetRenderSystemData () const
 Gets RenderSystem private data.
 
Real getSquaredViewDepth (const Camera *) const
 Returns the camera-relative squared depth of this renderable.
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses.
 
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection.
 
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view.
 
virtual OGRE_DEPRECATED const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class.
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class.
 
void getWorldTransforms (Matrix4 *xform) const =0
 Gets the world transform matrix / matrices for this renderable object.
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index.
 
bool isLightCapSeparate (void) const
 Does this renderable require a separate light cap?
 
virtual bool isVisible (void) const
 Should this ShadowRenderable be treated as visible?
 
void operator delete (void *ptr)
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz)
 
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, const char *file, int line, const char *func)
 operator new, with debug line info
 
void * operator new (size_t sz, void *ptr)
 placement operator new
 
void * operator new (size_t sz, void *ptr)
 placement operator new
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz)
 
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, const char *file, int line, const char *func)
 array operator new, with debug line info
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered.
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered.
 
virtual void rebindIndexBuffer (const HardwareIndexBufferSharedPtr &indexBuffer)=0
 This function informs the shadow renderable that the global index buffer from the SceneManager has been updated.
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index.
 
void setCustomParameter (size_t index, const Vector4 &value)
 Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
 
void setMaterial (const MaterialPtr &mat)
 Set the material to be used by the shadow, should be set by the caller before adding to a render queue.
 
virtual void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
 
virtual void setRenderSystemData (RenderSystemData *val) const
 Sets RenderSystem private data.
 
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection.
 
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view.
 
virtual OGRE_DEPRECATED void setUserAny (const Any &anything)
 

Protected Types

typedef map< size_t, Vector4 >::type CustomParameterMap
 

Protected Attributes

CustomParameterMap mCustomParameters
 
ShadowRenderablemLightCap
 
MaterialPtr mMaterial
 
bool mPolygonModeOverrideable
 
RenderOperation mRenderOp
 
RenderSystemDatamRenderSystemData
 User objects binding.
 
bool mUseIdentityProjection
 
bool mUseIdentityView
 
UserObjectBindings mUserObjectBindings
 

Detailed Description

Class which represents the renderable aspects of a set of shadow volume faces.

Remarks
Note that for casters comprised of more than one set of vertex buffers (e.g. SubMeshes each using their own geometry), it will take more than one ShadowRenderable to render the shadow volume. Therefore for shadow caster geometry, it is best to stick to one set of vertex buffers (not necessarily one buffer, but the positions for the entire geometry should come from one buffer if possible)

Definition at line 52 of file OgreShadowCaster.h.

Member Typedef Documentation

◆ CustomParameterMap

typedef map<size_t,Vector4>::type Ogre::Renderable::CustomParameterMap
protectedinherited

Definition at line 414 of file OgreRenderable.h.

Constructor & Destructor Documentation

◆ ShadowRenderable()

Ogre::ShadowRenderable::ShadowRenderable ( )

Used only if isLightCapSeparate == true.

Definition at line 59 of file OgreShadowCaster.h.

References mLightCap, and mMaterial.

Referenced by getLightCapRenderable().

◆ ~ShadowRenderable()

virtual Ogre::ShadowRenderable::~ShadowRenderable ( )
virtual

Definition at line 60 of file OgreShadowCaster.h.

References mLightCap.

Member Function Documentation

◆ _updateCustomGpuParameter()

virtual void Ogre::Renderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry & constantEntry,
GpuProgramParameters * params ) const
virtualinherited

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks
This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.
You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.
Parameters
constantEntryThe auto constant entry referring to the parameter being updated
paramsThe parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

Definition at line 307 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, mCustomParameters, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.

◆ getCastsShadows()

virtual bool Ogre::Renderable::getCastsShadows ( void ) const
virtualinherited

Method which reports whether this renderable would normally cast a shadow.

Remarks
Subclasses should override this if they could have been used to generate a shadow.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, Ogre::SubEntity, and Ogre::TerrainQuadTreeNode::Rend.

Definition at line 224 of file OgreRenderable.h.

◆ getCustomParameter()

const Vector4 & Ogre::Renderable::getCustomParameter ( size_t index) const
inherited

Gets the custom value associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to retrieve.
See also
setCustomParameter for full details.

Definition at line 268 of file OgreRenderable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, mCustomParameters, and OGRE_EXCEPT.

◆ getLightCapRenderable()

ShadowRenderable * Ogre::ShadowRenderable::getLightCapRenderable ( void )

Get the light cap version of this renderable.

Definition at line 90 of file OgreShadowCaster.h.

References ShadowRenderable(), and mLightCap.

◆ getLights()

const LightList & Ogre::ShadowRenderable::getLights ( void ) const
virtual

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks
Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

◆ getMaterial()

const MaterialPtr & Ogre::ShadowRenderable::getMaterial ( void ) const
virtual

Retrieves a weak reference to the material this renderable object uses.

Remarks
Note that the Renderable also has the option to override the getTechnique method to specify a particular Technique to use instead of the best one available.

Implements Ogre::Renderable.

Definition at line 66 of file OgreShadowCaster.h.

References mMaterial.

◆ getNumWorldTransforms()

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void ) const
virtualinherited

Returns the number of world transform matrices this renderable requires.

Remarks
When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::BaseInstanceBatchVTF, Ogre::BorderRenderable, Ogre::InstanceBatchHW, Ogre::InstanceBatchShader, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 153 of file OgreRenderable.h.

◆ getPolygonModeOverrideable()

virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void ) const
virtualinherited

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Reimplemented in Ogre::BorderRenderable.

Definition at line 332 of file OgreRenderable.h.

References mPolygonModeOverrideable.

◆ getRenderOperation()

void Ogre::ShadowRenderable::getRenderOperation ( RenderOperation & op)
virtual

Gets the render operation required to send this object to the frame buffer.

Implements Ogre::Renderable.

Definition at line 68 of file OgreShadowCaster.h.

References mRenderOp.

◆ getRenderOperationForUpdate()

RenderOperation * Ogre::ShadowRenderable::getRenderOperationForUpdate ( void )

Get the internal render operation for set up.

Definition at line 70 of file OgreShadowCaster.h.

References mRenderOp.

◆ getRenderSystemData()

virtual RenderSystemData * Ogre::Renderable::getRenderSystemData ( ) const
virtualinherited

Gets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 399 of file OgreRenderable.h.

References mRenderSystemData.

◆ getSquaredViewDepth()

Real Ogre::ShadowRenderable::getSquaredViewDepth ( const Camera * ) const
virtual

Returns the camera-relative squared depth of this renderable.

Remarks
Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.

Implements Ogre::Renderable.

Definition at line 74 of file OgreShadowCaster.h.

◆ getTechnique()

virtual Technique * Ogre::Renderable::getTechnique ( void ) const
virtualinherited

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks
This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, Ogre::SubEntity, and Ogre::TerrainQuadTreeNode::Rend.

Definition at line 94 of file OgreRenderable.h.

References getMaterial().

◆ getUseIdentityProjection()

bool Ogre::Renderable::getUseIdentityProjection ( void ) const
inherited

Returns whether or not to use an 'identity' projection.

Remarks
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this.
See also
Renderable::setUseIdentityProjection

Definition at line 178 of file OgreRenderable.h.

References mUseIdentityProjection.

◆ getUseIdentityView()

bool Ogre::Renderable::getUseIdentityView ( void ) const
inherited

Returns whether or not to use an 'identity' view.

Remarks
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this.
See also
Renderable::setUseIdentityView

Definition at line 203 of file OgreRenderable.h.

References mUseIdentityView.

◆ getUserAny()

virtual OGRE_DEPRECATED const Any & Ogre::Renderable::getUserAny ( void ) const
virtualinherited
Deprecated
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Reimplemented in Ogre::InstanceBatch.

Definition at line 349 of file OgreRenderable.h.

References getUserObjectBindings(), and OGRE_DEPRECATED.

Referenced by Ogre::InstanceBatch::visitRenderables().

◆ getUserObjectBindings() [1/2]

UserObjectBindings & Ogre::Renderable::getUserObjectBindings ( )
inherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 355 of file OgreRenderable.h.

References mUserObjectBindings.

Referenced by getUserAny(), and setUserAny().

◆ getUserObjectBindings() [2/2]

const UserObjectBindings & Ogre::Renderable::getUserObjectBindings ( ) const
inherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 361 of file OgreRenderable.h.

References mUserObjectBindings.

◆ getWorldTransforms()

void Ogre::ShadowRenderable::getWorldTransforms ( Matrix4 * xform) const
pure virtual

Gets the world transform matrix / matrices for this renderable object.

Remarks
If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.
This method will populate transform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.
Note
Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.
See also
Matrix4::isAffine.

Implements Ogre::Renderable.

Implemented in Ogre::Entity::EntityShadowRenderable, Ogre::ManualObject::ManualObjectSectionShadowRenderable, and Ogre::StaticGeometry::LODBucket::LODShadowRenderable.

◆ hasCustomParameter()

bool Ogre::Renderable::hasCustomParameter ( size_t index) const
inherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to check for existence.
See also
setCustomParameter for full details.

Definition at line 259 of file OgreRenderable.h.

References mCustomParameters.

◆ isLightCapSeparate()

bool Ogre::ShadowRenderable::isLightCapSeparate ( void ) const

Does this renderable require a separate light cap?

Remarks
If possible, the light cap (when required) should be contained in the usual geometry of the shadow renderable. However, if for some reason the normal depth function (less than) could cause artefacts, then a separate light cap with a depth function of 'always fail' can be used instead. The primary example of this is when there are floating point inaccuracies caused by calculating the shadow geometry separately from the real geometry.

Definition at line 87 of file OgreShadowCaster.h.

References mLightCap.

◆ isVisible()

virtual bool Ogre::ShadowRenderable::isVisible ( void ) const
virtual

Should this ShadowRenderable be treated as visible?

Reimplemented in Ogre::Entity::EntityShadowRenderable.

Definition at line 92 of file OgreShadowCaster.h.

◆ operator delete() [1/6]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete ( void * ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/6]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete ( void * ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/6]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [4/6]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [5/6]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete ( void * ptr,
void *  )
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [6/6]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete ( void * ptr,
void *  )
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/4]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete[] ( void * ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/4]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete[] ( void * ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [3/4]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete[] ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [4/4]

void Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator delete[] ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/6]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new ( size_t sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/6]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new ( size_t sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/6]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new ( size_t sz,
const char * file,
int line,
const char * func )
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [4/6]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new ( size_t sz,
const char * file,
int line,
const char * func )
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [5/6]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new ( size_t sz,
void * ptr )
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new() [6/6]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new ( size_t sz,
void * ptr )
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/4]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new[] ( size_t sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/4]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new[] ( size_t sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [3/4]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new[] ( size_t sz,
const char * file,
int line,
const char * func )
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [4/4]

void * Ogre::AllocatedObject< SceneCtlAllocPolicy >::operator new[] ( size_t sz,
const char * file,
int line,
const char * func )
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ postRender()

virtual void Ogre::Renderable::postRender ( SceneManager * sm,
RenderSystem * rsys )
virtualinherited

Called immediately after the Renderable has been rendered.

Definition at line 128 of file OgreRenderable.h.

◆ preRender()

virtual bool Ogre::Renderable::preRender ( SceneManager * sm,
RenderSystem * rsys )
virtualinherited

Called just prior to the Renderable being rendered.

Remarks
OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.
This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.
Returns
true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Reimplemented in Ogre::BillboardChain.

Definition at line 123 of file OgreRenderable.h.

◆ rebindIndexBuffer()

virtual void Ogre::ShadowRenderable::rebindIndexBuffer ( const HardwareIndexBufferSharedPtr & indexBuffer)
pure virtual

This function informs the shadow renderable that the global index buffer from the SceneManager has been updated.

As all shadow use this buffer their pointer must be updated as well.

Parameters
indexBufferPointer to the new index buffer.

Implemented in Ogre::Entity::EntityShadowRenderable, Ogre::ManualObject::ManualObjectSectionShadowRenderable, and Ogre::StaticGeometry::LODBucket::LODShadowRenderable.

◆ removeCustomParameter()

void Ogre::Renderable::removeCustomParameter ( size_t index)
inherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to remove.
See also
setCustomParameter for full details.

Definition at line 250 of file OgreRenderable.h.

References mCustomParameters.

◆ setCustomParameter()

void Ogre::Renderable::setCustomParameter ( size_t index,
const Vector4 & value )
inherited

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks
Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.
Parameters
indexThe index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
valueThe value to associate.

Definition at line 241 of file OgreRenderable.h.

References mCustomParameters.

◆ setMaterial()

void Ogre::ShadowRenderable::setMaterial ( const MaterialPtr & mat)

Set the material to be used by the shadow, should be set by the caller before adding to a render queue.

Definition at line 64 of file OgreShadowCaster.h.

References mMaterial.

◆ setPolygonModeOverrideable()

virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool override)
virtualinherited

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Parameters
overridetrue means that a lower camera detail will override this renderables detail level, false means it won't.

Definition at line 324 of file OgreRenderable.h.

References mPolygonModeOverrideable.

◆ setRenderSystemData()

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData * val) const
virtualinherited

Sets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 407 of file OgreRenderable.h.

References mRenderSystemData.

◆ setUseIdentityProjection()

void Ogre::Renderable::setUseIdentityProjection ( bool useIdentityProjection)
inherited

Sets whether or not to use an 'identity' projection.

Remarks
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this. The default is false.
See also
Renderable::getUseIdentityProjection

Definition at line 164 of file OgreRenderable.h.

References mUseIdentityProjection.

◆ setUseIdentityView()

void Ogre::Renderable::setUseIdentityView ( bool useIdentityView)
inherited

Sets whether or not to use an 'identity' view.

Remarks
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this. The default is false.
See also
Renderable::getUseIdentityView

Definition at line 189 of file OgreRenderable.h.

References mUseIdentityView.

◆ setUserAny()

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any & anything)
virtualinherited
Deprecated
use UserObjectBindings::setUserAny via getUserObjectBindings() instead. Sets any kind of user value on this object.
Remarks
This method allows you to associate any user value you like with this Renderable. This can be a pointer back to one of your own classes for instance.

Reimplemented in Ogre::InstanceBatch.

Definition at line 344 of file OgreRenderable.h.

References getUserObjectBindings(), and OGRE_DEPRECATED.

Referenced by Ogre::InstanceBatch::visitRenderables().

Member Data Documentation

◆ mCustomParameters

CustomParameterMap Ogre::Renderable::mCustomParameters
protectedinherited

◆ mLightCap

ShadowRenderable* Ogre::ShadowRenderable::mLightCap
protected

◆ mMaterial

MaterialPtr Ogre::ShadowRenderable::mMaterial
protected

Definition at line 55 of file OgreShadowCaster.h.

Referenced by ShadowRenderable(), getMaterial(), and setMaterial().

◆ mPolygonModeOverrideable

bool Ogre::Renderable::mPolygonModeOverrideable
protectedinherited

◆ mRenderOp

RenderOperation Ogre::ShadowRenderable::mRenderOp
protected

Definition at line 56 of file OgreShadowCaster.h.

Referenced by getRenderOperation(), and getRenderOperationForUpdate().

◆ mRenderSystemData

RenderSystemData* Ogre::Renderable::mRenderSystemData
mutableprotectedinherited

User objects binding.

Definition at line 420 of file OgreRenderable.h.

Referenced by Renderable(), ~Renderable(), getRenderSystemData(), and setRenderSystemData().

◆ mUseIdentityProjection

bool Ogre::Renderable::mUseIdentityProjection
protectedinherited

◆ mUseIdentityView

bool Ogre::Renderable::mUseIdentityView
protectedinherited

◆ mUserObjectBindings

UserObjectBindings Ogre::Renderable::mUserObjectBindings
protectedinherited

Definition at line 419 of file OgreRenderable.h.

Referenced by getUserObjectBindings(), and getUserObjectBindings().


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