Abstract class defining the interface all renderable objects must implement. More...
#include <OgreRenderable.h>
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 Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
virtual const LightList & | getLights (void) const =0 |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
virtual const MaterialPtr & | getMaterial (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 RenderSystemData * | getRenderSystemData () 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 Technique * | getTechnique (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 Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () 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... | |
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 |
bool | mPolygonModeOverrideable |
RenderSystemData * | mRenderSystemData |
User objects binding. More... | |
bool | mUseIdentityProjection |
bool | mUseIdentityView |
UserObjectBindings | mUserObjectBindings |
Abstract class defining the interface all renderable objects must implement.
Definition at line 63 of file OgreRenderable.h.
|
protected |
Definition at line 414 of file OgreRenderable.h.
|
inline |
Definition at line 73 of file OgreRenderable.h.
|
inlinevirtual |
Virtual destructor needed as class has virtual methods.
Definition at line 75 of file OgreRenderable.h.
|
inlinevirtual |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
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::SubEntity.
Definition at line 307 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
|
inlinevirtual |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.
Definition at line 224 of file OgreRenderable.h.
|
inline |
Gets the custom value associated with this Renderable at the given index.
index | Index of the parameter to retrieve. |
Definition at line 268 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
pure virtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::OverlayElement, Ogre::ManualObject::ManualObjectSection, Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::BorderRenderable, Ogre::BillboardChain, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, Ogre::Node::DebugRenderable, Ogre::SimpleRenderable, and Ogre::ShadowRenderable.
|
pure virtual |
Retrieves a weak reference to the material this renderable object uses.
Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::ManualObject::ManualObjectSection, Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::BorderRenderable, Ogre::OverlayElement, Ogre::BillboardChain, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, Ogre::SubEntity, Ogre::Node::DebugRenderable, Ogre::SimpleRenderable, Ogre::TextAreaOverlayElement, and Ogre::ShadowRenderable.
|
inlinevirtual |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.
Definition at line 153 of file OgreRenderable.h.
|
inlinevirtual |
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.
|
pure virtual |
Gets the render operation required to send this object to the frame buffer.
Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::ManualObject::ManualObjectSection, Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::BorderRenderable, Ogre::BillboardChain, Ogre::StaticGeometry::GeometryBucket, Ogre::SubEntity, Ogre::Node::DebugRenderable, Ogre::PanelOverlayElement, Ogre::SimpleRenderable, Ogre::TextAreaOverlayElement, and Ogre::ShadowRenderable.
|
inlinevirtual |
Gets RenderSystem private data.
Definition at line 399 of file OgreRenderable.h.
Returns the camera-relative squared depth of this renderable.
Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::OverlayElement, Ogre::ManualObject::ManualObjectSection, Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::BorderRenderable, Ogre::Volume::Chunk, Ogre::BillboardChain, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, Ogre::Node::DebugRenderable, Ogre::Rectangle2D, Ogre::WireBoundingBox, and Ogre::ShadowRenderable.
Referenced by Ogre::QueuedRenderableCollection::DepthSortDescendingLess::operator()(), and Ogre::QueuedRenderableCollection::RadixSortFunctorDistance::operator()().
|
inlinevirtual |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 94 of file OgreRenderable.h.
|
inline |
Returns whether or not to use an 'identity' projection.
Definition at line 178 of file OgreRenderable.h.
|
inline |
Returns whether or not to use an 'identity' view.
Definition at line 203 of file OgreRenderable.h.
|
inlinevirtual |
Definition at line 349 of file OgreRenderable.h.
|
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.
Definition at line 355 of file OgreRenderable.h.
|
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.
Definition at line 361 of file OgreRenderable.h.
|
pure virtual |
Gets the world transform matrix / matrices for this renderable object.
Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::ManualObject::ManualObjectSectionShadowRenderable, Ogre::ManualObject::ManualObjectSection, Ogre::Camera, Ogre::TerrainQuadTreeNode::Rend, Ogre::Entity::EntityShadowRenderable, Ogre::BorderRenderable, Ogre::StaticGeometry::LODBucket::LODShadowRenderable, Ogre::OverlayElement, Ogre::BillboardChain, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::Node::DebugRenderable, Ogre::InstanceBatchHW, Ogre::InstanceBatchShader, Ogre::SimpleRenderable, Ogre::ShadowRenderable, Ogre::Rectangle2D, and Ogre::WireBoundingBox.
|
inline |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
Definition at line 259 of file OgreRenderable.h.
|
inlinevirtual |
Called immediately after the Renderable has been rendered.
Definition at line 128 of file OgreRenderable.h.
|
inlinevirtual |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::BillboardChain.
Definition at line 123 of file OgreRenderable.h.
|
inline |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
Definition at line 250 of file OgreRenderable.h.
|
inline |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program 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 241 of file OgreRenderable.h.
|
inlinevirtual |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
override | true 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.
|
inlinevirtual |
Sets RenderSystem private data.
Definition at line 407 of file OgreRenderable.h.
|
inline |
Sets whether or not to use an 'identity' projection.
Definition at line 164 of file OgreRenderable.h.
|
inline |
Sets whether or not to use an 'identity' view.
Definition at line 189 of file OgreRenderable.h.
|
inlinevirtual |
Sets any kind of user value on this object.
Definition at line 344 of file OgreRenderable.h.
|
protected |
Definition at line 415 of file OgreRenderable.h.
|
protected |
Definition at line 416 of file OgreRenderable.h.
|
mutableprotected |
User objects binding.
Definition at line 420 of file OgreRenderable.h.
|
protected |
Definition at line 417 of file OgreRenderable.h.
|
protected |
Definition at line 418 of file OgreRenderable.h.
|
protected |
Definition at line 419 of file OgreRenderable.h.