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. | |
virtual const MaterialPtr & | getMaterial (void) const =0 |
Retrieves a weak reference 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 bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. | |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. | |
virtual void | getWorldTransforms (Matrix4 *xform) const =0 |
Gets the world transform matrix / matrices for this renderable object. | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
virtual Real | getSquaredViewDepth (const Camera *cam) const =0 |
Returns the camera-relative squared depth of this renderable. | |
virtual const LightList & | getLights (void) const =0 |
Gets a list of lights, ordered relative to how close they are to this renderable. | |
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. | |
virtual void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
virtual bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
virtual void | setUserAny (const Any &anything) |
virtual const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. | |
virtual RenderSystemData * | getRenderSystemData () const |
Sets render system private data. | |
virtual void | setRenderSystemData (RenderSystemData *val) const |
gets render system private data | |
Protected Types | |
typedef map< size_t, Vector4 > ::type | CustomParameterMap |
Protected Attributes | |
CustomParameterMap | mCustomParameters |
bool | mPolygonModeOverrideable |
bool | mUseIdentityProjection |
bool | mUseIdentityView |
UserObjectBindings | mUserObjectBindings |
RenderSystemData * | mRenderSystemData |
Abstract class defining the interface all renderable objects must implement.
Definition at line 62 of file OgreRenderable.h.
typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap [protected] |
Definition at line 395 of file OgreRenderable.h.
Ogre::Renderable::Renderable | ( | ) |
Definition at line 72 of file OgreRenderable.h.
virtual Ogre::Renderable::~Renderable | ( | ) | [virtual] |
Virtual destructor needed as class has virtual methods.
Definition at line 74 of file OgreRenderable.h.
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.
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. |
Definition at line 288 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 [virtual] |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket.
Definition at line 223 of file OgreRenderable.h.
const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const |
Gets the custom value associated with this Renderable at the given index.
@see | setCustomParaemter for full details. |
Definition at line 249 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_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.
Implemented in Ogre::BillboardChain, Ogre::BillboardSet, Ogre::Frustum, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SimpleRenderable.
virtual const MaterialPtr& Ogre::Renderable::getMaterial | ( | void | ) | const [pure virtual] |
Retrieves a weak reference to the material this renderable object uses.
Implemented in Ogre::BillboardChain, Ogre::BillboardSet, Ogre::Frustum, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SimpleRenderable.
virtual unsigned short Ogre::Renderable::getNumWorldTransforms | ( | void | ) | const [virtual] |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket.
Definition at line 152 of file OgreRenderable.h.
virtual bool Ogre::Renderable::getPolygonModeOverrideable | ( | void | ) | const [virtual] |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Definition at line 313 of file OgreRenderable.h.
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::BillboardChain, Ogre::BillboardSet, Ogre::Frustum, and Ogre::SimpleRenderable.
virtual RenderSystemData* Ogre::Renderable::getRenderSystemData | ( | ) | const [virtual] |
Sets render system private data.
Definition at line 380 of file OgreRenderable.h.
Returns the camera-relative squared depth of this renderable.
Implemented in Ogre::BillboardChain, Ogre::BillboardSet, Ogre::Frustum, Ogre::InstancedGeometry::GeometryBucket, Ogre::Rectangle2D, and Ogre::WireBoundingBox.
Referenced by Ogre::QueuedRenderableCollection::RadixSortFunctorDistance::operator()(), and Ogre::QueuedRenderableCollection::DepthSortDescendingLess::operator()().
virtual Technique* Ogre::Renderable::getTechnique | ( | void | ) | const [virtual] |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket.
Definition at line 93 of file OgreRenderable.h.
bool Ogre::Renderable::getUseIdentityProjection | ( | void | ) | const |
Returns whether or not to use an 'identity' projection.
Definition at line 177 of file OgreRenderable.h.
bool Ogre::Renderable::getUseIdentityView | ( | void | ) | const |
Returns whether or not to use an 'identity' view.
Definition at line 202 of file OgreRenderable.h.
virtual const Any& Ogre::Renderable::getUserAny | ( | void | ) | const [virtual] |
Retrieves the custom user value associated with this object.
Definition at line 330 of file OgreRenderable.h.
UserObjectBindings& Ogre::Renderable::getUserObjectBindings | ( | ) |
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 336 of file OgreRenderable.h.
const UserObjectBindings& Ogre::Renderable::getUserObjectBindings | ( | ) | const |
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 342 of file OgreRenderable.h.
virtual void Ogre::Renderable::getWorldTransforms | ( | Matrix4 * | xform | ) | const [pure virtual] |
Gets the world transform matrix / matrices for this renderable object.
Implemented in Ogre::BillboardChain, Ogre::BillboardSet, Ogre::Frustum, Ogre::InstancedGeometry::GeometryBucket, Ogre::Rectangle2D, Ogre::SimpleRenderable, and Ogre::WireBoundingBox.
virtual void Ogre::Renderable::postRender | ( | SceneManager * | sm, | |
RenderSystem * | rsys | |||
) | [virtual] |
Called immediately after the Renderable has been rendered.
Definition at line 127 of file OgreRenderable.h.
virtual bool Ogre::Renderable::preRender | ( | SceneManager * | sm, | |
RenderSystem * | rsys | |||
) | [virtual] |
Called just prior to the Renderable being rendered.
Definition at line 122 of file OgreRenderable.h.
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.
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 240 of file OgreRenderable.h.
virtual void Ogre::Renderable::setPolygonModeOverrideable | ( | bool | override | ) | [virtual] |
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 305 of file OgreRenderable.h.
virtual void Ogre::Renderable::setRenderSystemData | ( | RenderSystemData * | val | ) | const [virtual] |
gets render system private data
Definition at line 388 of file OgreRenderable.h.
void Ogre::Renderable::setUseIdentityProjection | ( | bool | useIdentityProjection | ) |
Sets whether or not to use an 'identity' projection.
Definition at line 163 of file OgreRenderable.h.
void Ogre::Renderable::setUseIdentityView | ( | bool | useIdentityView | ) |
Sets whether or not to use an 'identity' view.
Definition at line 188 of file OgreRenderable.h.
virtual void Ogre::Renderable::setUserAny | ( | const Any & | anything | ) | [virtual] |
Sets any kind of user value on this object.
Definition at line 325 of file OgreRenderable.h.
Definition at line 396 of file OgreRenderable.h.
bool Ogre::Renderable::mPolygonModeOverrideable [protected] |
Definition at line 397 of file OgreRenderable.h.
RenderSystemData* Ogre::Renderable::mRenderSystemData [mutable, protected] |
Definition at line 401 of file OgreRenderable.h.
bool Ogre::Renderable::mUseIdentityProjection [protected] |
Definition at line 398 of file OgreRenderable.h.
bool Ogre::Renderable::mUseIdentityView [protected] |
Definition at line 399 of file OgreRenderable.h.
Definition at line 400 of file OgreRenderable.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:59