A specialisation of the PanelOverlayElement to provide a panel with a border. More...

#include <OgreBorderPanelOverlayElement.h>

Inheritance diagram for Ogre::v1::BorderPanelOverlayElement:

Classes
class	CmdBorderBottomLeftUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

class	CmdBorderBottomRightUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

class	CmdBorderBottomUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

class	CmdBorderLeftUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

class	CmdBorderMaterial
	Command object for specifying the Material for the border (see ParamCommand). More...

class	CmdBorderRightUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

class	CmdBorderSize
	Command object for specifying border sizes (see ParamCommand). More...

class	CmdBorderTopLeftUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

class	CmdBorderTopRightUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

class	CmdBorderTopUV
	Command object for specifying texture coordinates for the border (see ParamCommand). More...

Public Types
typedef MapIterator< ChildContainerMap >	ChildContainerIterator

typedef map< String, OverlayContainer * >::type	ChildContainerMap

typedef MapIterator< ChildMap >	ChildIterator

typedef map< String, OverlayElement * >::type	ChildMap

typedef map< size_t, Vector4 >::type	CustomParameterMap

Public Member Functions
	BorderPanelOverlayElement (const String &name)
	Constructor. More...

virtual	~BorderPanelOverlayElement ()

void	_addChild (OverlayElement *elem)

virtual void	_getClippingRegion (RealRect &clippingRegion)
	Gets the clipping region of the element. More...

virtual Real	_getDerivedLeft (void)
	Gets the 'left' position as derived from own left and that of parents. More...

virtual Real	_getDerivedTop (void)
	Gets the 'top' position as derived from own left and that of parents. More...

Real	_getHeight (void) const
	Gets the height of this element in relation to the screen (where 1.0 = screen height) More...

Real	_getLeft (void) const
	Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...

virtual Real	_getRelativeHeight (void)
	Gets the 'height' as derived from own height and metrics mode. More...

virtual Real	_getRelativeWidth (void)
	Gets the 'width' as derived from own width and metrics mode. More...

Real	_getTop (void) const
	Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...

Real	_getWidth (void) const
	Gets the width of this element in relation to the screen (where 1.0 = screen width) More...

virtual void	_notifyParent (OverlayContainer parent, Overlay overlay)
	Overridden from OverlayElement. More...

virtual void	_notifyViewport ()
	Overridden from OverlayElement. More...

virtual void	_positionsOutOfDate (void)
	Tell the object and its children to recalculate. More...

virtual void	_releaseManualHardwareResources ()

void	_removeChild (OverlayElement *elem)

void	_removeChild (const String &name)

virtual void	_restoreManualHardwareResources ()

void	_setDimensions (Real width, Real height)
	Sets the width and height of this element in relation to the screen (where 1.0 = screen width) More...

void	_setHeight (Real height)
	Sets the height of this element in relation to the screen (where 1.0 = screen width) More...

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

void	_setLeft (Real left)
	Sets the left of this element in relation to the screen (where 1.0 = screen width) More...

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

void	_setParent (OverlayContainer *parent)

void	_setPosition (Real left, Real top)
	Sets the left and top of this element in relation to the screen (where 1.0 = screen width) More...

void	_setTop (Real top)
	Sets the top of this element in relation to the screen (where 1.0 = screen width) More...

void	_setWidth (Real width)
	Sets the width of this element in relation to the screen (where 1.0 = screen width) More...

void	_update (void)
	Internal method to update the element based on transforms applied. 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...

virtual void	_updateFromParent (void)
	Updates this elements transform based on it's parent. More...

void	_updateRenderQueue (RenderQueue queue, Camera camera, const Camera *lodCamera)
	Overridden from OverlayElement. More...

virtual void	addChild (OverlayElement *elem)
	Adds another OverlayElement to this container. More...

virtual void	addChildImpl (OverlayElement *elem)
	Adds another OverlayElement to this container. More...

virtual void	addChildImpl (OverlayContainer *cont)
	Add a nested container to this container. More...

void	addPoseWeight (size_t index, float w)

virtual OverlayElement *	clone (const String &instanceName)

virtual bool	contains (Real x, Real y) const
	Returns true if xy is within the constraints of the component. More...

void	copyFromTemplate (OverlayElement *templateOverlay)

virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...

virtual OverlayElement *	findElementAt (Real x, Real y)
	This returns a OverlayElement at position x,y. More...

const String &	getBorderMaterialName (void) const
	Gets the name of the material to use for the borders. More...

Real	getBottomBorderSize (void) const
	Gets the size of the bottom border. More...

String	getBottomBorderUVString () const

String	getBottomLeftBorderUVString () const

String	getBottomRightBorderUVString () const

virtual const DisplayString &	getCaption (void) const
	Gets the caption for this element. More...

virtual bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow. More...

virtual OverlayElement *	getChild (const String &name)
	Gets the named child of this container. More...

virtual ChildContainerIterator	getChildContainerIterator (void)
	Gets an iterator for just the container children of this object. More...

virtual ChildIterator	getChildIterator (void)
	Gets an object for iterating over all the children of this object. More...

virtual const ColourValue &	getColour (void) const
	Gets the colour for this element. More...

uint8	getCurrentMaterialLod (void) const

const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index. More...

const CustomParameterMap &	getCustomParameters (void) const

HlmsDatablock *	getDatablock (void) const

Real	getHeight (void) const
	Gets the height of this element in relation to the screen (where 1.0 = screen height) More...

uint32	getHlmsCasterHash (void) const

uint32	getHlmsHash (void) const

virtual GuiHorizontalAlignment	getHorizontalAlignment (void) const
	Gets the horizontal alignment for this element. More...

Real	getLeft (void) const
	Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...

Real	getLeftBorderSize (void) const
	Gets the size of the left border. More...

String	getLeftBorderUVString () const

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

const MaterialPtr &	getMaterial (void) const
	See Renderable. More...

virtual const String &	getMaterialName (void) const
	Gets the name of the material this element uses. More...

virtual GuiMetricsMode	getMetricsMode (void) const
	Retrieves the current settings of how the element metrics are interpreted. More...

const String &	getName (void) const
	Gets the name of this overlay. More...

unsigned short	getNumPoses (void) const

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

ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class. More...

const ParamDictionary *	getParamDictionary (void) const

virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...

const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object. More...

OverlayContainer *	getParent ()
	Returns the parent container. More...

virtual bool	getPolygonModeOverrideable (void) 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 (v1::RenderOperation &op, bool casterPass)
	See Renderable. More...

uint8	getRenderQueueSubGroup (void) const

Real	getRightBorderSize (void) const
	Gets the size of the right border. More...

String	getRightBorderUVString () const

const OverlayElement *	getSourceTemplate () const
	Returns the SourceTemplate for this element. More...

Real	getTileX (ushort layer=0) const

Real	getTileY (ushort layer=0) const
	Gets the number of times the texture should repeat vertically. More...

Real	getTop (void) const
	Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...

Real	getTopBorderSize (void) const
	Gets the size of the top border. More...

String	getTopBorderUVString () const

String	getTopLeftBorderUVString () const

String	getTopRightBorderUVString () const

const String &	getTypeName (void) const
	See OverlayElement. More...

bool	getUseIdentityProjection (void) const
	Returns whether or not to use an 'identity' projection. More...

bool	getUseIdentityView (void) const
	Returns whether or not to use an 'identity' view. More...

virtual bool	getUseIdentityViewProjMatrixIsDynamic (void) 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 (void) const
	Returns whether the world matrix is an identity matrix. More...

virtual OGRE_DEPRECATED const Any &	getUserAny (void) 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...

void	getUV (Real &u1, Real &v1, Real &u2, Real &v2) const
	Get the uv coordinates for the panel. More...

const VertexArrayObjectArray &	getVaos (VertexPass vertexPass) const

virtual GuiVerticalAlignment	getVerticalAlignment (void) const
	Gets the vertical alignment for this element. More...

Real	getWidth (void) const
	Gets the width of this element in relation to the screen (where 1.0 = screen width) More...

void	getWorldTransforms (Matrix4 *xform) const
	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 (void) const

virtual void	hide (void)
	Hides this element if it was visible. More...

virtual void	initialise (void)
	Initialise. More...

virtual bool	isChildrenProcessEvents () const
	Should this container pass events to their children. More...

virtual bool	isCloneable () const

bool	isContainer () const
	Overridden from OverlayElement. More...

bool	isEnabled () const

virtual bool	isKeyEnabled () const

bool	isTransparent (void) const
	Returns whether this panel is transparent. More...

bool	isVisible (void) const
	Returns whether or not the element is visible. More...

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

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

void	operator delete[] (void *ptr)

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

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 *	operator new (size_t sz, void *ptr)
	placement operator new More...

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

void *	operator new[] (size_t sz)

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

virtual void	removeChild (const String &name)
	Removes a named element from this container. More...

void	removeCustomParameter (size_t index)
	Removes a custom value which is associated with this Renderable at the given index. More...

void	setBorderMaterialName (const String &name)
	Sets the name of the material to use for the borders. More...

void	setBorderSize (Real size)
	Sets the size of the border. More...

void	setBorderSize (Real sides, Real topAndBottom)
	Sets the size of the border, with different sizes for vertical and horizontal borders. More...

void	setBorderSize (Real left, Real right, Real top, Real bottom)
	Sets the size of the border separately for all borders. More...

void	setBottomBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the bottom edge of the border. More...

void	setBottomLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the bottom-left corner of the border. More...

void	setBottomRightBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the bottom-right corner of the border. More...

virtual void	setCaption (const DisplayString &text)
	Sets the caption on elements that support it. More...

virtual void	setChildrenProcessEvents (bool val)
	Should this container pass events to their children. More...

virtual void	setCloneable (bool c)

virtual void	setColour (const ColourValue &col)
	Sets the colour on elements that support it. 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...

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

virtual void	setDatablock (HlmsDatablock *datablock)
	Assigns a datablock (i.e. HLMS Material) to this renderable. 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	setDimensions (Real width, Real height)
	Sets the dimensions of this element in relation to the screen (1.0 = screen width/height). More...

virtual void	setEnabled (bool b)

void	setHeight (Real height)
	Sets the height of this element in relation to the screen (where 1.0 = screen height) More...

virtual void	setHorizontalAlignment (GuiHorizontalAlignment gha)
	Sets the horizontal origin for this element. More...

void	setLeft (Real left)
	Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...

void	setLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the left edge of the border. 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 setHlms. More...

void	setMaterialName (const String &matName)
	Overridden from OverlayElement. More...

void	setMetricsMode (GuiMetricsMode gmm)
	Tells this element how to interpret the position and dimension values it is given. More...

virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...

virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. 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	setPosition (Real left, Real top)
	Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height) More...

void	setRenderQueueSubGroup (uint8 subGroup)
	Sets the render queue sub group. More...

void	setRightBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the right edge of the border. More...

void	setTiling (Real x, Real y, ushort layer=0)
	Sets the number of times textures should repeat. More...

void	setTop (Real Top)
	Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...

void	setTopBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the top edge of the border. More...

void	setTopLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the top-left corner of the border. More...

void	setTopRightBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the top-right corner of the border. More...

void	setTransparent (bool isTransparent)
	Sets whether this panel is transparent (used only as a grouping level), or if it is actually rendered. 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)

void	setUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the panel. More...

virtual void	setVerticalAlignment (GuiVerticalAlignment gva)
	Sets the vertical origin for this element. More...

void	setWidth (Real width)
	Sets the width of this element in relation to the screen (where 1.0 = screen width) More...

virtual void	show (void)
	Shows this element if it was hidden. More...

Static Public Member Functions
static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. 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...

Friends
class	BorderRenderable

Detailed Description

A specialisation of the PanelOverlayElement to provide a panel with a border.

Remarks: Whilst the standard panel can use a single tiled material, this class allows panels with a tileable backdrop plus a border texture. This is handy for large panels that are too big to use a single large texture with a border, or for multiple different size panels where you want the border a constant width but the center to repeat.

: In addition to the usual PanelOverlayElement properties, this class has a 'border material', which specifies the material used for the edges of the panel, a border width (which can either be constant all the way around, or specified per edge), and the texture coordinates for each of the border sections.

Member Typedef Documentation

◆ ChildContainerIterator

typedef MapIterator<ChildContainerMap> Ogre::v1::OverlayContainer::ChildContainerIterator

inherited

◆ ChildContainerMap

typedef map<String, OverlayContainer*>::type Ogre::v1::OverlayContainer::ChildContainerMap

inherited

◆ ChildIterator

typedef MapIterator<ChildMap> Ogre::v1::OverlayContainer::ChildIterator

inherited

◆ ChildMap

typedef map<String, OverlayElement*>::type Ogre::v1::OverlayContainer::ChildMap

inherited

◆ CustomParameterMap

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

inherited

Constructor & Destructor Documentation

◆ BorderPanelOverlayElement()

Ogre::v1::BorderPanelOverlayElement::BorderPanelOverlayElement ( const String & name )

Constructor.

◆ ~BorderPanelOverlayElement()

virtual Ogre::v1::BorderPanelOverlayElement::~BorderPanelOverlayElement ( )

virtual

Member Function Documentation

◆ _addChild()

void Ogre::v1::OverlayContainer::_addChild ( OverlayElement * elem )

inherited

◆ _getClippingRegion()

virtual void Ogre::v1::OverlayElement::_getClippingRegion ( RealRect & clippingRegion )

virtualinherited

Gets the clipping region of the element.

◆ _getDerivedLeft()

virtual Real Ogre::v1::OverlayElement::_getDerivedLeft ( void )

virtualinherited

Gets the 'left' position as derived from own left and that of parents.

◆ _getDerivedTop()

virtual Real Ogre::v1::OverlayElement::_getDerivedTop ( void )

virtualinherited

Gets the 'top' position as derived from own left and that of parents.

◆ _getHeight()

Real Ogre::v1::OverlayElement::_getHeight ( void ) const

inlineinherited

Gets the height of this element in relation to the screen (where 1.0 = screen height)

◆ _getLeft()

Real Ogre::v1::OverlayElement::_getLeft ( void ) const

inlineinherited

Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ _getRelativeHeight()

virtual Real Ogre::v1::OverlayElement::_getRelativeHeight ( void )

virtualinherited

Gets the 'height' as derived from own height and metrics mode.

◆ _getRelativeWidth()

virtual Real Ogre::v1::OverlayElement::_getRelativeWidth ( void )

virtualinherited

Gets the 'width' as derived from own width and metrics mode.

◆ _getTop()

Real Ogre::v1::OverlayElement::_getTop ( void ) const

inlineinherited

Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ _getWidth()

Real Ogre::v1::OverlayElement::_getWidth ( void ) const

inlineinherited

Gets the width of this element in relation to the screen (where 1.0 = screen width)

◆ _notifyParent()

virtual void Ogre::v1::OverlayContainer::_notifyParent	(	OverlayContainer *	parent,
		Overlay *	overlay
	)

virtualinherited

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ _notifyViewport()

virtual void Ogre::v1::OverlayContainer::_notifyViewport ( )

virtualinherited

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ _positionsOutOfDate()

virtual void Ogre::v1::OverlayContainer::_positionsOutOfDate ( void )

virtualinherited

Tell the object and its children to recalculate.

Reimplemented from Ogre::v1::OverlayElement.

◆ _releaseManualHardwareResources()

virtual void Ogre::v1::BorderPanelOverlayElement::_releaseManualHardwareResources ( )

virtual

Reimplemented from Ogre::v1::PanelOverlayElement.

◆ _removeChild() [1/2]

void Ogre::v1::OverlayContainer::_removeChild ( OverlayElement * elem )

inlineinherited

References Ogre::v1::OverlayContainer::_removeChild(), and Ogre::v1::OverlayElement::getName().

Referenced by Ogre::v1::OverlayContainer::_removeChild().

◆ _removeChild() [2/2]

void Ogre::v1::OverlayContainer::_removeChild ( const String & name )

inherited

◆ _restoreManualHardwareResources()

virtual void Ogre::v1::BorderPanelOverlayElement::_restoreManualHardwareResources ( )

virtual

Reimplemented from Ogre::v1::PanelOverlayElement.

◆ _setDimensions()

void Ogre::v1::OverlayElement::_setDimensions	(	Real	width,
		Real	height
	)

inherited

Sets the width and height of this element in relation to the screen (where 1.0 = screen width)

◆ _setHeight()

void Ogre::v1::OverlayElement::_setHeight ( Real height )

inherited

Sets the height of this element in relation to the screen (where 1.0 = screen width)

◆ _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.

◆ _setLeft()

void Ogre::v1::OverlayElement::_setLeft ( Real left )

inherited

Sets the left of this element in relation to the screen (where 1.0 = screen width)

◆ _setNullDatablock()

virtual void Ogre::Renderable::_setNullDatablock ( void )

virtualinherited

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 in Ogre::v1::BillboardSet, and Ogre::v1::SubEntity.

◆ _setParent()

void Ogre::v1::OverlayElement::_setParent ( OverlayContainer * parent )

inlineinherited

◆ _setPosition()

void Ogre::v1::OverlayElement::_setPosition	(	Real	left,
		Real	top
	)

inherited

Sets the left and top of this element in relation to the screen (where 1.0 = screen width)

◆ _setTop()

void Ogre::v1::OverlayElement::_setTop ( Real top )

inherited

Sets the top of this element in relation to the screen (where 1.0 = screen width)

◆ _setWidth()

void Ogre::v1::OverlayElement::_setWidth ( Real width )

inherited

Sets the width of this element in relation to the screen (where 1.0 = screen width)

◆ _update()

void Ogre::v1::BorderPanelOverlayElement::_update ( void )

virtual

Internal method to update the element based on transforms applied.

Reimplemented from Ogre::v1::OverlayContainer.

◆ _updateCustomGpuParameter()

virtual void Ogre::Renderable::_updateCustomGpuParameter	(	const GpuProgramParameters_AutoConstantEntry &	constantEntry,
		GpuProgramParameters *	params
	)		const

virtualinherited

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks: This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.

: You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.

Parameters

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.

Reimplemented in Ogre::v1::SubEntity.

◆ _updateFromParent()

virtual void Ogre::v1::OverlayElement::_updateFromParent ( void )

virtualinherited

Updates this elements transform based on it's parent.

◆ _updateRenderQueue()

void Ogre::v1::BorderPanelOverlayElement::_updateRenderQueue	(	RenderQueue *	queue,
		Camera *	camera,
		const Camera *	lodCamera
	)

virtual

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayContainer.

◆ addChild()

virtual void Ogre::v1::OverlayContainer::addChild ( OverlayElement * elem )

virtualinherited

Adds another OverlayElement to this container.

◆ addChildImpl() [1/2]

virtual void Ogre::v1::OverlayContainer::addChildImpl ( OverlayElement * elem )

virtualinherited

Adds another OverlayElement to this container.

◆ addChildImpl() [2/2]

virtual void Ogre::v1::OverlayContainer::addChildImpl ( OverlayContainer * cont )

virtualinherited

Add a nested container to this container.

◆ addPoseWeight()

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

inherited

Referenced by Ogre::SubItem::getParent().

◆ cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary ( )

staticinherited

Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

MaterialManager) initializes.

◆ clone()

virtual OverlayElement* Ogre::v1::OverlayContainer::clone ( const String & instanceName )

virtualinherited

Reimplemented from Ogre::v1::OverlayElement.

◆ contains()

virtual bool Ogre::v1::OverlayElement::contains	(	Real	x,
		Real	y
	)		const

virtualinherited

Returns true if xy is within the constraints of the component.

◆ copyFromTemplate()

void Ogre::v1::OverlayContainer::copyFromTemplate ( OverlayElement * templateOverlay )

virtualinherited

Reimplemented from Ogre::v1::OverlayElement.

◆ copyParametersTo()

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface * dest ) const

inlinevirtualinherited

Method for copying this object's parameters to another object.

Remarks: This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

: Any unrecognised parameters will be ignored as with setParameter method.

Parameters

dest	Pointer to object to have it's parameters set the same as this object.

References Ogre::StringInterface::setParameter().

◆ findElementAt()

virtual OverlayElement* Ogre::v1::OverlayContainer::findElementAt	(	Real	x,
		Real	y
	)

virtualinherited

This returns a OverlayElement at position x,y.

Reimplemented from Ogre::v1::OverlayElement.

◆ getBorderMaterialName()

const String& Ogre::v1::BorderPanelOverlayElement::getBorderMaterialName ( void ) const

Gets the name of the material to use for the borders.

◆ getBottomBorderSize()

Real Ogre::v1::BorderPanelOverlayElement::getBottomBorderSize ( void ) const

Gets the size of the bottom border.

◆ getBottomBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getBottomBorderUVString ( ) const

◆ getBottomLeftBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getBottomLeftBorderUVString ( ) const

◆ getBottomRightBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getBottomRightBorderUVString ( ) const

◆ getCaption()

virtual const DisplayString& Ogre::v1::OverlayElement::getCaption ( void ) const

virtualinherited

Gets the caption for this element.

◆ getCastsShadows()

virtual bool Ogre::Renderable::getCastsShadows ( void ) const

inlinevirtualinherited

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 in Ogre::ManualObject::ManualObjectSection, Ogre::v1::StaticGeometry::GeometryBucket, Ogre::v1::SubEntity, Ogre::Rectangle2D, Ogre::SubItem, Ogre::WireAabb, Ogre::IfdProbeVisualizer, and Ogre::VoxelVisualizer.

◆ getChild()

virtual OverlayElement* Ogre::v1::OverlayContainer::getChild ( const String & name )

virtualinherited

Gets the named child of this container.

◆ getChildContainerIterator()

virtual ChildContainerIterator Ogre::v1::OverlayContainer::getChildContainerIterator ( void )

virtualinherited

Gets an iterator for just the container children of this object.

Remarks: Good for cascading updates without having to use RTTI

◆ getChildIterator()

virtual ChildIterator Ogre::v1::OverlayContainer::getChildIterator ( void )

virtualinherited

Gets an object for iterating over all the children of this object.

◆ getColour()

virtual const ColourValue& Ogre::v1::OverlayElement::getColour ( void ) const

virtualinherited

Gets the colour for this element.

Reimplemented in Ogre::v1::TextAreaOverlayElement.

◆ getCurrentMaterialLod()

uint8 Ogre::Renderable::getCurrentMaterialLod ( void ) const

inlineinherited

References ARRAY_PACKED_REALS, and Ogre::LodStrategy::lodSet().

◆ 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 ( void ) const

inlineinherited

◆ getDatablock()

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

inlineinherited

◆ getHeight()

Real Ogre::v1::OverlayElement::getHeight ( void ) const

inherited

Gets the height of this element in relation to the screen (where 1.0 = screen height)

◆ getHlmsCasterHash()

uint32 Ogre::Renderable::getHlmsCasterHash ( void ) const

inlineinherited

◆ getHlmsHash()

uint32 Ogre::Renderable::getHlmsHash ( void ) const

inlineinherited

◆ getHorizontalAlignment()

virtual GuiHorizontalAlignment Ogre::v1::OverlayElement::getHorizontalAlignment ( void ) const

virtualinherited

Gets the horizontal alignment for this element.

◆ getLeft()

Real Ogre::v1::OverlayElement::getLeft ( void ) const

inherited

Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ getLeftBorderSize()

Real Ogre::v1::BorderPanelOverlayElement::getLeftBorderSize ( void ) const

Gets the size of the left border.

◆ getLeftBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getLeftBorderUVString ( ) const

◆ getLights()

const LightList& Ogre::v1::OverlayElement::getLights ( void ) const

inlinevirtualinherited

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

const MaterialPtr& Ogre::v1::OverlayElement::getMaterial ( void ) const

inherited

See Renderable.

◆ getMaterialName()

virtual const String& Ogre::v1::OverlayElement::getMaterialName ( void ) const

virtualinherited

Gets the name of the material this element uses.

◆ getMetricsMode()

virtual GuiMetricsMode Ogre::v1::OverlayElement::getMetricsMode ( void ) const

virtualinherited

Retrieves the current settings of how the element metrics are interpreted.

◆ getName()

const String& Ogre::v1::OverlayElement::getName ( void ) const

inherited

Gets the name of this overlay.

Referenced by Ogre::v1::OverlayContainer::_removeChild().

◆ getNumPoses()

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

inherited

◆ getNumWorldTransforms()

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void ) const

inlinevirtualinherited

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 in Ogre::v1::BorderRenderable, and Ogre::v1::SubEntity.

◆ getParamDictionary() [1/2]

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void )

inlineinherited

Retrieves the parameter dictionary for this class.

Remarks: Only valid to call this after createParamDictionary.

Returns: Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

◆ getParamDictionary() [2/2]

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) const

inlineinherited

◆ getParameter()

virtual String Ogre::StringInterface::getParameter ( const String & name ) const

inlinevirtualinherited

Generic parameter retrieval method.

Remarks: Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters

name	The name of the parameter to get

Returns: String value of parameter, blank if not found

References Ogre::ParamCommand::doGet().

◆ getParameters()

const ParameterList& Ogre::StringInterface::getParameters ( void ) const

inherited

Retrieves a list of parameters valid for this object.

Returns: A reference to a static list of ParameterDef objects.

◆ getParent()

OverlayContainer* Ogre::v1::OverlayElement::getParent ( )

inherited

Returns the parent container.

◆ getPolygonModeOverrideable()

virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void ) 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

Referenced by Ogre::SubItem::getParent().

◆ getPoseWeights()

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

inherited

◆ getRenderOperation()

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

virtualinherited

See Renderable.

Implements Ogre::Renderable.

◆ getRenderQueueSubGroup()

uint8 Ogre::Renderable::getRenderQueueSubGroup ( void ) const

inlineinherited

References Ogre::NumVertexPass.

◆ getRightBorderSize()

Real Ogre::v1::BorderPanelOverlayElement::getRightBorderSize ( void ) const

Gets the size of the right border.

◆ getRightBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getRightBorderUVString ( ) const

◆ getSourceTemplate()

const OverlayElement* Ogre::v1::OverlayElement::getSourceTemplate ( ) const

inlineinherited

Returns the SourceTemplate for this element.

◆ getTileX()

Real Ogre::v1::PanelOverlayElement::getTileX ( ushort layer = 0 ) const

inherited

◆ getTileY()

Real Ogre::v1::PanelOverlayElement::getTileY ( ushort layer = 0 ) const

inherited

Gets the number of times the texture should repeat vertically.

Parameters

layer The texture layer to specify (only needs to be altered if you're using a multi-texture layer material)

◆ getTop()

Real Ogre::v1::OverlayElement::getTop ( void ) const

inherited

Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)

◆ getTopBorderSize()

Real Ogre::v1::BorderPanelOverlayElement::getTopBorderSize ( void ) const

Gets the size of the top border.

◆ getTopBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getTopBorderUVString ( ) const

◆ getTopLeftBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getTopLeftBorderUVString ( ) const

◆ getTopRightBorderUVString()

String Ogre::v1::BorderPanelOverlayElement::getTopRightBorderUVString ( ) const

◆ getTypeName()

const String& Ogre::v1::BorderPanelOverlayElement::getTypeName ( void ) const

virtual

See OverlayElement.

Reimplemented from Ogre::v1::PanelOverlayElement.

◆ getUseIdentityProjection()

bool Ogre::Renderable::getUseIdentityProjection ( void ) 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 ( void ) 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 ( void ) 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 ( void ) 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 ( void ) 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.

◆ getUV()

void Ogre::v1::PanelOverlayElement::getUV	(	Real &	u1,
		Real &	v1,
		Real &	u2,
		Real &	v2
	)		const

inherited

Get the uv coordinates for the panel.

◆ getVaos()

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

inlineinherited

◆ getVerticalAlignment()

virtual GuiVerticalAlignment Ogre::v1::OverlayElement::getVerticalAlignment ( void ) const

virtualinherited

Gets the vertical alignment for this element.

◆ getWidth()

Real Ogre::v1::OverlayElement::getWidth ( void ) const

inherited

Gets the width of this element in relation to the screen (where 1.0 = screen width)

◆ getWorldTransforms()

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

virtualinherited

See Renderable.

Implements Ogre::Renderable.

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

◆ 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 ( void ) const

inlineinherited

◆ hide()

virtual void Ogre::v1::OverlayElement::hide ( void )

virtualinherited

Hides this element if it was visible.

◆ initialise()

virtual void Ogre::v1::BorderPanelOverlayElement::initialise ( void )

virtual

Initialise.

Reimplemented from Ogre::v1::PanelOverlayElement.

◆ isChildrenProcessEvents()

virtual bool Ogre::v1::OverlayContainer::isChildrenProcessEvents ( ) const

inlinevirtualinherited

Should this container pass events to their children.

◆ isCloneable()

virtual bool Ogre::v1::OverlayElement::isCloneable ( ) const

inlinevirtualinherited

◆ isContainer()

bool Ogre::v1::OverlayContainer::isContainer ( ) const

inlinevirtualinherited

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ isEnabled()

bool Ogre::v1::OverlayElement::isEnabled ( ) const

inherited

◆ isKeyEnabled()

virtual bool Ogre::v1::OverlayElement::isKeyEnabled ( ) const

inlinevirtualinherited

◆ isTransparent()

bool Ogre::v1::PanelOverlayElement::isTransparent ( void ) const

inherited

Returns whether this panel is transparent.

◆ isVisible()

bool Ogre::v1::OverlayElement::isVisible ( void ) const

inherited

Returns whether or not the element is visible.

◆ 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,
		void *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

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

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,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [2/3]

template<class Alloc >

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

inlineinherited

◆ 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,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

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

template<class Alloc >

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

inlineinherited

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

◆ removeChild()

virtual void Ogre::v1::OverlayContainer::removeChild ( const String & name )

virtualinherited

Removes a named element from this container.

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

◆ setBorderMaterialName()

void Ogre::v1::BorderPanelOverlayElement::setBorderMaterialName ( const String & name )

Sets the name of the material to use for the borders.

◆ setBorderSize() [1/3]

void Ogre::v1::BorderPanelOverlayElement::setBorderSize ( Real size )

Sets the size of the border.

Remarks: This method sets a constant size for all borders. There are also alternative methods which allow you to set border widths for individual edges separately. Remember that the dimensions specified here are in relation to the size of the screen, so 0.1 is 1/10th of the screen width or height. Also note that because most screen resolutions are 1.333:1 width:height ratio that using the same border size will look slightly bigger across than up.

Parameters

size	The size of the border as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.

◆ setBorderSize() [2/3]

void Ogre::v1::BorderPanelOverlayElement::setBorderSize	(	Real	sides,
		Real	topAndBottom
	)

Sets the size of the border, with different sizes for vertical and horizontal borders.

Remarks: This method sets a size for the side and top / bottom borders separately. Remember that the dimensions specified here are in relation to the size of the screen, so 0.1 is 1/10th of the screen width or height. Also note that because most screen resolutions are 1.333:1 width:height ratio that using the same border size will look slightly bigger across than up.

Parameters

sides	The size of the side borders as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.
topAndBottom	The size of the top and bottom borders as a factor of the screen dimensions.

◆ setBorderSize() [3/3]

void Ogre::v1::BorderPanelOverlayElement::setBorderSize	(	Real	left,
		Real	right,
		Real	top,
		Real	bottom
	)

Sets the size of the border separately for all borders.

Remarks: This method sets a size all borders separately. Remember that the dimensions specified here are in relation to the size of the screen, so 0.1 is 1/10th of the screen width or height. Also note that because most screen resolutions are 1.333:1 width:height ratio that using the same border size will look slightly bigger across than up.

Parameters

left	The size of the left border as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.
right	The size of the left border as a factor of the screen dimensions.
top	The size of the top border as a factor of the screen dimensions.
bottom	The size of the bottom border as a factor of the screen dimensions.

◆ setBottomBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setBottomBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the bottom edge of the border.

Remarks: See setLeftBorderUV.

◆ setBottomLeftBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setBottomLeftBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the bottom-left corner of the border.

Remarks: See setLeftBorderUV.

◆ setBottomRightBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setBottomRightBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the bottom-right corner of the border.

Remarks: See setLeftBorderUV.

◆ setCaption()

virtual void Ogre::v1::OverlayElement::setCaption ( const DisplayString & text )

virtualinherited

Sets the caption on elements that support it.

Remarks: This property doesn't do something on all elements, just those that support it. However, being a common requirement it is in the top-level interface to avoid having to set it via the StringInterface all the time.

Reimplemented in Ogre::v1::TextAreaOverlayElement.

◆ setChildrenProcessEvents()

virtual void Ogre::v1::OverlayContainer::setChildrenProcessEvents ( bool val )

inlinevirtualinherited

Should this container pass events to their children.

◆ setCloneable()

virtual void Ogre::v1::OverlayElement::setCloneable ( bool c )

inlinevirtualinherited

◆ setColour()

virtual void Ogre::v1::OverlayElement::setColour ( const ColourValue & col )

virtualinherited

Sets the colour on elements that support it.

Remarks: This property doesn't do something on all elements, just those that support it. However, being a common requirement it is in the top-level interface to avoid having to set it via the StringInterface all the time.

Reimplemented in Ogre::v1::TextAreaOverlayElement.

◆ 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/2]

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() [2/2]

virtual void Ogre::Renderable::setDatablock ( HlmsDatablock * datablock )

virtualinherited

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

Reimplemented in Ogre::v1::BillboardSet, and Ogre::v1::SubEntity.

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

◆ setDimensions()

void Ogre::v1::OverlayElement::setDimensions	(	Real	width,
		Real	height
	)

inherited

Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).

◆ setEnabled()

virtual void Ogre::v1::OverlayElement::setEnabled ( bool b )

virtualinherited

◆ setHeight()

void Ogre::v1::OverlayElement::setHeight ( Real height )

inherited

Sets the height of this element in relation to the screen (where 1.0 = screen height)

◆ setHorizontalAlignment()

virtual void Ogre::v1::OverlayElement::setHorizontalAlignment ( GuiHorizontalAlignment gha )

virtualinherited

Sets the horizontal origin for this element.

Remarks: By default, the horizontal origin for a OverlayElement is the left edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-based metrics (see setMetricsMode) since in this mode you can't use relative positioning.

: For example, if you were using GMM_PIXELS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use GHA_CENTER with a 'left' property of -15.

: Note that neither GHA_CENTER or GHA_RIGHT alter the position of the element based on it's width, you have to alter the 'left' to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and right with different 'left' offsets for maximum flexibility.

◆ setLeft()

void Ogre::v1::OverlayElement::setLeft ( Real left )

inherited

Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ setLeftBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setLeftBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the left edge of the border.

Remarks: The border panel uses 8 panels for the border (9 including the center). Imagine a table with 3 rows and 3 columns. The corners are always the same size, but the edges stretch depending on how big the panel is. Those who have done resizable HTML tables will be familiar with this approach.

: We only require 2 sets of uv coordinates, one for the top-left and one for the bottom-right of the panel, since it is assumed the sections are aligned on the texture.

◆ setMaterial()

virtual void Ogre::Renderable::setMaterial ( const MaterialPtr & material )

virtualinherited

Sets the given material. Overrides HLMS materials.

Reimplemented in Ogre::v1::BillboardSet, Ogre::v1::SubEntity, and Ogre::v1::SimpleRenderable.

◆ setMaterialName() [1/2]

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

inherited

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

◆ setMaterialName() [2/2]

void Ogre::v1::PanelOverlayElement::setMaterialName ( const String & matName )

virtualinherited

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ setMetricsMode()

void Ogre::v1::BorderPanelOverlayElement::setMetricsMode ( GuiMetricsMode gmm )

virtual

Tells this element how to interpret the position and dimension values it is given.

Remarks: By default, OverlayElements are positioned and sized according to relative dimensions of the screen. This is to ensure portability between different resolutions when you want things to be positioned and sized the same way across all resolutions. However, sometimes you want things to be sized according to fixed pixels. In order to do this, you can call this method with the parameter GMM_PIXELS. Note that if you then want to place your element relative to the center, right or bottom of it's parent, you will need to use the setHorizontalAlignment and setVerticalAlignment methods.

Reimplemented from Ogre::v1::OverlayElement.

◆ setParameter()

virtual bool Ogre::StringInterface::setParameter	(	const String &	name,
		const String &	value
	)

virtualinherited

Generic parameter setting method.

Remarks: Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

name	The name of the parameter to set
value	String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns: true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

◆ setParameterList()

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList & paramList )

virtualinherited

Generic multiple parameter setting method.

Remarks: Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters

paramList Name/value pair list

◆ 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

Referenced by Ogre::SubItem::getParent().

◆ setPosition()

void Ogre::v1::OverlayElement::setPosition	(	Real	left,
		Real	top
	)

inherited

Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height)

◆ 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 ) RenderQueue

◆ setRightBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setRightBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the right edge of the border.

Remarks: See setLeftBorderUV.

◆ setTiling()

void Ogre::v1::PanelOverlayElement::setTiling	(	Real	x,
		Real	y,
		ushort	layer = `0`
	)

inherited

Sets the number of times textures should repeat.

Parameters

x	The number of times the texture should repeat horizontally
y	The number of times the texture should repeat vertically
layer	The texture layer to specify (only needs to be altered if you're using a multi-texture layer material)

◆ setTop()

void Ogre::v1::OverlayElement::setTop ( Real Top )

inherited

Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)

◆ setTopBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setTopBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the top edge of the border.

Remarks: See setLeftBorderUV.

◆ setTopLeftBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setTopLeftBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the top-left corner of the border.

Remarks: See setLeftBorderUV.

◆ setTopRightBorderUV()

void Ogre::v1::BorderPanelOverlayElement::setTopRightBorderUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

Sets the texture coordinates for the top-right corner of the border.

Remarks: See setLeftBorderUV.

◆ setTransparent()

void Ogre::v1::PanelOverlayElement::setTransparent ( bool isTransparent )

inherited

Sets whether this panel is transparent (used only as a grouping level), or if it is actually rendered.

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

◆ setUV()

void Ogre::v1::PanelOverlayElement::setUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)

inherited

Sets the texture coordinates for the panel.

◆ setVerticalAlignment()

virtual void Ogre::v1::OverlayElement::setVerticalAlignment ( GuiVerticalAlignment gva )

virtualinherited

Sets the vertical origin for this element.

Remarks: By default, the vertical origin for a OverlayElement is the top edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-based metrics (see setMetricsMode) since in this mode you can't use relative positioning.

: For example, if you were using GMM_PIXELS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use GHA_CENTER with a 'top' property of -15.

: Note that neither GVA_CENTER or GVA_BOTTOM alter the position of the element based on it's height, you have to alter the 'top' to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and bottom with different 'top' offsets for maximum flexibility.

◆ setWidth()

void Ogre::v1::OverlayElement::setWidth ( Real width )

inherited

Sets the width of this element in relation to the screen (where 1.0 = screen width)

◆ show()

virtual void Ogre::v1::OverlayElement::show ( void )

virtualinherited

Shows this element if it was hidden.

Friends And Related Function Documentation

◆ BorderRenderable

friend class BorderRenderable

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.

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

OgreBorderPanelOverlayElement.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ChildContainerIterator

◆ ChildContainerMap

◆ ChildIterator

◆ ChildMap

◆ CustomParameterMap

Constructor & Destructor Documentation

◆ BorderPanelOverlayElement()

◆ ~BorderPanelOverlayElement()

Member Function Documentation

◆ _addChild()

◆ _getClippingRegion()

◆ _getDerivedLeft()

◆ _getDerivedTop()

◆ _getHeight()

◆ _getLeft()

◆ _getRelativeHeight()

◆ _getRelativeWidth()

◆ _getTop()

◆ _getWidth()

◆ _notifyParent()

◆ _notifyViewport()

◆ _positionsOutOfDate()

◆ _releaseManualHardwareResources()

◆ _removeChild() [1/2]

◆ _removeChild() [2/2]

◆ _restoreManualHardwareResources()

◆ _setDimensions()

◆ _setHeight()

◆ _setHlmsHashes()

◆ _setLeft()

◆ _setNullDatablock()

◆ _setParent()

◆ _setPosition()

◆ _setTop()

◆ _setWidth()

◆ _update()

◆ _updateCustomGpuParameter()

◆ _updateFromParent()

◆ _updateRenderQueue()

◆ addChild()

◆ addChildImpl() [1/2]

◆ addChildImpl() [2/2]

◆ addPoseWeight()

◆ cleanupDictionary()

◆ clone()

◆ contains()

◆ copyFromTemplate()

◆ copyParametersTo()

◆ findElementAt()

◆ getBorderMaterialName()

◆ getBottomBorderSize()

◆ getBottomBorderUVString()

◆ getBottomLeftBorderUVString()

◆ getBottomRightBorderUVString()

◆ getCaption()

◆ getCastsShadows()

◆ getChild()

◆ getChildContainerIterator()

◆ getChildIterator()

◆ getColour()

◆ getCurrentMaterialLod()

◆ getCustomParameter()

◆ getCustomParameters()

◆ getDatablock()

◆ getHeight()

◆ getHlmsCasterHash()

◆ getHlmsHash()

◆ getHorizontalAlignment()

◆ getLeft()

◆ getLeftBorderSize()

◆ getLeftBorderUVString()

◆ getLights()