OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Renderable Class Referenceabstract

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

#include <OgreRenderable.h>

+ Inheritance diagram for Ogre::Renderable:
+ Collaboration diagram for Ogre::Renderable:

Classes

class  RenderSystemData
 An internal class that should be used only by a render system for internal use. More...
 
class  Visitor
 Visitor object that can be used to iterate over a collection of Renderable instances abstractly. More...
 

Public Member Functions

 Renderable ()
 
virtual ~Renderable ()
 Virtual destructor needed as class has virtual methods. More...
 
virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...
 
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
uint32 getHlmsCasterHash (void) const
 
uint32 getHlmsHash (void) const
 
virtual const LightListgetLights (void) const =0
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
virtual const MaterialPtrgetMaterial (void) const =0
 Retrieves a weak reference to the material this renderable object uses. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
virtual bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
virtual void getRenderOperation (RenderOperation &op)=0
 Gets the render operation required to send this object to the frame buffer. More...
 
virtual RenderSystemDatagetRenderSystemData () const
 Gets RenderSystem private data. More...
 
virtual Real getSquaredViewDepth (const Camera *cam) const =0
 Returns the camera-relative squared depth of this renderable. More...
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection. More...
 
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view. More...
 
virtual OGRE_DEPRECATED const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
virtual void getWorldTransforms (Matrix4 *xform) const =0
 Gets the world transform matrix / matrices for this renderable object. More...
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. More...
 
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. More...
 
void setHlms (Hlms *hlms, const HlmsParamVec &params)
 
virtual void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
virtual void setRenderSystemData (RenderSystemData *val) const
 Sets RenderSystem private data. More...
 
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection. More...
 
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view. More...
 
virtual OGRE_DEPRECATED void setUserAny (const Any &anything)
 

Protected Types

typedef map< size_t, Vector4 >
::type 
CustomParameterMap
 

Protected Attributes

CustomParameterMap mCustomParameters
 
uint32 mHlmsCasterHash
 
uint32 mHlmsHash
 
bool mPolygonModeOverrideable
 
RenderSystemDatamRenderSystemData
 User objects binding. More...
 
bool mUseIdentityProjection
 
bool mUseIdentityView
 
UserObjectBindings mUserObjectBindings
 

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

Member Typedef Documentation

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

Definition at line 422 of file OgreRenderable.h.

Constructor & Destructor Documentation

Ogre::Renderable::Renderable ( )
inline

Definition at line 74 of file OgreRenderable.h.

virtual Ogre::Renderable::~Renderable ( )
inlinevirtual

Virtual destructor needed as class has virtual methods.

Definition at line 76 of file OgreRenderable.h.

Member Function Documentation

virtual void Ogre::Renderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry constantEntry,
GpuProgramParameters params 
) const
inlinevirtual

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

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

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

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::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 225 of file OgreRenderable.h.

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

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

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

uint32 Ogre::Renderable::getHlmsCasterHash ( void  ) const
inline

Definition at line 414 of file OgreRenderable.h.

uint32 Ogre::Renderable::getHlmsHash ( void  ) const
inline

Definition at line 413 of file OgreRenderable.h.

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

Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::ManualObject::ManualObjectSection, Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::BorderRenderable, Ogre::OverlayElement, Ogre::BillboardChain, Ogre::StaticGeometry::GeometryBucket, Ogre::SubEntity, Ogre::OldNode::DebugRenderable, Ogre::Node::DebugRenderable, Ogre::Rectangle2D, Ogre::TextAreaOverlayElement, and Ogre::SimpleRenderable.

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

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

Definition at line 154 of file OgreRenderable.h.

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

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 333 of file OgreRenderable.h.

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

Gets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 400 of file OgreRenderable.h.

virtual Real Ogre::Renderable::getSquaredViewDepth ( const Camera cam) const
pure virtual
virtual Technique* Ogre::Renderable::getTechnique ( void  ) const
inlinevirtual

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::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 95 of file OgreRenderable.h.

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

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

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

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

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

Definition at line 350 of file OgreRenderable.h.

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

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

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

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

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

Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::Camera, Ogre::ManualObject::ManualObjectSection, Ogre::TerrainQuadTreeNode::Rend, Ogre::BorderRenderable, Ogre::OverlayElement, Ogre::BillboardChain, Ogre::StaticGeometry::GeometryBucket, Ogre::SubEntity, Ogre::BaseInstanceBatchVTF, Ogre::OldNode::DebugRenderable, Ogre::Node::DebugRenderable, Ogre::InstanceBatchShader, Ogre::Rectangle2D, Ogre::InstanceBatchHW, Ogre::SimpleRenderable, and Ogre::WireBoundingBox.

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

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

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

Called immediately after the Renderable has been rendered.

Definition at line 129 of file OgreRenderable.h.

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

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

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

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

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

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

void Ogre::Renderable::setHlms ( Hlms hlms,
const HlmsParamVec params 
)
inline

Definition at line 416 of file OgreRenderable.h.

References Ogre::Hlms::calculateHashFor().

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

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

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData val) const
inlinevirtual

Sets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 408 of file OgreRenderable.h.

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

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

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

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

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any anything)
inlinevirtual
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.

Definition at line 345 of file OgreRenderable.h.

Member Data Documentation

CustomParameterMap Ogre::Renderable::mCustomParameters
protected

Definition at line 423 of file OgreRenderable.h.

uint32 Ogre::Renderable::mHlmsCasterHash
protected

Definition at line 425 of file OgreRenderable.h.

uint32 Ogre::Renderable::mHlmsHash
protected

Definition at line 424 of file OgreRenderable.h.

bool Ogre::Renderable::mPolygonModeOverrideable
protected

Definition at line 426 of file OgreRenderable.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData
mutableprotected

User objects binding.

Definition at line 430 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityProjection
protected

Definition at line 427 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView
protected

Definition at line 428 of file OgreRenderable.h.

UserObjectBindings Ogre::Renderable::mUserObjectBindings
protected

Definition at line 429 of file OgreRenderable.h.


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