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

# Ogre::Renderable Class Reference

Abstract class defining the interface all renderable objects must implement. More...

`#include <OgreRenderable.h>`

Inheritance diagram for Ogre::Renderable:

[legend]
List of all members.

## Public Methods

virtual | ~Renderable ()
| Virtual destructor needed as class has virtual methods.
virtual Material * | getMaterial (void) const=0
| Retrieves a pointer to the material this renderable object uses.
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses.
virtual void | getRenderOperation (RenderOperation &op)=0
| Gets the render operation required to send this object to the frame buffer.
virtual void | getWorldTransforms (Matrix4 *xform) const=0
| Gets the world transform matrix / matrices for this renderable object.
virtual const Quaternion & | getWorldOrientation (void) const=0
| Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
virtual const Vector3 & | getWorldPosition (void) const=0
| Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
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 Real | getSquaredViewDepth (const Camera *cam) const=0
| Returns the camera-relative squared depth of this renderable.
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 LightList & | getLights (void) const=0
| Gets a list of lights, ordered relative to how close they are to this renderable.
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

CustomParameterMap | mCustomParameters

## Static Protected Attributes

const PlaneList | msDummyPlaneList

## Detailed Description

Abstract class defining the interface all renderable objects must implement.

Remarks:
  This interface abstracts renderable discrete objects which will be queued in the render pipeline, grouped by material. Classes implementing this interface must be based on a single material, a single world matrix (or a collection of world matrices which are blended by weights), and must be renderable via a single render operation.

  Note that deciding whether to put these objects in the rendering pipeline is done from the more specific classes e.g. entities. Only once it is decided that the specific class is to be rendered is the abstract version created (could be more than one per visible object) and pushed onto the rendering queue.

Definition at line 52 of file OgreRenderable.h.

## Member Typedef Documentation

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

| Definition at line 232 of file OgreRenderable.h.

## Constructor & Destructor Documentation

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

| Virtual destructor needed as class has virtual methods. Definition at line 56 of file OgreRenderable.h.

## Member Function Documentation

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

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]`

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]`

| 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

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.

virtual const LightList& Ogre::Renderable::getLights | ( | void |  | ) | const`[pure 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.

Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::GuiElement, Ogre::Node, Ogre::ShadowRenderable, Ogre::SimpleRenderable, Ogre::SubEntity, Ogre::TagPoint, Ogre::BorderRenderable, and Ogre::TerrainRenderable.

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

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

Retrieves a pointer 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.

Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::GuiElement, Ogre::Node, Ogre::ShadowRenderable, Ogre::SimpleRenderable, Ogre::SubEntity, Ogre::BorderRenderable, and Ogre::TerrainRenderable.

Referenced by Ogre::RenderPriorityGroup::addRenderable(), and Ogre::RenderQueue::addRenderable().

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

| 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]`

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]`

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

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

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

Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::Node, Ogre::ShadowRenderable, Ogre::SimpleRenderable, Ogre::SubEntity, Ogre::BorderRenderable, Ogre::PanelGuiElement, Ogre::TextAreaGuiElement, Ogre::TTYGuiElement, Ogre::OctreeNode, and Ogre::TerrainRenderable.

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

virtual Real Ogre::Renderable::getSquaredViewDepth | ( | const Camera * | cam | ) | const`[pure 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.

Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::GuiElement, Ogre::Node, Ogre::Rectangle2D, Ogre::ShadowRenderable, Ogre::SubEntity, Ogre::WireBoundingBox, Ogre::BorderRenderable, and Ogre::TerrainRenderable.

Referenced by Ogre::RenderPriorityGroup::TransparentQueueItemLess::operator()().

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

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

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

Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.

Implemented in Ogre::BillboardSet, Ogre::Entity::EntityShadowRenderable, Ogre::Frustum, Ogre::GuiElement, Ogre::Node, Ogre::ParticleSystem, Ogre::Rectangle2D, Ogre::ShadowRenderable, Ogre::SimpleRenderable, Ogre::SubEntity, Ogre::WireBoundingBox, Ogre::BorderRenderable, and Ogre::TerrainRenderable.

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

Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.

Implemented in Ogre::BillboardSet, Ogre::Entity::EntityShadowRenderable, Ogre::Frustum, Ogre::GuiElement, Ogre::Node, Ogre::ParticleSystem, Ogre::Rectangle2D, Ogre::ShadowRenderable, Ogre::SimpleRenderable, Ogre::SubEntity, Ogre::WireBoundingBox, Ogre::BorderRenderable, and Ogre::TerrainRenderable.

virtual void Ogre::Renderable::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 xform 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.

Implemented in Ogre::BillboardSet, Ogre::Entity::EntityShadowRenderable, Ogre::Frustum, Ogre::GuiElement, Ogre::Node, Ogre::ParticleSystem, Ogre::Rectangle2D, Ogre::ShadowRenderable, Ogre::SimpleRenderable, Ogre::SubEntity, Ogre::WireBoundingBox, Ogre::BorderRenderable, and Ogre::TerrainRenderable.

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

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

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.

virtual bool Ogre::Renderable::useIdentityProjection | ( | void |  | ) | const`[virtual]`

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]`

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]`

| Definition at line 233 of file OgreRenderable.h.

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

| Definition at line 45 of file OgreRenderSystem.cpp.

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

- OgreRenderable.h
- OgreRenderSystem.cpp

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