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

# Ogre::ShadowRenderable Class Reference

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

`#include <OgreShadowCaster.h>`

Inheritance diagram for Ogre::ShadowRenderable:

[legend]
List of all members.

## Public Methods

| ShadowRenderable ()
virtual | ~ShadowRenderable ()
void | setMaterial (Material *mat)
| Set the material to be used by the shadow, should be set by the caller before adding to a render queue.
Material * | getMaterial (void) const
| Overridden from Renderable.
void | getRenderOperation (RenderOperation &op)
| Overridden from Renderable.
RenderOperation * | getRenderOperationForUpdate (void)
| Get the internal render operation for set up.
void | getWorldTransforms (Matrix4 *xform) const=0
| Overridden from Renderable.
const Quaternion & | getWorldOrientation (void) const=0
| Overridden from Renderable.
const Vector3 & | getWorldPosition (void) const=0
| Overridden from Renderable.
Real | getSquaredViewDepth (const Camera *cam) const
| Overridden from Renderable.
const LightList & | getLights (void) const
| Overridden from Renderable.
bool | isLightCapSeparate (void) const
| Does this renderable require a separate light cap?
ShadowRenderable * | getLightCapRenderable (void)
| Get the light cap version of this renderable.
virtual bool | isVisible (void) const
| Should this ShadowRenderable be treated as visible?
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses.
virtual unsigned short | getNumWorldTransforms (void) const
| Returns the number of world transform matrices this renderable requires.
virtual bool | useIdentityProjection (void) const
| Returns whether or not to use an 'identity' projection.
virtual bool | useIdentityView (void) const
| Returns whether or not to use an 'identity' projection.
virtual SceneDetailLevel | getRenderDetail () const
| Returns the preferred rasterisation mode of this renderable.
virtual bool | getNormaliseNormals (void) const
| Returns whether or not this Renderable wishes the hardware to normalise normals.
virtual const PlaneList & | getClipPlanes () const
virtual bool | getCastsShadows (void) const
| Method which reports whether this renderable would normally cast a shadow.
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.
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index.
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

## Protected Types

typedef std::map< size_t, Vector4 > | CustomParameterMap

## Protected Attributes

Material * | mMaterial
RenderOperation | mRenderOp
ShadowRenderable * | mLightCap
CustomParameterMap | mCustomParameters

## Static Protected Attributes

const PlaneList | msDummyPlaneList

## 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 43 of file OgreShadowCaster.h.

## Member Typedef Documentation

typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap`[protected, inherited]`

| Definition at line 232 of file OgreRenderable.h.

## Constructor & Destructor Documentation

Ogre::ShadowRenderable::ShadowRenderable | ( |  | ) |

| Definition at line 50 of file OgreShadowCaster.h.

virtual Ogre::ShadowRenderable::~ShadowRenderable | ( |  | ) | `[virtual]`

| Definition at line 51 of file OgreShadowCaster.h.

## Member Function Documentation

virtual void Ogre::Renderable::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry,
|  | GpuProgramParameters * | params
| ) | const`[virtual, inherited]`

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:

  constantEntry | The auto constant entry referring to the parameter being updated
  params | The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::TerrainRenderable.

Definition at line 218 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::index, params, and Ogre::GpuProgramParameters::setConstant().

Referenced by Ogre::GpuProgramParameters::_updateAutoParamsNoLights().

virtual bool Ogre::Renderable::getCastsShadows | ( | void |  | ) | const`[virtual, inherited]`

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

Definition at line 153 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::validateRenderableForRendering().

virtual const PlaneList& Ogre::Renderable::getClipPlanes | ( |  | ) | const`[virtual, inherited]`

| Definition at line 145 of file OgreRenderable.h. References Ogre::PlaneList. Referenced by Ogre::SceneManager::renderSingleObject().

const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const`[inherited]`

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

Parameters:

  see | setCustomParaemter for full details.

Definition at line 179 of file OgreRenderable.h.

References Except.

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

| Get the light cap version of this renderable. Definition at line 90 of file OgreShadowCaster.h. Referenced by Ogre::ShadowCaster::generateShadowVolume(), and Ogre::SceneManager::renderShadowVolumesToStencil().

const LightList& Ogre::ShadowRenderable::getLights | ( | void |  | ) | const`[virtual]`

| Overridden from Renderable. Implements Ogre::Renderable. Definition at line 71 of file OgreShadowCaster.h. References Ogre::LightList.

Material* Ogre::ShadowRenderable::getMaterial | ( | void |  | ) | const`[virtual]`

| Overridden from Renderable. Implements Ogre::Renderable. Definition at line 57 of file OgreShadowCaster.h.

virtual bool Ogre::Renderable::getNormaliseNormals | ( | void |  | ) | const`[virtual, inherited]`

| Returns whether or not this Renderable wishes the hardware to normalise normals. Reimplemented in Ogre::SubEntity. Definition at line 137 of file OgreRenderable.h. Referenced by Ogre::SceneManager::renderSingleObject().

virtual unsigned short Ogre::Renderable::getNumWorldTransforms | ( | void |  | ) | const`[virtual, inherited]`

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::SubEntity, and Ogre::BorderRenderable.

Definition at line 103 of file OgreRenderable.h.

Referenced by Ogre::AutoParamDataSource::getWorldMatrix(), Ogre::AutoParamDataSource::getWorldMatrixArray(), Ogre::AutoParamDataSource::getWorldMatrixCount(), and Ogre::SceneManager::renderSingleObject().

virtual SceneDetailLevel Ogre::Renderable::getRenderDetail | ( |  | ) | const`[virtual, inherited]`

| Returns the preferred rasterisation mode of this renderable. Reimplemented in Ogre::SubEntity. Definition at line 134 of file OgreRenderable.h. References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID. Referenced by Ogre::SceneManager::renderSingleObject().

void Ogre::ShadowRenderable::getRenderOperation | ( | RenderOperation & | op | ) | `[virtual]`

| Overridden from Renderable. Implements Ogre::Renderable. Definition at line 59 of file OgreShadowCaster.h.

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

| Get the internal render operation for set up. Definition at line 61 of file OgreShadowCaster.h. Referenced by Ogre::ShadowCaster::generateShadowVolume().

Real Ogre::ShadowRenderable::getSquaredViewDepth | ( | const Camera * | cam | ) | const`[virtual]`

| Overridden from Renderable. Implements Ogre::Renderable. Definition at line 69 of file OgreShadowCaster.h. References Ogre::Real.

virtual Technique* Ogre::Renderable::getTechnique | ( | void |  | ) | const`[virtual, inherited]`

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

Definition at line 68 of file OgreRenderable.h.

Referenced by Ogre::RenderPriorityGroup::addRenderable().

const Quaternion& Ogre::ShadowRenderable::getWorldOrientation | ( | void |  | ) | const`[pure virtual]`

| Overridden from Renderable. Implements Ogre::Renderable. Implemented in Ogre::Entity::EntityShadowRenderable.

const Vector3& Ogre::ShadowRenderable::getWorldPosition | ( | void |  | ) | const`[pure virtual]`

| Overridden from Renderable. Implements Ogre::Renderable. Implemented in Ogre::Entity::EntityShadowRenderable.

void Ogre::ShadowRenderable::getWorldTransforms | ( | Matrix4 * | xform | ) | const`[pure virtual]`

| Overridden from Renderable. Implements Ogre::Renderable. Implemented in Ogre::Entity::EntityShadowRenderable.

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.

Referenced by Ogre::SceneManager::renderShadowVolumesToStencil().

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. Referenced by Ogre::SceneManager::renderShadowVolumesToStencil().

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:

  index | The 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.
  value | The value to associate.

Definition at line 170 of file OgreRenderable.h.

void Ogre::ShadowRenderable::setMaterial | ( | Material * | 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 55 of file OgreShadowCaster.h.

virtual bool Ogre::Renderable::useIdentityProjection | ( | void |  | ) | const`[virtual, 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 override this.

Reimplemented in Ogre::GuiElement, Ogre::Rectangle2D, and Ogre::BorderRenderable.

Definition at line 113 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().

virtual bool Ogre::Renderable::useIdentityView | ( | void |  | ) | const`[virtual, inherited]`

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

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 override this.

Reimplemented in Ogre::GuiElement, Ogre::Rectangle2D, and Ogre::BorderRenderable.

Definition at line 123 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().

## Member Data Documentation

CustomParameterMap Ogre::Renderable::mCustomParameters`[protected, inherited]`

| Definition at line 233 of file OgreRenderable.h.

ShadowRenderable* Ogre::ShadowRenderable::mLightCap`[protected]`

| Definition at line 48 of file OgreShadowCaster.h. Referenced by Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable().

Material* Ogre::ShadowRenderable::mMaterial`[protected]`

| Definition at line 46 of file OgreShadowCaster.h.

RenderOperation Ogre::ShadowRenderable::mRenderOp`[protected]`

| Definition at line 47 of file OgreShadowCaster.h. Referenced by Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable(), Ogre::Entity::EntityShadowRenderable::rebindPositionBuffer(), and Ogre::Entity::EntityShadowRenderable::~EntityShadowRenderable().

const PlaneList Ogre::Renderable::msDummyPlaneList`[static, protected, inherited]`

| Definition at line 45 of file OgreRenderSystem.cpp.

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

- OgreShadowCaster.h

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:38 2004