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

Ogre::Entity::EntityShadowRenderable Class Reference

Nested class to allow entity shadows. More...

#include <OgreEntity.h>

Inheritance diagram for Ogre::Entity::EntityShadowRenderable:

Inheritance graph
[legend]
List of all members.

Public Methods

 EntityShadowRenderable (Entity *parent, HardwareIndexBufferSharedPtr *indexBuffer, const VertexData *vertexData, bool createSeparateLightCap, SubEntity *subent, bool isLightCap=false)
 ~EntityShadowRenderable ()
void getWorldTransforms (Matrix4 *xform) const
 Overridden from ShadowRenderable.

const QuaterniongetWorldOrientation (void) const
 Overridden from ShadowRenderable.

const Vector3getWorldPosition (void) const
 Overridden from ShadowRenderable.

HardwareVertexBufferSharedPtr getPositionBuffer (void)
HardwareVertexBufferSharedPtr getWBuffer (void)
void rebindPositionBuffer (void)
 Rebind the source positions (for temp buffer users).

bool isVisible (void) const
 Overridden from 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.

MaterialgetMaterial (void) const
 Overridden from Renderable.

void getRenderOperation (RenderOperation &op)
 Overridden from Renderable.

RenderOperationgetRenderOperationForUpdate (void)
 Get the internal render operation for set up.

Real getSquaredViewDepth (const Camera *cam) const
 Overridden from Renderable.

const LightListgetLights (void) const
 Overridden from Renderable.

bool isLightCapSeparate (void) const
 Does this renderable require a separate light cap?

ShadowRenderablegetLightCapRenderable (void)
 Get the light cap version of this renderable.

virtual TechniquegetTechnique (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 PlaneListgetClipPlanes () const
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow.


Protected Attributes

EntitymParent
HardwareVertexBufferSharedPtr mPositionBuffer
HardwareVertexBufferSharedPtr mWBuffer
const VertexDatamOriginalVertexData
unsigned short mOriginalPosBufferBinding
SubEntitymSubEntity
 Link to SubEntity, only present if SubEntity has it's own geometry.

MaterialmMaterial
RenderOperation mRenderOp
ShadowRenderablemLightCap

Detailed Description

Nested class to allow entity shadows.

Definition at line 205 of file OgreEntity.h.


Constructor & Destructor Documentation

Ogre::Entity::EntityShadowRenderable::EntityShadowRenderable Entity   parent,
HardwareIndexBufferSharedPtr   indexBuffer,
const VertexData   vertexData,
bool    createSeparateLightCap,
SubEntity   subent,
bool    isLightCap = false
 

Definition at line 978 of file OgreEntity.cpp.

References Ogre::VertexDeclaration::addElement(), Ogre::VertexDeclaration::findElementBySemantic(), Ogre::VertexBufferBinding::getBuffer(), Ogre::VertexElement::getSource(), Ogre::VertexData::hardwareShadowVolWBuffer, Ogre::IndexData::indexBuffer, Ogre::RenderOperation::indexData, Ogre::IndexData::indexStart, Ogre::SharedPtr< HardwareVertexBuffer >::isNull(), Ogre::ShadowRenderable::mLightCap, mOriginalPosBufferBinding, mOriginalVertexData, mPositionBuffer, Ogre::ShadowRenderable::mRenderOp, mWBuffer, Ogre::VertexBufferBinding::setBinding(), Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::RenderOperation::vertexData, Ogre::VertexData::vertexDeclaration, Ogre::VertexData::vertexStart, Ogre::VES_POSITION, Ogre::VES_TEXTURE_COORDINATES, Ogre::VET_FLOAT1, and Ogre::VET_FLOAT3.

Ogre::Entity::EntityShadowRenderable::~EntityShadowRenderable  
 

Definition at line 1035 of file OgreEntity.cpp.

References Ogre::RenderOperation::indexData, Ogre::ShadowRenderable::mRenderOp, and Ogre::RenderOperation::vertexData.


Member Function Documentation

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 150 of file OgreRenderable.h.

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

virtual const PlaneList& Ogre::Renderable::getClipPlanes   const [virtual, inherited]
 

Definition at line 142 of file OgreRenderable.h.

References Ogre::PlaneList.

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

ShadowRenderable* Ogre::ShadowRenderable::getLightCapRenderable void    [inherited]
 

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, inherited]
 

Overridden from Renderable.

Implements Ogre::Renderable.

Definition at line 71 of file OgreShadowCaster.h.

References Ogre::LightList.

Material* Ogre::ShadowRenderable::getMaterial void    const [virtual, inherited]
 

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 134 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 100 of file OgreRenderable.h.

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

HardwareVertexBufferSharedPtr Ogre::Entity::EntityShadowRenderable::getPositionBuffer void   
 

Definition at line 232 of file OgreEntity.h.

Referenced by Ogre::Entity::getShadowVolumeRenderableIterator().

virtual SceneDetailLevel Ogre::Renderable::getRenderDetail   const [virtual, inherited]
 

Returns the preferred rasterisation mode of this renderable.

Reimplemented in Ogre::SubEntity.

Definition at line 131 of file OgreRenderable.h.

References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID.

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

void Ogre::ShadowRenderable::getRenderOperation RenderOperation   op [virtual, inherited]
 

Overridden from Renderable.

Implements Ogre::Renderable.

Definition at line 59 of file OgreShadowCaster.h.

RenderOperation* Ogre::ShadowRenderable::getRenderOperationForUpdate void    [inherited]
 

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, inherited]
 

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 65 of file OgreRenderable.h.

References Ogre::Material::getBestTechnique().

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

HardwareVertexBufferSharedPtr Ogre::Entity::EntityShadowRenderable::getWBuffer void   
 

Definition at line 233 of file OgreEntity.h.

const Quaternion & Ogre::Entity::EntityShadowRenderable::getWorldOrientation void    const [virtual]
 

Overridden from ShadowRenderable.

Implements Ogre::ShadowRenderable.

Definition at line 1056 of file OgreEntity.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::MovableObject::getParentNode(), and mParent.

const Vector3 & Ogre::Entity::EntityShadowRenderable::getWorldPosition void    const [virtual]
 

Overridden from ShadowRenderable.

Implements Ogre::ShadowRenderable.

Definition at line 1061 of file OgreEntity.cpp.

References Ogre::Node::_getDerivedPosition(), Ogre::MovableObject::getParentNode(), and mParent.

void Ogre::Entity::EntityShadowRenderable::getWorldTransforms Matrix4   xform const [virtual]
 

Overridden from ShadowRenderable.

Implements Ogre::ShadowRenderable.

Definition at line 1041 of file OgreEntity.cpp.

References Ogre::Entity::_getNumBoneMatrices(), Ogre::MovableObject::_getParentNodeFullTransform(), and mParent.

bool Ogre::ShadowRenderable::isLightCapSeparate void    const [inherited]
 

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

bool Ogre::Entity::EntityShadowRenderable::isVisible void    const [virtual]
 

Overridden from ShadowRenderable.

Reimplemented from Ogre::ShadowRenderable.

Definition at line 1078 of file OgreEntity.cpp.

References Ogre::SubEntity::isVisible(), and mSubEntity.

void Ogre::Entity::EntityShadowRenderable::rebindPositionBuffer void   
 

Rebind the source positions (for temp buffer users).

Definition at line 1066 of file OgreEntity.cpp.

References Ogre::VertexBufferBinding::getBuffer(), mOriginalPosBufferBinding, mOriginalVertexData, mPositionBuffer, Ogre::ShadowRenderable::mRenderOp, Ogre::VertexBufferBinding::setBinding(), Ogre::VertexData::vertexBufferBinding, and Ogre::RenderOperation::vertexData.

void Ogre::ShadowRenderable::setMaterial Material   mat [inherited]
 

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 110 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 120 of file OgreRenderable.h.

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


Member Data Documentation

ShadowRenderable* Ogre::ShadowRenderable::mLightCap [protected, inherited]
 

Definition at line 48 of file OgreShadowCaster.h.

Referenced by EntityShadowRenderable().

Material* Ogre::ShadowRenderable::mMaterial [protected, inherited]
 

Definition at line 46 of file OgreShadowCaster.h.

unsigned short Ogre::Entity::EntityShadowRenderable::mOriginalPosBufferBinding [protected]
 

Definition at line 216 of file OgreEntity.h.

Referenced by EntityShadowRenderable(), and rebindPositionBuffer().

const VertexData* Ogre::Entity::EntityShadowRenderable::mOriginalVertexData [protected]
 

Definition at line 214 of file OgreEntity.h.

Referenced by EntityShadowRenderable(), and rebindPositionBuffer().

Entity* Ogre::Entity::EntityShadowRenderable::mParent [protected]
 

Definition at line 208 of file OgreEntity.h.

Referenced by getWorldOrientation(), getWorldPosition(), and getWorldTransforms().

HardwareVertexBufferSharedPtr Ogre::Entity::EntityShadowRenderable::mPositionBuffer [protected]
 

Definition at line 210 of file OgreEntity.h.

Referenced by EntityShadowRenderable(), and rebindPositionBuffer().

RenderOperation Ogre::ShadowRenderable::mRenderOp [protected, inherited]
 

Definition at line 47 of file OgreShadowCaster.h.

Referenced by EntityShadowRenderable(), rebindPositionBuffer(), and ~EntityShadowRenderable().

SubEntity* Ogre::Entity::EntityShadowRenderable::mSubEntity [protected]
 

Link to SubEntity, only present if SubEntity has it's own geometry.

Definition at line 218 of file OgreEntity.h.

Referenced by isVisible().

HardwareVertexBufferSharedPtr Ogre::Entity::EntityShadowRenderable::mWBuffer [protected]
 

Definition at line 212 of file OgreEntity.h.

Referenced by EntityShadowRenderable().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:26:04 2004