Class for rendering the border of a BorderPanelOverlayElement. More...

#include <OgreBorderPanelOverlayElement.h>

Inheritance diagram for Ogre::v1::BorderRenderable:

Public Member Functions
	BorderRenderable (BorderPanelOverlayElement *parent)
	Constructed with pointers to parent. More...

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

unsigned short	getNumWorldTransforms () const override
	Returns the number of world transform matrices this renderable requires. More...

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

void	getRenderOperation (v1::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...

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 ParticleType::ParticleType	getParticleType () const
	Used by ParticleSystemDef to indicate Hlms they want specific shader code. 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...

virtual void	setMaterial (const MaterialPtr &material)
	Sets the given material. Overrides HLMS 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::Renderable
typedef map< size_t, Vector4 >::type	CustomParameterMap

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

Detailed Description

Class for rendering the border of a BorderPanelOverlayElement.

Remarks: We need this because we have to render twice, once with the inner panel's repeating material (handled by superclass) and once for the border's separate material.

Constructor & Destructor Documentation

◆ BorderRenderable()

Ogre::v1::BorderRenderable::BorderRenderable ( BorderPanelOverlayElement * parent )

inline

Constructed with pointers to parent.

Member Function Documentation

◆ getLights()

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

inlineoverridevirtual

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.

◆ getNumWorldTransforms()

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

inlineoverridevirtual

Returns the number of world transform matrices this renderable requires.

Remarks: When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented from Ogre::Renderable.

◆ getPolygonModeOverrideable()

bool Ogre::v1::BorderRenderable::getPolygonModeOverrideable ( ) const

inlineoverridevirtual

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

Reimplemented from Ogre::Renderable.

References Ogre::Renderable::getPolygonModeOverrideable().

◆ getRenderOperation()

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

inlineoverridevirtual

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

Implements Ogre::Renderable.

◆ getWorldTransforms()

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

inlineoverridevirtual

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.

References Ogre::v1::OverlayElement::getWorldTransforms().

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

OgreBorderPanelOverlayElement.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BorderRenderable()

Member Function Documentation

◆ getLights()

◆ getNumWorldTransforms()

◆ getPolygonModeOverrideable()

◆ getRenderOperation()

◆ getWorldTransforms()