Utility class which defines the sub-parts of an Entity. More...

#include <OgreSubEntity.h>

Inheritance diagram for Ogre::v1::SubEntity:

Public Types
typedef map< size_t, Vector4 >::type	CustomParameterMap

Public Member Functions
virtual	~SubEntity ()
	Destructor. More...

bool	_getBuffersMarkedForAnimation () const
	Are buffers already marked as vertex animated? More...

VertexData *	_getHardwareVertexAnimVertexData ()
	Advanced method to get the hardware morph vertex information. More...

TempBlendedBufferInfo *	_getSkelAnimTempBufferInfo ()
	Advanced method to get the temp buffer information for software skeletal animation. More...

VertexData *	_getSkelAnimVertexData ()
	Advanced method to get the temporarily blended vertex information for entities which are software skinned. More...

VertexData *	_getSoftwareVertexAnimVertexData ()
	Advanced method to get the temporarily blended software morph vertex information. More...

TempBlendedBufferInfo *	_getVertexAnimTempBufferInfo ()
	Advanced method to get the temp buffer information for software morph animation. More...

const TempBlendedBufferInfo *	_getVertexAnimTempBufferInfo () const

void	_markBuffersUnusedForAnimation ()
	Mark all vertex data as so far unanimated. More...

void	_markBuffersUsedForAnimation ()
	Mark all vertex data as animated. More...

void	_restoreBuffersForUnusedAnimation (bool hardwareAnimation)
	Internal method to copy original vertex data to the morph structures should there be no active animation in use. More...

virtual void	_setHlmsHashes (uint32 hash, uint32 casterHash)
	Manually sets the hlms hashes. Don't call this directly. More...

void	_setNullDatablock () override
	Sets the datablock to a null pointer. More...

void	_updateCustomGpuParameter (const GpuProgramParameters_AutoConstantEntry &constantEntry, GpuProgramParameters *params) const override
	Overridden from Renderable to provide some custom behaviour. More...

void	addPoseWeight (size_t index, float w)

bool	getCastsShadows () const override
	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

size_t	getIndexDataEndIndex () const
	Returns the current value of the start index used for drawing. More...

size_t	getIndexDataStartIndex () const
	Returns the current value of the start index used for drawing. More...

const LightList &	getLights () const override
	Gets a list of lights, ordered relative to how close they are to this renderable. More...

MaterialPtr	getMaterial () const
	Retrieves the material this renderable object uses. More...

unsigned short	getNumPoses () const

unsigned short	getNumWorldTransforms () const override
	Overridden - see Renderable. More...

Entity *	getParent () const
	Accessor to get parent Entity. 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

void	getRenderOperation (RenderOperation &op, bool casterPass) override
	Overridden - see Renderable. More...

uint8	getRenderQueueSubGroup () const

Real	getSquaredViewDepth (const Camera *cam) const
	Overridden, see Renderable. More...

SubMesh *	getSubMesh () const
	Accessor method to read mesh data. More...

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

VertexData *	getVertexDataForBinding (bool casterPass)
	Retrieve the VertexData which should be used for GPU binding. More...

void	getWorldTransforms (Matrix4 *xform) const override
	Overridden - see Renderable. More...

bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index. More...

bool	hasSkeletonAnimation () const

void	operator delete (void *ptr)

void	operator delete (void ptr, const char , int, const char *)

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info 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	resetIndexDataStartEndIndex ()
	Reset the custom start/end index to the default values. 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)
	Make every setDatablock method from Renderable available. More...

void	setDatablock (HlmsDatablock *datablock) override
	Assigns a datablock (i.e. HLMS Material) to this renderable. More...

void	setDatablock (IdString datablockName)
	Assigns a datablock (i.e. More...

void	setDatablock (IdString datablockName)
	Make every setDatablock method from Renderable available. 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	setIndexDataEndIndex (size_t end_index)
	Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents. More...

void	setIndexDataStartIndex (size_t start_index)
	Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents. More...

void	setMaterial (const MaterialPtr &material) override
	Sets a Material to be used. More...

void	setMaterialName (const String &name, const String &groupName)
	Sets the name of the Material to be used. Prefer using HLMS @See setHlms. 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)

Static Public Member Functions
static uint8	getDefaultRenderQueueSubGroup ()

static void	setDefaultRenderQueueSubGroup (uint8 subGroup)
	Sets the default render queue sub group for all future Renderable instances. More...

Public Attributes
uint8	mCustomParameter
	Only valid when using low level materials. More...

uint32	mHlmsGlobalIndex
	Index in the vector holding this Rendrable reference in the HLMS datablock. More...

bool	mRenderableVisible
	Control visibility at Renderable (e.g. More...

Friends
class	Entity

class	SceneManager

Detailed Description

Utility class which defines the sub-parts of an Entity.

Remarks: Just as meshes are split into submeshes, an Entity is made up of potentially multiple SubMeshes. These are mainly here to provide the link between the Material which the SubEntity uses (which may be the default Material for the SubMesh or may have been changed for this object) and the SubMesh data.

: The SubEntity also allows the application some flexibility in the material properties for this section of a particular instance of this Mesh, e.g. tinting the windows on a car model.

: SubEntity instances are never created manually. They are created at the same time as their parent Entity by the SceneManager method createEntity.

Member Typedef Documentation

◆ CustomParameterMap

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

inherited

Constructor & Destructor Documentation

◆ ~SubEntity()

virtual Ogre::v1::SubEntity::~SubEntity ( )

virtual

Destructor.

Member Function Documentation

◆ _getBuffersMarkedForAnimation()

bool Ogre::v1::SubEntity::_getBuffersMarkedForAnimation ( ) const

inline

Are buffers already marked as vertex animated?

◆ _getHardwareVertexAnimVertexData()

VertexData* Ogre::v1::SubEntity::_getHardwareVertexAnimVertexData ( )

Advanced method to get the hardware morph vertex information.

Note: The positions/normals of the returned vertex data is in object space.

◆ _getSkelAnimTempBufferInfo()

TempBlendedBufferInfo* Ogre::v1::SubEntity::_getSkelAnimTempBufferInfo ( )

Advanced method to get the temp buffer information for software skeletal animation.

◆ _getSkelAnimVertexData()

VertexData* Ogre::v1::SubEntity::_getSkelAnimVertexData ( )

Advanced method to get the temporarily blended vertex information for entities which are software skinned.

Remarks: Internal engine will eliminate software animation if possible, this information is unreliable unless added request for software animation via Entity::addSoftwareAnimationRequest.

Note: The positions/normals of the returned vertex data is in object space.

◆ _getSoftwareVertexAnimVertexData()

VertexData* Ogre::v1::SubEntity::_getSoftwareVertexAnimVertexData ( )

Advanced method to get the temporarily blended software morph vertex information.

Remarks: Internal engine will eliminate software animation if possible, this information is unreliable unless added request for software animation via Entity::addSoftwareAnimationRequest.

Note: The positions/normals of the returned vertex data is in object space.

◆ _getVertexAnimTempBufferInfo() [1/2]

TempBlendedBufferInfo* Ogre::v1::SubEntity::_getVertexAnimTempBufferInfo ( )

Advanced method to get the temp buffer information for software morph animation.

◆ _getVertexAnimTempBufferInfo() [2/2]

const TempBlendedBufferInfo* Ogre::v1::SubEntity::_getVertexAnimTempBufferInfo ( ) const

◆ _markBuffersUnusedForAnimation()

void Ogre::v1::SubEntity::_markBuffersUnusedForAnimation ( )

Mark all vertex data as so far unanimated.

◆ _markBuffersUsedForAnimation()

void Ogre::v1::SubEntity::_markBuffersUsedForAnimation ( )

Mark all vertex data as animated.

◆ _restoreBuffersForUnusedAnimation()

void Ogre::v1::SubEntity::_restoreBuffersForUnusedAnimation ( bool hardwareAnimation )

Internal method to copy original vertex data to the morph structures should there be no active animation in use.

◆ _setHlmsHashes()

virtual void Ogre::Renderable::_setHlmsHashes	(	uint32	hash,
		uint32	casterHash
	)

virtualinherited

Manually sets the hlms hashes. Don't call this directly.

Reimplemented in Ogre::SubItem.

◆ _setNullDatablock()

void Ogre::v1::SubEntity::_setNullDatablock ( )

overridevirtual

Sets the datablock to a null pointer.

Use case: If you will be destroying an HlmsDatablock and all Renderables associated by it; it makes no sense to change the Renderable's datablock to a default one, only to be destroyed immediately after (you pay an unnecessary performance price).

Remarks: Do not attempt to render a Renderable whose datablock has been set to null. It will crash. You can call setDatablock afterwards though. Use at your own risk, hence the _underscore. See http://ogre3d.org/forums/viewtopic.php?f=25&t=91791&p=534476#p534476

Reimplemented from Ogre::Renderable.

◆ _updateCustomGpuParameter()

void Ogre::v1::SubEntity::_updateCustomGpuParameter	(	const GpuProgramParameters_AutoConstantEntry &	constantEntry,
		GpuProgramParameters *	params
	)		const

overridevirtual

Overridden from Renderable to provide some custom behaviour.

Reimplemented from Ogre::Renderable.

◆ addPoseWeight()

void Ogre::Renderable::addPoseWeight	(	size_t	index,
		float	w
	)

inherited

◆ getCastsShadows()

bool Ogre::v1::SubEntity::getCastsShadows ( ) const

overridevirtual

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 from Ogre::Renderable.

◆ getCurrentMaterialLod()

uint8 Ogre::Renderable::getCurrentMaterialLod ( ) const

inlineinherited

◆ getCustomParameter()

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

inlineinherited

Gets the custom value associated with this Renderable at the given index.

Parameters

index Index of the parameter to retrieve.

See also: setCustomParameter for full details.

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

◆ getCustomParameters()

const CustomParameterMap& Ogre::Renderable::getCustomParameters ( ) const

inlineinherited

◆ getDatablock()

HlmsDatablock* Ogre::Renderable::getDatablock ( ) const

inlineinherited

◆ getDatablockOrMaterialName()

const String& Ogre::Renderable::getDatablockOrMaterialName ( ) const

inherited

◆ getDefaultRenderQueueSubGroup()

static uint8 Ogre::Renderable::getDefaultRenderQueueSubGroup ( )

inlinestaticinherited

◆ getHlmsCasterHash()

uint32 Ogre::Renderable::getHlmsCasterHash ( ) const

inlineinherited

◆ getHlmsHash()

uint32 Ogre::Renderable::getHlmsHash ( ) const

inlineinherited

◆ getIndexDataEndIndex()

size_t Ogre::v1::SubEntity::getIndexDataEndIndex ( ) const

Returns the current value of the start index used for drawing.

◆ getIndexDataStartIndex()

size_t Ogre::v1::SubEntity::getIndexDataStartIndex ( ) const

Returns the current value of the start index used for drawing.

See also: setIndexDataStartIndex

◆ getLights()

const LightList& Ogre::v1::SubEntity::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()

MaterialPtr Ogre::Renderable::getMaterial ( ) const

inherited

Retrieves the material this renderable object uses.

It may be null if it's using the HLMS. @See getDatablock

◆ getNumPoses()

unsigned short Ogre::Renderable::getNumPoses ( ) const

inherited

◆ getNumWorldTransforms()

unsigned short Ogre::v1::SubEntity::getNumWorldTransforms ( ) const

overridevirtual

Overridden - see Renderable.

Reimplemented from Ogre::Renderable.

◆ getParent()

Entity* Ogre::v1::SubEntity::getParent ( ) const

inline

Accessor to get parent Entity.

◆ getPolygonModeOverrideable()

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

inlinevirtualinherited

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

Reimplemented in Ogre::v1::BorderRenderable.

Referenced by Ogre::v1::BorderRenderable::getPolygonModeOverrideable().

◆ getPoseHalfPrecision()

bool Ogre::Renderable::getPoseHalfPrecision ( ) const

inherited

◆ getPoseNormals()

bool Ogre::Renderable::getPoseNormals ( ) const

inherited

◆ getPoseTexBuffer()

TexBufferPacked* Ogre::Renderable::getPoseTexBuffer ( ) const

inherited

◆ getPoseWeight()

float Ogre::Renderable::getPoseWeight ( size_t index ) const

inherited

◆ getPoseWeights()

float* Ogre::Renderable::getPoseWeights ( ) const

inherited

◆ getRenderOperation()

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

overridevirtual

Overridden - see Renderable.

Implements Ogre::Renderable.

◆ getRenderQueueSubGroup()

uint8 Ogre::Renderable::getRenderQueueSubGroup ( ) const

inlineinherited

◆ getSquaredViewDepth()

Real Ogre::v1::SubEntity::getSquaredViewDepth ( const Camera * cam ) const

Overridden, see Renderable.

◆ getSubMesh()

SubMesh* Ogre::v1::SubEntity::getSubMesh ( ) const

Accessor method to read mesh data.

◆ getUseIdentityProjection()

bool Ogre::Renderable::getUseIdentityProjection ( ) const

inlineinherited

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

◆ getUseIdentityView()

bool Ogre::Renderable::getUseIdentityView ( ) const

inlineinherited

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

◆ getUseIdentityViewProjMatrixIsDynamic()

virtual bool Ogre::Renderable::getUseIdentityViewProjMatrixIsDynamic ( ) const

inlinevirtualinherited

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)

Remarks: Hlms implementations may ignore this setting (e.g. assume always true or always false) or even not support identity matrix overrides at all. For example currently Unlit supports them all, but will assume this returns always true if getUseIdentityWorldMatrix returns false.

◆ getUseIdentityWorldMatrix()

virtual bool Ogre::Renderable::getUseIdentityWorldMatrix ( ) const

inlinevirtualinherited

Returns whether the world matrix is an identity matrix.

Remarks: It is up to the Hlms implementation whether to honour this request. Take in mind changes of this value at runtime may not be seen until the datablock is flushed. It is implemented as a virtual call because this functionality isn't required very often (hence we save per-Renderable space for those that don't use it) and this function will be called at creation time to use a different shader; not during rendering time per Renderable.

Reimplemented in Ogre::v1::BillboardSet.

◆ getUserAny()

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny ( ) const

inlinevirtualinherited

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

◆ getUserObjectBindings() [1/2]

UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( )

inlineinherited

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.

◆ getUserObjectBindings() [2/2]

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

inlineinherited

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.

◆ getVaos()

const VertexArrayObjectArray& Ogre::Renderable::getVaos ( VertexPass vertexPass ) const

inlineinherited

◆ getVertexDataForBinding()

VertexData* Ogre::v1::SubEntity::getVertexDataForBinding ( bool casterPass )

Retrieve the VertexData which should be used for GPU binding.

◆ getWorldTransforms()

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

overridevirtual

Overridden - see Renderable.

Implements Ogre::Renderable.

◆ hasCustomParameter()

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

inlineinherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters

index Index of the parameter to check for existence.

See also: setCustomParameter for full details.

◆ hasSkeletonAnimation()

bool Ogre::Renderable::hasSkeletonAnimation ( ) const

inlineinherited

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

◆ operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

◆ postRender()

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

inlinevirtualinherited

Called immediately after the Renderable has been rendered.

◆ preRender()

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

inlinevirtualinherited

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::v1::BillboardChain.

◆ removeCustomParameter()

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

inlineinherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters

index Index of the parameter to remove.

See also: setCustomParameter for full details.

◆ resetIndexDataStartEndIndex()

void Ogre::v1::SubEntity::resetIndexDataStartEndIndex ( )

Reset the custom start/end index to the default values.

◆ setCustomParameter()

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

inlineinherited

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

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.

◆ setDatablock() [1/4]

virtual void Ogre::Renderable::setDatablock

Make every setDatablock method from Renderable available.

See http://www.research.att.com/~bs/bs_faq2.html#overloadderived

◆ setDatablock() [2/4]

void Ogre::v1::SubEntity::setDatablock ( HlmsDatablock * datablock )

overridevirtual

Assigns a datablock (i.e. HLMS Material) to this renderable.

Reimplemented from Ogre::Renderable.

◆ setDatablock() [3/4]

void Ogre::Renderable::setDatablock ( IdString datablockName )

inherited

Assigns a datablock (i.e.

HLMS material) based on its unique name.

Remarks: An null IdString() is valid, it will use the default material

◆ setDatablock() [4/4]

void Ogre::Renderable::setDatablock

Make every setDatablock method from Renderable available.

See http://www.research.att.com/~bs/bs_faq2.html#overloadderived

◆ setDatablockOrMaterialName()

void Ogre::Renderable::setDatablockOrMaterialName	(	String	materialName,
		String	groupName
	)

inherited

First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials.

◆ setDefaultRenderQueueSubGroup()

static void Ogre::Renderable::setDefaultRenderQueueSubGroup ( uint8 subGroup )

inlinestaticinherited

Sets the default render queue sub group for all future Renderable instances.

◆ setIndexDataEndIndex()

void Ogre::v1::SubEntity::setIndexDataEndIndex ( size_t end_index )

Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents.

Default value is SubMesh::indexData::indexCount so that the entire index buffer is used when drawing. Valid values are mStartIndex to SubMesh::indexData::indexCount

◆ setIndexDataStartIndex()

void Ogre::v1::SubEntity::setIndexDataStartIndex ( size_t start_index )

Tells this SubEntity to draw a subset of the SubMesh by adjusting the index buffer extents.

Default value is zero so that the entire index buffer is used when drawing. Valid values are zero to getIndexDataEndIndex()

◆ setMaterial()

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

overridevirtual

Sets a Material to be used.

Remarks: By default a SubEntity uses the default Material that the SubMesh uses. This call can alter that so that the Material is different for this instance.

Reimplemented from Ogre::Renderable.

◆ setMaterialName()

void Ogre::Renderable::setMaterialName	(	const String &	name,
		const String &	groupName
	)

inherited

Sets the name of the Material to be used. Prefer using HLMS @See setHlms.

◆ setPolygonModeOverrideable()

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

inlinevirtualinherited

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

Parameters

override true means that a lower camera detail will override this renderables detail level, false means it won't.

◆ setPoseWeight()

void Ogre::Renderable::setPoseWeight	(	size_t	index,
		float	w
	)

inherited

◆ setRenderQueueSubGroup()

void Ogre::Renderable::setRenderQueueSubGroup ( uint8 subGroup )

inlineinherited

Sets the render queue sub group.

Remarks: Within the same RenderQueue ID, you may want to have the renderables to have a specific order (i.e. have a mesh, but the hair submesh with alpha blending needs to be rendered last).

: RenderQueue Subgroups are useful for manually sorting objects, just like RenderQueue IDs. However, RenderQueue IDs can also be useful for skipping large number of objects through clever compositing and thus a performance optimization. Subgroups cannot be used for such optimizations.

Parameters

subGroup The sub group. This value can't exceed OGRE_MAKE_MASK( SubRqIdBits ) @See RenderQueue

◆ setUseIdentityProjection()

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

inlineinherited

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

◆ setUseIdentityView()

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

inlineinherited

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

◆ setUserAny()

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any & anything )

inlinevirtualinherited

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.

Friends And Related Function Documentation

◆ Entity

friend class Entity

friend

◆ SceneManager

friend class SceneManager

friend

Member Data Documentation

◆ mCustomParameter

uint8 Ogre::Renderable::mCustomParameter

inherited

Only valid when using low level materials.

◆ mHlmsGlobalIndex

uint32 Ogre::Renderable::mHlmsGlobalIndex

inherited

Index in the vector holding this Rendrable reference in the HLMS datablock.

Used for O(1) removals.

Remarks: Despite being public, Do NOT modify it manually.

◆ mRenderableVisible

bool Ogre::Renderable::mRenderableVisible

inherited

Control visibility at Renderable (e.g.

SubMesh) level

Note that if our MovableObject owner called MovableObject::setVisible( false ) we won't get rendered. Both must be true in order to render.

Remarks: PUBLIC VARIABLE. This variable can be altered directly. Changes are reflected immediately.

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

OgreSubEntity.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ CustomParameterMap

Constructor & Destructor Documentation

◆ ~SubEntity()

Member Function Documentation

◆ _getBuffersMarkedForAnimation()

◆ _getHardwareVertexAnimVertexData()

◆ _getSkelAnimTempBufferInfo()

◆ _getSkelAnimVertexData()

◆ _getSoftwareVertexAnimVertexData()

◆ _getVertexAnimTempBufferInfo() [1/2]

◆ _getVertexAnimTempBufferInfo() [2/2]

◆ _markBuffersUnusedForAnimation()

◆ _markBuffersUsedForAnimation()

◆ _restoreBuffersForUnusedAnimation()

◆ _setHlmsHashes()

◆ _setNullDatablock()

◆ _updateCustomGpuParameter()

◆ addPoseWeight()

◆ getCastsShadows()

◆ getCurrentMaterialLod()

◆ getCustomParameter()

◆ getCustomParameters()

◆ getDatablock()

◆ getDatablockOrMaterialName()

◆ getDefaultRenderQueueSubGroup()

◆ getHlmsCasterHash()

◆ getHlmsHash()

◆ getIndexDataEndIndex()

◆ getIndexDataStartIndex()

◆ getLights()

◆ getMaterial()

◆ getNumPoses()

◆ getNumWorldTransforms()

◆ getParent()

◆ getPolygonModeOverrideable()

◆ getPoseHalfPrecision()

◆ getPoseNormals()

◆ getPoseTexBuffer()

◆ getPoseWeight()

◆ getPoseWeights()

◆ getRenderOperation()

◆ getRenderQueueSubGroup()

◆ getSquaredViewDepth()

◆ getSubMesh()

◆ getUseIdentityProjection()

◆ getUseIdentityView()

◆ getUseIdentityViewProjMatrixIsDynamic()

◆ getUseIdentityWorldMatrix()

◆ getUserAny()

◆ getUserObjectBindings() [1/2]

◆ getUserObjectBindings() [2/2]

◆ getVaos()

◆ getVertexDataForBinding()

◆ getWorldTransforms()

◆ hasCustomParameter()

◆ hasSkeletonAnimation()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ postRender()

◆ preRender()

◆ removeCustomParameter()

◆ resetIndexDataStartEndIndex()

◆ setCustomParameter()

◆ setDatablock() [1/4]

◆ setDatablock() [2/4]