Ogre::SimpleRenderable Class Reference

Simple implementation of MovableObject and Renderable for single-part custom objects. More...

#include <OgreSimpleRenderable.h>

Inheritance diagram for Ogre::SimpleRenderable:

Public Member Functions
	SimpleRenderable ()
	Constructor.
	SimpleRenderable (const String &name)
	Named constructor.
void	_notifyCurrentCamera (Camera *cam) override
	Internal method to notify the object of the camera to be used for the next rendering operation.
void	_updateRenderQueue (RenderQueue *queue) override
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
const AxisAlignedBox &	getBoundingBox (void) const override
	Retrieves the local axis-aligned bounding box for this object.
const LightList &	getLights (void) const override
	Gets a list of lights, ordered relative to how close they are to this renderable.
const MaterialPtr &	getMaterial (void) const override
	Retrieves a weak reference to the material this renderable object uses.
const String &	getMovableType (void) const override
	Returns the type name of this object.
void	getRenderOperation (RenderOperation &op) override
	Gets the render operation required to send this object to the frame buffer.
void	getWorldTransforms (Matrix4 *xform) const override
	Gets the world transform matrix / matrices for this renderable object.
void	setBoundingBox (const AxisAlignedBox &box)
virtual void	setMaterial (const MaterialPtr &mat)
virtual void	setRenderOperation (const RenderOperation &rend)
void	setTransform (const Affine3 &xform)
void	visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) override
	Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.
Public Member Functions inherited from Ogre::MovableObject
	MovableObject ()
	Constructor.
	MovableObject (const String &name)
	Named constructor.
virtual	~MovableObject ()
	Virtual destructor - read Scott Meyers if you don't know why this is needed.
MovableObjectFactory *	_getCreator (void) const
	Get the creator of this object, if any (internal use only)
LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object.
SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only)
virtual const Affine3 &	_getParentNodeFullTransform (void) const
	Return the full transformation of the parent sceneNode or the attachingPoint node.
virtual void	_notifyAttached (Node *parent, bool isTagPoint=false)
	Internal method called to notify the object that it has been attached to a node.
virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only)
virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only)
virtual void	_notifyMoved (void)
	Internal method called to notify the object that it has been moved.
virtual void	_releaseManualHardwareResources ()
	Notifies the movable object that hardware resources were lost.
virtual void	_restoreManualHardwareResources ()
	Notifies the movable object that hardware resources should be restored.
void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached.
virtual Real	getBoundingRadius (void) const =0
	Retrieves the radius of the origin-centered bounding sphere for this object.
Real	getBoundingRadiusScaled () const
	as getBoundingRadius, but with scaling applied
bool	getCastShadows (void) const override
	Returns whether shadow casting is enabled for this object.
uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object.
Listener *	getListener (void) const
	Gets the current listener for this object.
const String &	getName (void) const
	Returns the name of this object.
Node *	getParentNode (void) const
	Returns the node to which this object is attached.
SceneNode *	getParentSceneNode (void) const
	Returns the scene node to which this object is attached.
Real	getPointExtrusionDistance (const Light *l) const override
	Get the distance to extrude for a point/spot light.
virtual uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object.
bool	getReceivesShadows ()
	Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered.
Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity.
virtual uint32	getTypeFlags (void) const
	Get the 'type flags' for this MovableObject.
const Any &	getUserAny (void) const
UserObjectBindings &	getUserObjectBindings ()
	Class that provides convenient interface to establish a linkage between custom user application objects and Ogre core classes.
const UserObjectBindings &	getUserObjectBindings () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object.
bool	getVisible (void) const
	Gets this object whether to be visible or not, if it has a renderable component.
const AxisAlignedBox &	getWorldBoundingBox (bool derive=false) const override
	Retrieves the axis-aligned bounding box for this object in world coordinates.
virtual const Sphere &	getWorldBoundingSphere (bool derive=false) const
	Retrieves the worldspace bounding sphere for this object.
bool	isAttached (void) const
	Returns true if this object is attached to a SceneNode or TagPoint.
bool	isDebugDisplayEnabled (void) const
	Gets whether debug display of this object is enabled.
virtual bool	isInScene (void) const
	Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.
bool	isParentTagPoint () const
	Gets whether the parent node is a TagPoint (or a SceneNode)
virtual bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not.
const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object.
void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.
void	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled.
void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object.
void	setListener (Listener *listener)
	Sets a listener for this object.
void	setQueryFlags (uint32 flags)
	Sets the query flags for this object.
void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered.
void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through.
virtual void	setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
	Sets the render queue group and group priority this entity will be rendered through.
void	setUserAny (const Any &anything)
void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object.
void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component.
Public Member Functions inherited from Ogre::ShadowCaster
virtual	~ShadowCaster ()
const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
	Gets the world space bounding box of the dark cap, as extruded using the light provided.
virtual EdgeData *	getEdgeList (void)
	Returns details of the edges which might be used to determine a silhouette.
const AxisAlignedBox &	getLightCapBounds (void) const
	Gets the world space bounding box of the light cap.
virtual const ShadowRenderableList &	getShadowVolumeRenderableList (const Light *light, const HardwareIndexBufferPtr &indexBuffer, size_t &indexBufferUsedSize, float extrusionDistance, int flags=0)
	Gets an list of the renderables required to render the shadow volume.
bool	hasEdgeList ()
	Returns whether the object has a valid edge list.
Public Member Functions inherited from Ogre::AnimableObject
	AnimableObject ()
virtual	~AnimableObject ()
virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value.
virtual const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object.
Public Member Functions inherited from Ogre::Renderable
	Renderable ()
virtual	~Renderable ()
	Virtual destructor needed as class has virtual methods.
uint16	_getMaterialLodIndex () const
virtual void	_updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
	Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
const Vector4f &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index.
virtual uint16	getNumWorldTransforms (void) const
	Returns the number of world transform matrices this renderable requires.
bool	getPolygonModeOverrideable (void) const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual Real	getSquaredViewDepth (const Camera *cam) const =0
	Returns the squared distance between the camera and this renderable.
virtual Technique *	getTechnique (void) const
	Retrieves a pointer to the Material Technique this renderable object uses.
bool	getUseIdentityProjection (void) const
	Returns whether or not to use an 'identity' projection.
bool	getUseIdentityView (void) const
	Returns whether or not to use an 'identity' view.
const Any &	getUserAny (void) const
UserObjectBindings &	getUserObjectBindings ()
	Class that provides convenient interface to establish a linkage between custom user application objects and Ogre core classes.
const UserObjectBindings &	getUserObjectBindings () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index.
virtual void	postRender (SceneManager *sm, RenderSystem *rsys)
	Called immediately after the Renderable has been rendered.
virtual bool	preRender (SceneManager *sm, RenderSystem *rsys)
	Called just prior to the Renderable being rendered.
void	removeCustomParameter (size_t index)
	Removes a custom value which is associated with this Renderable at the given index.
void	setCustomParameter (size_t index, const Vector4f &value)
	Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
void	setUseIdentityProjection (bool useIdentityProjection)
	Sets whether or not to use an 'identity' projection.
void	setUseIdentityView (bool useIdentityView)
	Sets whether or not to use an 'identity' view.
void	setUserAny (const Any &anything)

Additional Inherited Members
Public Types inherited from Ogre::ShadowCaster
typedef Ogre::ShadowRenderableList	ShadowRenderableList
typedef VectorIterator< ShadowRenderableList >	ShadowRenderableListIterator
Public Types inherited from Ogre::Renderable
enum	{ DEFAULT_PRIORITY = 100 }
Static Public Member Functions inherited from Ogre::MovableObject
static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances.
static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances.
static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances.
static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances.
Static Public Member Functions inherited from Ogre::ShadowCaster
static void	clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
	Common implementation of releasing shadow renderables.
static void	extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
	Utility method for extruding vertices based on a light.

Detailed Description

Simple implementation of MovableObject and Renderable for single-part custom objects.

See also

ManualObject for a simpler interface with more flexibility

Constructor & Destructor Documentation

SimpleRenderable() [1/2]

Ogre::SimpleRenderable::SimpleRenderable

(

)

Constructor.

SimpleRenderable() [2/2]

Ogre::SimpleRenderable::SimpleRenderable

(

const String &

name

)

Named constructor.

Member Function Documentation

setMaterial()

virtual void Ogre::SimpleRenderable::setMaterial ( const MaterialPtr &  mat )

virtual

Reimplemented in Ogre::Volume::Chunk.

getMaterial()

const MaterialPtr & Ogre::SimpleRenderable::getMaterial ( void  ) const

overridevirtual

Retrieves a weak reference to the material this renderable object uses.

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.

Implements Ogre::Renderable.

setRenderOperation()

virtual void Ogre::SimpleRenderable::setRenderOperation ( const RenderOperation &  rend )

virtual

getRenderOperation()

void Ogre::SimpleRenderable::getRenderOperation ( RenderOperation &  op )

overridevirtual

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

Implements Ogre::Renderable.

setTransform()

void Ogre::SimpleRenderable::setTransform

(

const Affine3 &

xform

)

getWorldTransforms()

void Ogre::SimpleRenderable::getWorldTransforms ( Matrix4 *  xform ) const

overridevirtual

Gets the world transform matrix / matrices for this renderable object.

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.

Note

Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.

This method will populate transform with 1 matrix if it does not use GPU vertex blending. If it does use GPU vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.

Note

If MeshManager::getBonesUseObjectSpace() is true, the first matrix must contain the world transform of the object, and the rest of the matrices must contain the bone transforms in object space.

Implements Ogre::Renderable.

_notifyCurrentCamera()

void Ogre::SimpleRenderable::_notifyCurrentCamera ( Camera *  cam )

overridevirtual

Internal method to notify the object of the camera to be used for the next rendering operation.

Certain objects may want to do specific processing based on the camera position. This method notifies them in case they wish to do this.

Reimplemented from Ogre::MovableObject.

setBoundingBox()

void Ogre::SimpleRenderable::setBoundingBox

(

const AxisAlignedBox &

box

)

getBoundingBox()

const AxisAlignedBox & Ogre::SimpleRenderable::getBoundingBox ( void  ) const

overridevirtual

Retrieves the local axis-aligned bounding box for this object.

This bounding box is in local coordinates.

Implements Ogre::MovableObject.

_updateRenderQueue()

void Ogre::SimpleRenderable::_updateRenderQueue ( RenderQueue *  queue )

overridevirtual

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Implements Ogre::MovableObject.

visitRenderables()

void Ogre::SimpleRenderable::visitRenderables ( Renderable::Visitor *  visitor, bool  debugRenderables = false  )

overridevirtual

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters

visitor	Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderables	If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

getMovableType()

const String & Ogre::SimpleRenderable::getMovableType ( void  ) const

overridevirtual

Returns the type name of this object.

Implements Ogre::MovableObject.

Reimplemented in Ogre::Volume::Chunk.

getLights()

const LightList & Ogre::SimpleRenderable::getLights ( void  ) const

overridevirtual

Gets a list of lights, ordered relative to how close they are to this renderable.

Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

---

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

• OgreSimpleRenderable.h