Ogre::v1::SimpleRenderable Class Reference

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

#include <OgreSimpleRenderable.h>

Inheritance diagram for Ogre::v1::SimpleRenderable:

Public Member Functions
	SimpleRenderable (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager)
	Constructor. More...
	~SimpleRenderable () override
virtual const AxisAlignedBox &	getBoundingBox () const
const LightList &	getLights () const override
	Gets a list of lights, ordered relative to how close they are to this renderable. More...
virtual const MaterialPtr &	getMaterial () const
const String &	getMovableType () const override
	Overridden from MovableObject. More...
void	getRenderOperation (RenderOperation &op, bool casterPass) override
	Gets the render operation required to send this object to the frame buffer. More...
void	getWorldTransforms (Matrix4 *xform) const override
	Gets the world transform matrix / matrices for this renderable object. More...
void	setBoundingBox (const AxisAlignedBox &box)
void	setMaterial (const MaterialPtr &mat) override
	Sets the given material. Overrides HLMS materials. More...
virtual void	setMaterial (const String &matName)
virtual void	setRenderOperation (const RenderOperation &rend)
void	setWorldTransform (const Matrix4 &xform)
Public Member Functions inherited from Ogre::MovableObject
	MovableObject (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, uint8 renderQueueId)
	Constructor. More...
	MovableObject (ObjectData *objectDataPtrs)
	Don't use this constructor unless you know what you're doing. More...
virtual	~MovableObject ()
	Virtual destructor - read Scott Meyers if you don't know why this is needed. More...
LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object. More...
SceneManager *	_getManager () const
	Get the manager of this object, if any (internal use only) More...
ObjectData &	_getObjectData ()
	Returns a direct access to the ObjectData state. More...
const Matrix4 &	_getParentNodeFullTransform () const
	Returns the full transformation of the parent sceneNode or the attachingPoint node. More...
virtual void	_notifyAttached (Node *parent)
	Internal method called to notify the object that it has been attached to a node. More...
void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only) More...
virtual void	_notifyParentNodeMemoryChanged ()
virtual void	_notifyStaticDirty () const
	Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More...
virtual void	_releaseManualHardwareResources ()
	Notifies the movable object that hardware resources were lost. More...
virtual void	_restoreManualHardwareResources ()
	Notifies the movable object that hardware resources should be restored. More...
virtual void	_updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera)
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...
void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
void	detachFromParent ()
	Detaches an object from a parent SceneNode if attached. More...
RealAsUint	getCachedDistanceToCamera () const
	Returns the distance to camera as calculated in cullFrustum() More...
Real	getCachedDistanceToCameraAsReal () const
	Returns the distance to camera as calculated in cullFrustum() More...
bool	getCastShadows () const
	Returns whether shadow casting is enabled for this object. More...
unsigned char	getCurrentMeshLod () const
uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object. More...
Listener *	getListener () const
	Gets the current listener for this object. More...
Aabb	getLocalAabb () const
	Retrieves the local axis-aligned bounding box for this object. More...
float	getLocalRadius () const
	See getLocalAabb and getWorldRadius. More...
const String &	getName () const
	Returns the name of this object. More...
Node *	getParentNode () const
	Returns the node to which this object is attached. More...
SceneNode *	getParentSceneNode () const
uint32	getQueryFlags () const
	Returns the query flags relevant for this object. More...
Real	getRenderingDistance () const
	Gets the distance at which batches are no longer rendered. More...
Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
uint8	getRenderQueueGroup () const
	Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
Real	getShadowRenderingDistance () const
	Gets the distance at which batches are no longer casting shadows. More...
SkeletonInstance *	getSkeletonInstance () 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...
uint32	getVisibilityFlags () const
	Returns the visibility flags relevant for this object. More...
bool	getVisible () const
	Gets this object whether to be visible or not, if it has a renderable component. More...
Aabb	getWorldAabb () const
	Gets the axis aligned box in world space. More...
Aabb	getWorldAabbUpdated ()
	Gets the axis aligned box in world space. More...
float	getWorldRadius () const
	Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
float	getWorldRadiusUpdated ()
	Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
virtual void	instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
bool	isAttached () const
	Returns true if this object is attached to a Node. More...
bool	isStatic () const
	Checks whether this MovableObject is static. More...
bool	isVisible () const
	Returns whether or not this object is supposed to be visible or not. More...
const LightList &	queryLights () const
	Gets a list of lights, ordered relative to how close they are to this movable object. More...
void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
void	resetMeshLod ()
	Sets mCurrentMeshLod to 0. More...
void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows. More...
void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object. More...
void	setListener (Listener *listener)
	Sets a listener for this object. More...
void	setLocalAabb (const Aabb box)
	Sets the local axis-aligned bounding box for this object. More...
void	setName (const String &name)
	Sets a custom name for this node. More...
void	setQueryFlags (uint32 flags)
	Sets the query flags for this object. More...
void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered. More...
void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through. More...
void	setShadowRenderingDistance (Real dist)
	Sets the distance at which the object is no longer casting shadows. More...
bool	setStatic (bool bStatic)
	Turns this Node into static or dynamic. More...
void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object. More...
void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component. More...
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. More...
const StringVector &	getAnimableValueNames () const
	Gets a list of animable value names for this object. More...
Public Member Functions inherited from Ogre::IdObject
	IdObject (IdType id)
	We don't call generateNewId() here, to prevent objects in the stack (i.e. More...
IdType	getId () const
	Get the unique id of this object. More...
bool	operator() (const IdObject &left, const IdObject &right)
bool	operator() (const IdObject *left, const IdObject *right)
Public Member Functions inherited from Ogre::Renderable
	Renderable ()
virtual	~Renderable ()
	Virtual destructor needed as class has virtual methods. More...
virtual void	_setHlmsHashes (uint32 hash, uint32 casterHash)
	Manually sets the hlms hashes. Don't call this directly. More...
virtual void	_setNullDatablock ()
	Sets the datablock to a null pointer. 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...
void	addPoseWeight (size_t index, float w)
virtual bool	getCastsShadows () const
	Method which reports whether this renderable would normally cast a shadow. More...
uint8	getCurrentMaterialLod () const
const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index. More...
const CustomParameterMap &	getCustomParameters () const
HlmsDatablock *	getDatablock () const
const String &	getDatablockOrMaterialName () const
uint32	getHlmsCasterHash () const
uint32	getHlmsHash () const
MaterialPtr	getMaterial () const
	Retrieves the material this renderable object uses. More...
unsigned short	getNumPoses () const
virtual unsigned short	getNumWorldTransforms () const
	Returns the number of world transform matrices this renderable requires. More...
virtual ParticleType::ParticleType	getParticleType () const
	Used by ParticleSystemDef to indicate Hlms they want specific shader code. More...
virtual bool	getPolygonModeOverrideable () const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
bool	getPoseHalfPrecision () const
bool	getPoseNormals () const
TexBufferPacked *	getPoseTexBuffer () const
float	getPoseWeight (size_t index) const
float *	getPoseWeights () const
uint8	getRenderQueueSubGroup () const
bool	getUseIdentityProjection () const
	Returns whether or not to use an 'identity' projection. More...
bool	getUseIdentityView () const
	Returns whether or not to use an 'identity' view. More...
virtual bool	getUseIdentityViewProjMatrixIsDynamic () const
	Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization) More...
virtual bool	getUseIdentityWorldMatrix () const
	Returns whether the world matrix is an identity matrix. More...
virtual OGRE_DEPRECATED const Any &	getUserAny () 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...
const VertexArrayObjectArray &	getVaos (VertexPass vertexPass) const
bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index. More...
bool	hasSkeletonAnimation () const
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	resetMaterialLod ()
	Sets mCurrentMaterialLod to 0. 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	setDatablock (HlmsDatablock *datablock)
	Assigns a datablock (i.e. HLMS Material) to this renderable. More...
void	setDatablock (IdString datablockName)
	Assigns a datablock (i.e. More...
void	setDatablockOrMaterialName (String materialName, String groupName)
	First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials. More...
void	setMaterialName (const String &name, const String &groupName)
	Sets the name of the Material to be used. Prefer using HLMS. More...
virtual void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
void	setPoseWeight (size_t index, float w)
void	setRenderQueueSubGroup (uint8 subGroup)
	Sets the render queue sub group. 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)

Additional Inherited Members
Public Types inherited from Ogre::MovableObject
typedef FastArray< MovableObject * >	MovableObjectArray
Public Types inherited from Ogre::Renderable
typedef map< size_t, Vector4 >::type	CustomParameterMap
Static Public Member Functions inherited from Ogre::MovableObject
static void	buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
static void	calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
static void	cullFrustum (const size_t numNodes, ObjectData t, const Camera *frustum, MovableObjectArray &outCulledObjects, const CullFrustumPreparedData &pd)
static void	cullFrustumPrepare (const Camera *frustum, uint32 sceneVisibilityFlags, const Camera *lodCamera, CullFrustumPreparedData &pd)
static void	cullLights (const size_t numNodes, ObjectData t, uint32 sceneLightMask, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
	See SceneManager::cullLights & see MovableObject::cullFrustum. More...
static uint32	getDefaultLightMask ()
	Get the default light mask for all future MovableObject instances. More...
static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances. More...
static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances. More...
static void	setDefaultLightMask (uint32 mask)
	Set the default light mask for all future MovableObject instances. More...
static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances. More...
static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances. More...
static void	updateAllBounds (const size_t numNodes, ObjectData t)
Static Public Member Functions inherited from Ogre::Renderable
static uint8	getDefaultRenderQueueSubGroup ()
static void	setDefaultRenderQueueSubGroup (uint8 subGroup)
	Sets the default render queue sub group for all future Renderable instances. More...
Public Attributes inherited from Ogre::MovableObject
size_t	mGlobalIndex
	Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
size_t	mParentIndex
	Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
RenderableArray	mRenderables
Public Attributes inherited from Ogre::Renderable
uint8	mCustomParameter
uint32	mHlmsGlobalIndex
	Index in the vector holding this Rendrable reference in the HLMS datablock. More...
bool	mRenderableVisible
	Control visibility at Renderable (e.g. More...
Static Public Attributes inherited from Ogre::MovableObject
static const FastArray< Real >	c_DefaultLodMesh

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

Ogre::v1::SimpleRenderable::SimpleRenderable	(	IdType	id,
		ObjectMemoryManager *	objectMemoryManager,
		SceneManager *	manager
	)

Constructor.

~SimpleRenderable()

Ogre::v1::SimpleRenderable::~SimpleRenderable ( )

override

Member Function Documentation

getBoundingBox()

virtual const AxisAlignedBox& Ogre::v1::SimpleRenderable::getBoundingBox ( ) const

virtual

getLights()

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

overridevirtual

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.

Implements Ogre::Renderable.

getMaterial()

virtual const MaterialPtr& Ogre::v1::SimpleRenderable::getMaterial ( ) const

virtual

getMovableType()

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

overridevirtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

getRenderOperation()

void Ogre::v1::SimpleRenderable::getRenderOperation ( RenderOperation &  op, bool  casterPass  )

overridevirtual

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

Implements Ogre::Renderable.

getWorldTransforms()

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

overridevirtual

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.

Implements Ogre::Renderable.

setBoundingBox()

void Ogre::v1::SimpleRenderable::setBoundingBox

(

const AxisAlignedBox &

box

)

setMaterial() [1/2]

void Ogre::v1::SimpleRenderable::setMaterial ( const MaterialPtr &  material )

overridevirtual

Sets the given material. Overrides HLMS materials.

Reimplemented from Ogre::Renderable.

setMaterial() [2/2]

virtual void Ogre::v1::SimpleRenderable::setMaterial ( const String &  matName )

virtual

setRenderOperation()

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

virtual

setWorldTransform()

void Ogre::v1::SimpleRenderable::setWorldTransform

(

const Matrix4 &

xform

)

---

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

• OgreSimpleRenderable.h