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

#include <OgreBorderPanelOverlayElement.h>

Inheritance diagram for Ogre::BorderPanelOverlayElement:

Classes
struct	CellUV
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
Public Member Functions
	BorderPanelOverlayElement (const String &name)
	Constructor.
virtual	~BorderPanelOverlayElement ()
void	_addChild (OverlayElement *elem)
virtual void	_getClippingRegion (RealRect &clippingRegion)
	Gets the clipping region of the element.
virtual Real	_getDerivedLeft (void)
	Gets the 'left' position as derived from own left and that of parents.
virtual Real	_getDerivedTop (void)
	Gets the 'top' position as derived from own left and that of parents.
Real	_getHeight (void) const
	Gets the height of this element in relation to the screen (where 1.0 = screen height)
Real	_getLeft (void) const
	Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
virtual Real	_getRelativeHeight (void)
	Gets the 'height' as derived from own height and metrics mode.
virtual Real	_getRelativeWidth (void)
	Gets the 'width' as derived from own width and metrics mode.
Real	_getTop (void) const
	Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right)
Real	_getWidth (void) const
	Gets the width of this element in relation to the screen (where 1.0 = screen width)
virtual void	_notifyParent (OverlayContainer parent, Overlay overlay)
	Overridden from OverlayElement.
virtual void	_notifyViewport ()
	Overridden from OverlayElement.
virtual void	_notifyWorldTransforms (const Matrix4 &xform)
	Overridden from OverlayElement.
virtual ushort	_notifyZOrder (ushort newZOrder)
	Overridden from OverlayElement.
virtual void	_positionsOutOfDate (void)
	Tell the object and its children to recalculate.
void	_removeChild (OverlayElement *elem)
void	_removeChild (const String &name)
void	_setDimensions (Real width, Real height)
	Sets the width and height of this element in relation to the screen (where 1.0 = screen width)
void	_setHeight (Real height)
	Sets the height of this element in relation to the screen (where 1.0 = screen width)
void	_setLeft (Real left)
	Sets the left of this element in relation to the screen (where 1.0 = screen width)
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)
void	_setTop (Real top)
	Sets the top of this element in relation to the screen (where 1.0 = screen width)
void	_setWidth (Real width)
	Sets the width of this element in relation to the screen (where 1.0 = screen width)
void	_update (void)
virtual void	_updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
	Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
virtual void	_updateFromParent (void)
	Updates this elements transform based on it's parent.
void	_updateRenderQueue (RenderQueue *queue)
virtual void	addChild (OverlayElement *elem)
	Adds another OverlayElement to this container.
virtual void	addChildImpl (OverlayElement *elem)
	Adds another OverlayElement to this container.
virtual void	addChildImpl (OverlayContainer *cont)
	Add a nested container to this container.
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.
void	copyFromTemplate (OverlayElement *templateOverlay)
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
virtual OverlayElement *	findElementAt (Real x, Real y)
	This returns a OverlayElement at position x,y.
const String &	getBorderMaterialName (void) const
	Gets the name of the material to use for the borders.
Real	getBottomBorderSize (void) const
	Gets the size of the bottom border.
String	getBottomBorderUVString () const
String	getBottomLeftBorderUVString () const
String	getBottomRightBorderUVString () const
virtual const DisplayString &	getCaption (void) const
	Gets the caption for this element.
virtual bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow.
virtual OverlayElement *	getChild (const String &name)
	Gets the named child of this container.
virtual ChildContainerIterator	getChildContainerIterator (void)
	Gets an iterator for just the container children of this object.
virtual ChildIterator	getChildIterator (void)
	Gets an object for iterating over all the children of this object.
virtual const ColourValue &	getColour (void) const
	Gets the colour for this element.
const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index.
Real	getHeight (void) const
	Gets the height of this element in relation to the screen (where 1.0 = screen height)
virtual GuiHorizontalAlignment	getHorizontalAlignment (void) const
	Gets the horizontal alignment for this element.
Real	getLeft (void) const
	Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
Real	getLeftBorderSize (void) const
	Gets the size of the left border.
String	getLeftBorderUVString () const
const LightList &	getLights (void) const
const MaterialPtr &	getMaterial (void) const
	See Renderable.
virtual const String &	getMaterialName (void) const
	Gets the name of the material this element uses.
virtual GuiMetricsMode	getMetricsMode (void) const
	Retrieves the current settings of how the element metrics are interpreted.
const String &	getName (void) const
	Gets the name of this overlay.
virtual unsigned short	getNumWorldTransforms (void) const
	Returns the number of world transform matrices this renderable requires.
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary (void) const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.
OverlayContainer *	getParent ()
	Returns the parent container.
virtual bool	getPolygonModeOverrideable (void) const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
void	getRenderOperation (RenderOperation &op)
	See Renderable.
virtual RenderSystemData *	getRenderSystemData () const
	Gets RenderSystem private data.
Real	getRightBorderSize (void) const
	Gets the size of the right border.
String	getRightBorderUVString () const
const OverlayElement *	getSourceTemplate () const
	Returns the SourceTemplate for this element.
Real	getSquaredViewDepth (const Camera *cam) const
	Overridden from Renderable.
virtual Technique *	getTechnique (void) const
	Retrieves a pointer to the Material Technique this renderable object uses.
Real	getTileX (ushort layer=0) const
Real	getTileY (ushort layer=0) const
	Gets the number of times the texture should repeat vertically.
Real	getTop (void) const
	Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
Real	getTopBorderSize (void) const
	Gets the size of the top border.
String	getTopBorderUVString () const
String	getTopLeftBorderUVString () const
String	getTopRightBorderUVString () const
const String &	getTypeName (void) const
	See OverlayElement.
bool	getUseIdentityProjection (void) const
	Returns whether or not to use an 'identity' projection.
bool	getUseIdentityView (void) const
	Returns whether or not to use an 'identity' view.
virtual OGRE_DEPRECATED const Any &	getUserAny (void) const
UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class.
const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class.
void	getUV (Real &u1, Real &v1, Real &u2, Real &v2) const
	Get the uv coordinates for the panel.
virtual GuiVerticalAlignment	getVerticalAlignment (void) const
	Gets the vertical alignment for this element.
Real	getWidth (void) const
	Gets the width of this element in relation to the screen (where 1.0 = screen width)
void	getWorldTransforms (Matrix4 *xform) const
	See Renderable.
ushort	getZOrder () const
	Returns the zOrder of the element.
bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index.
virtual void	hide (void)
	Hides this element if it was visible.
virtual void	initialise (void)
	Initialise.
virtual bool	isChildrenProcessEvents () const
	Should this container pass events to their children.
virtual bool	isCloneable () const
bool	isContainer () const
	Overridden from OverlayElement.
bool	isEnabled () const
virtual bool	isKeyEnabled () const
bool	isTransparent (void) const
	Returns whether this panel is transparent.
bool	isVisible (void) const
	Returns whether or not the element is visible.
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
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
virtual void	postRender (SceneManager sm, RenderSystem rsys)
	Called immediately after the Renderable has been rendered.
virtual bool	preRender (SceneManager sm, RenderSystem rsys)
	Called just prior to the Renderable being rendered.
virtual void	removeChild (const String &name)
	Removes a named element from this container.
void	removeCustomParameter (size_t index)
	Removes a custom value which is associated with this Renderable at the given index.
void	setBorderMaterialName (const String &name)
	Sets the name of the material to use for the borders.
void	setBorderSize (Real size)
	Sets the size of the border.
void	setBorderSize (Real sides, Real topAndBottom)
	Sets the size of the border, with different sizes for vertical and horizontal borders.
void	setBorderSize (Real left, Real right, Real top, Real bottom)
	Sets the size of the border separately for all borders.
void	setBottomBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the bottom edge of the border.
void	setBottomLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the bottom-left corner of the border.
void	setBottomRightBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the bottom-right corner of the border.
virtual void	setCaption (const DisplayString &text)
	Sets the caption on elements that support it.
virtual void	setChildrenProcessEvents (bool val)
	Should this container pass events to their children.
virtual void	setCloneable (bool c)
virtual void	setColour (const ColourValue &col)
	Sets the colour on elements that support it.
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.
void	setDimensions (Real width, Real height)
	Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).
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)
virtual void	setHorizontalAlignment (GuiHorizontalAlignment gha)
	Sets the horizontal origin for this element.
void	setLeft (Real left)
	Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
void	setLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the left edge of the border.
void	setMaterialName (const String &matName)
	Overridden from OverlayElement.
void	setMetricsMode (GuiMetricsMode gmm)
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.
virtual void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
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)
virtual void	setRenderSystemData (RenderSystemData *val) const
	Sets RenderSystem private data.
void	setRightBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the right edge of the border.
void	setTiling (Real x, Real y, ushort layer=0)
	Sets the number of times textures should repeat.
void	setTop (Real Top)
	Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
void	setTopBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the top edge of the border.
void	setTopLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the top-left corner of the border.
void	setTopRightBorderUV (Real u1, Real v1, Real u2, Real v2)
	Sets the texture coordinates for the top-right corner of the border.
void	setTransparent (bool isTransparent)
	Sets whether this panel is transparent (used only as a grouping level), or if it is actually rendered.
void	setUseIdentityProjection (bool useIdentityProjection)
	Sets whether or not to use an 'identity' projection.
void	setUseIdentityView (bool useIdentityView)
	Sets whether or not to use an 'identity' view.
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.
virtual void	setVerticalAlignment (GuiVerticalAlignment gva)
	Sets the vertical origin for this element.
void	setWidth (Real width)
	Sets the width of this element in relation to the screen (where 1.0 = screen width)
virtual void	show (void)
	Shows this element if it was hidden.
void	visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
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.
Protected Types
enum	BorderCellIndex { BCELL_TOP_LEFT = 0, BCELL_TOP = 1, BCELL_TOP_RIGHT = 2, BCELL_LEFT = 3, BCELL_RIGHT = 4, BCELL_BOTTOM_LEFT = 5, BCELL_BOTTOM = 6, BCELL_BOTTOM_RIGHT = 7 }
typedef map< size_t, Vector4 > ::type	CustomParameterMap
Protected Member Functions
void	addBaseParameters (void)
	Internal method for setting up parameters.
bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
String	getCellUVString (BorderCellIndex idx) const
void	updatePositionGeometry (void)
	internal method for setting up geometry, called by OverlayElement::update
void	updateTextureGeometry (void)
	internal method for setting up geometry, called by OverlayElement::update
Protected Attributes
MaterialPtr	mBorderMaterial
String	mBorderMaterialName
BorderRenderable *	mBorderRenderable
CellUV	mBorderUV [8]
Real	mBottomBorderSize
DisplayString	mCaption
ChildContainerMap	mChildContainers
	Map of container children (subset of mChildren)
ChildMap	mChildren
	Map of all children.
bool	mChildrenProcessEvents
RealRect	mClippingRegion
bool	mCloneable
ColourValue	mColour
CustomParameterMap	mCustomParameters
Real	mDerivedLeft
bool	mDerivedOutOfDate
Real	mDerivedTop
bool	mEnabled
	Is element enabled?
bool	mGeomPositionsOutOfDate
	Flag indicating if the vertex positions need recalculating.
bool	mGeomUVsOutOfDate
	Flag indicating if the vertex uvs need recalculating.
Real	mHeight
GuiHorizontalAlignment	mHorzAlign
bool	mInitialised
	Is element initialised?
Real	mLeft
Real	mLeftBorderSize
MaterialPtr	mMaterial
String	mMaterialName
GuiMetricsMode	mMetricsMode
String	mName
size_t	mNumTexCoordsInBuffer
Overlay *	mOverlay
	Overlay attached to.
OverlayContainer *	mParent
	Parent pointer.
ushort	mPixelBottomBorderSize
Real	mPixelHeight
Real	mPixelLeft
ushort	mPixelLeftBorderSize
ushort	mPixelRightBorderSize
Real	mPixelScaleX
Real	mPixelScaleY
Real	mPixelTop
ushort	mPixelTopBorderSize
Real	mPixelWidth
bool	mPolygonModeOverrideable
RenderOperation	mRenderOp
RenderOperation	mRenderOp2
	Render operation for the border area.
RenderSystemData *	mRenderSystemData
	User objects binding.
Real	mRightBorderSize
OverlayElement *	mSourceTemplate
	Used to see if this element is created from a Template.
Real	mTileX [OGRE_MAX_TEXTURE_LAYERS]
Real	mTileY [OGRE_MAX_TEXTURE_LAYERS]
Real	mTop
Real	mTopBorderSize
bool	mTransparent
	Flag indicating if this panel should be visual or just group things.
Real	mU1
Real	mU2
bool	mUseIdentityProjection
bool	mUseIdentityView
UserObjectBindings	mUserObjectBindings
Real	mV1
Real	mV2
GuiVerticalAlignment	mVertAlign
bool	mVisible
Real	mWidth
Matrix4	mXForm
	World transforms.
ushort	mZOrder
	Zorder for when sending to render queue.
Static Protected Attributes
static OverlayElementCommands::CmdCaption	msCaptionCmd
static CmdBorderBottomLeftUV	msCmdBorderBottomLeftUV
static CmdBorderBottomRightUV	msCmdBorderBottomRightUV
static CmdBorderBottomUV	msCmdBorderBottomUV
static CmdBorderLeftUV	msCmdBorderLeftUV
static CmdBorderMaterial	msCmdBorderMaterial
static CmdBorderRightUV	msCmdBorderRightUV
static CmdBorderSize	msCmdBorderSize
static CmdBorderTopLeftUV	msCmdBorderTopLeftUV
static CmdBorderTopRightUV	msCmdBorderTopRightUV
static CmdBorderTopUV	msCmdBorderTopUV
static CmdTiling	msCmdTiling
static CmdTransparent	msCmdTransparent
static CmdUVCoords	msCmdUVCoords
static OverlayElementCommands::CmdHeight	msHeightCmd
static OverlayElementCommands::CmdHorizontalAlign	msHorizontalAlignCmd
static OverlayElementCommands::CmdLeft	msLeftCmd
static OverlayElementCommands::CmdMaterial	msMaterialCmd
static OverlayElementCommands::CmdMetricsMode	msMetricsModeCmd
static OverlayElementCommands::CmdTop	msTopCmd
static String	msTypeName
static OverlayElementCommands::CmdVerticalAlign	msVerticalAlignCmd
static OverlayElementCommands::CmdVisible	msVisibleCmd
static OverlayElementCommands::CmdWidth	msWidthCmd
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.

Definition at line 57 of file OgreBorderPanelOverlayElement.h.

Member Typedef Documentation

typedef MapIterator<ChildContainerMap> Ogre::OverlayContainer::ChildContainerIterator [inherited]

Definition at line 62 of file OgreOverlayContainer.h.

typedef map<String, OverlayContainer*>::type Ogre::OverlayContainer::ChildContainerMap [inherited]

Definition at line 61 of file OgreOverlayContainer.h.

typedef MapIterator<ChildMap> Ogre::OverlayContainer::ChildIterator [inherited]

Definition at line 60 of file OgreOverlayContainer.h.

typedef map<String, OverlayElement*>::type Ogre::OverlayContainer::ChildMap [inherited]

Definition at line 59 of file OgreOverlayContainer.h.

typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap [protected, inherited]

Definition at line 414 of file OgreRenderable.h.

Member Enumeration Documentation

enum Ogre::BorderPanelOverlayElement::BorderCellIndex [protected]

Enumerator:

BCELL_TOP_LEFT
BCELL_TOP
BCELL_TOP_RIGHT
BCELL_LEFT
BCELL_RIGHT
BCELL_BOTTOM_LEFT
BCELL_BOTTOM
BCELL_BOTTOM_RIGHT

Definition at line 288 of file OgreBorderPanelOverlayElement.h.

Constructor & Destructor Documentation

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

Constructor.

virtual Ogre::BorderPanelOverlayElement::~BorderPanelOverlayElement ( ) [virtual]

Member Function Documentation

void Ogre::OverlayContainer::_addChild ( OverlayElement * elem ) [inherited]

virtual void Ogre::OverlayElement::_getClippingRegion ( RealRect & clippingRegion ) [virtual, inherited]

Gets the clipping region of the element.

virtual Real Ogre::OverlayElement::_getDerivedLeft ( void ) [virtual, inherited]

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

virtual Real Ogre::OverlayElement::_getDerivedTop ( void ) [virtual, inherited]

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

Real Ogre::OverlayElement::_getHeight ( void ) const [inherited]

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

Definition at line 262 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::_getLeft ( void ) const [inherited]

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

Definition at line 256 of file OgreOverlayElement.h.

virtual Real Ogre::OverlayElement::_getRelativeHeight ( void ) [virtual, inherited]

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

virtual Real Ogre::OverlayElement::_getRelativeWidth ( void ) [virtual, inherited]

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

Real Ogre::OverlayElement::_getTop ( void ) const [inherited]

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

Definition at line 258 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::_getWidth ( void ) const [inherited]

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

Definition at line 260 of file OgreOverlayElement.h.

virtual void Ogre::OverlayContainer::_notifyParent	(	OverlayContainer *	parent,
		Overlay *	overlay
	)		`[virtual, inherited]`

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

virtual void Ogre::OverlayContainer::_notifyViewport ( ) [virtual, inherited]

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

virtual void Ogre::OverlayContainer::_notifyWorldTransforms ( const Matrix4 & xform ) [virtual, inherited]

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

virtual ushort Ogre::OverlayContainer::_notifyZOrder ( ushort newZOrder ) [virtual, inherited]

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

virtual void Ogre::OverlayContainer::_positionsOutOfDate ( void ) [virtual, inherited]

Tell the object and its children to recalculate.

Reimplemented from Ogre::OverlayElement.

void Ogre::OverlayContainer::_removeChild ( OverlayElement * elem ) [inherited]

Definition at line 91 of file OgreOverlayContainer.h.

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

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

void Ogre::OverlayContainer::_removeChild ( const String & name ) [inherited]

void Ogre::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)

void Ogre::OverlayElement::_setHeight ( Real height ) [inherited]

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

void Ogre::OverlayElement::_setLeft ( Real left ) [inherited]

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

void Ogre::OverlayElement::_setParent ( OverlayContainer * parent ) [inherited]

Definition at line 460 of file OgreOverlayElement.h.

void Ogre::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)

void Ogre::OverlayElement::_setTop ( Real top ) [inherited]

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

void Ogre::OverlayElement::_setWidth ( Real width ) [inherited]

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

void Ogre::BorderPanelOverlayElement::_update ( void ) [virtual]

Internal method to update the element based on transforms applied.

Reimplemented from Ogre::OverlayContainer.

virtual void Ogre::Renderable::_updateCustomGpuParameter	(	const GpuProgramParameters::AutoConstantEntry &	constantEntry,
		GpuProgramParameters *	params
	)		const `[virtual, inherited]`

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

Definition at line 307 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.

virtual void Ogre::OverlayElement::_updateFromParent ( void ) [virtual, inherited]

Updates this elements transform based on it's parent.

void Ogre::BorderPanelOverlayElement::_updateRenderQueue ( RenderQueue * queue ) [virtual]

Overridden from OverlayElement.

Reimplemented from Ogre::PanelOverlayElement.

void Ogre::BorderPanelOverlayElement::addBaseParameters ( void ) [protected, virtual]

Internal method for setting up parameters.

Reimplemented from Ogre::PanelOverlayElement.

virtual void Ogre::OverlayContainer::addChild ( OverlayElement * elem ) [virtual, inherited]

Adds another OverlayElement to this container.

virtual void Ogre::OverlayContainer::addChildImpl ( OverlayElement * elem ) [virtual, inherited]

Adds another OverlayElement to this container.

virtual void Ogre::OverlayContainer::addChildImpl ( OverlayContainer * cont ) [virtual, inherited]

Add a nested container to this container.

static void Ogre::StringInterface::cleanupDictionary ( ) [static, inherited]

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.

virtual OverlayElement* Ogre::OverlayContainer::clone ( const String & instanceName ) [virtual, inherited]

Reimplemented from Ogre::OverlayElement.

virtual bool Ogre::OverlayElement::contains	(	Real	x,
		Real	y
	)		const `[virtual, inherited]`

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

void Ogre::OverlayContainer::copyFromTemplate ( OverlayElement * templateOverlay ) [virtual, inherited]

Reimplemented from Ogre::OverlayElement.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface * dest ) const [virtual, inherited]

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.

Definition at line 303 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

bool Ogre::StringInterface::createParamDictionary ( const String & className ) [protected, inherited]

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:: This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters:

className the name of the class using the dictionary

Returns:: true if a new dictionary was created, false if it was already there

Definition at line 186 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

virtual OverlayElement* Ogre::OverlayContainer::findElementAt	(	Real	x,
		Real	y
	)		`[virtual, inherited]`

This returns a OverlayElement at position x,y.

Reimplemented from Ogre::OverlayElement.

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

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

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

Gets the size of the bottom border.

String Ogre::BorderPanelOverlayElement::getBottomBorderUVString ( ) const

String Ogre::BorderPanelOverlayElement::getBottomLeftBorderUVString ( ) const

String Ogre::BorderPanelOverlayElement::getBottomRightBorderUVString ( ) const

virtual const DisplayString& Ogre::OverlayElement::getCaption ( void ) const [virtual, inherited]

Gets the caption for this element.

virtual bool Ogre::Renderable::getCastsShadows ( void ) const [virtual, inherited]

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::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.

Definition at line 224 of file OgreRenderable.h.

String Ogre::BorderPanelOverlayElement::getCellUVString ( BorderCellIndex idx ) const [protected]

virtual OverlayElement* Ogre::OverlayContainer::getChild ( const String & name ) [virtual, inherited]

Gets the named child of this container.

virtual ChildContainerIterator Ogre::OverlayContainer::getChildContainerIterator ( void ) [virtual, inherited]

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

Remarks:: Good for cascading updates without having to use RTTI

virtual ChildIterator Ogre::OverlayContainer::getChildIterator ( void ) [virtual, inherited]

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

virtual const ColourValue& Ogre::OverlayElement::getColour ( void ) const [virtual, inherited]

Gets the colour for this element.

Reimplemented in Ogre::TextAreaOverlayElement.

const Vector4& Ogre::Renderable::getCustomParameter ( size_t index ) const [inherited]

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.

Definition at line 268 of file OgreRenderable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

Real Ogre::OverlayElement::getHeight ( void ) const [inherited]

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

virtual GuiHorizontalAlignment Ogre::OverlayElement::getHorizontalAlignment ( void ) const [virtual, inherited]

Gets the horizontal alignment for this element.

Real Ogre::OverlayElement::getLeft ( void ) const [inherited]

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

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

Gets the size of the left border.

String Ogre::BorderPanelOverlayElement::getLeftBorderUVString ( ) const

const LightList& Ogre::OverlayElement::getLights ( void ) const [virtual, inherited]

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.

Definition at line 476 of file OgreOverlayElement.h.

const MaterialPtr& Ogre::OverlayElement::getMaterial ( void ) const [virtual, inherited]

See Renderable.

Implements Ogre::Renderable.

Reimplemented in Ogre::TextAreaOverlayElement.

virtual const String& Ogre::OverlayElement::getMaterialName ( void ) const [virtual, inherited]

Gets the name of the material this element uses.

virtual GuiMetricsMode Ogre::OverlayElement::getMetricsMode ( void ) const [virtual, inherited]

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

const String& Ogre::OverlayElement::getName ( void ) const [inherited]

Gets the name of this overlay.

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

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void ) const [virtual, inherited]

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::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.

Definition at line 153 of file OgreRenderable.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) [inherited]

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.

Definition at line 219 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) const [inherited]

Definition at line 224 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String & name ) const [virtual, inherited]

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

Definition at line 272 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

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.

OverlayContainer* Ogre::OverlayElement::getParent ( ) [inherited]

Returns the parent container.

virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void ) const [virtual, inherited]

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 332 of file OgreRenderable.h.

void Ogre::PanelOverlayElement::getRenderOperation ( RenderOperation & op ) [virtual, inherited]

See Renderable.

Implements Ogre::Renderable.

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData ( ) const [virtual, inherited]

Gets RenderSystem private data.

Remarks:: This should only be used by a RenderSystem

Definition at line 399 of file OgreRenderable.h.

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

Gets the size of the right border.

String Ogre::BorderPanelOverlayElement::getRightBorderUVString ( ) const

const OverlayElement* Ogre::OverlayElement::getSourceTemplate ( ) const [inherited]

Returns the SourceTemplate for this element.

Definition at line 487 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::getSquaredViewDepth ( const Camera * cam ) const [virtual, inherited]

Overridden from Renderable.

Implements Ogre::Renderable.

Definition at line 469 of file OgreOverlayElement.h.

virtual Technique* Ogre::Renderable::getTechnique ( void ) const [virtual, inherited]

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks:: This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 94 of file OgreRenderable.h.

Real Ogre::PanelOverlayElement::getTileX ( ushort layer = 0 ) const [inherited]

Real Ogre::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)

Real Ogre::OverlayElement::getTop ( void ) const [inherited]

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

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

Gets the size of the top border.

String Ogre::BorderPanelOverlayElement::getTopBorderUVString ( ) const

String Ogre::BorderPanelOverlayElement::getTopLeftBorderUVString ( ) const

String Ogre::BorderPanelOverlayElement::getTopRightBorderUVString ( ) const

const String& Ogre::BorderPanelOverlayElement::getTypeName ( void ) const [virtual]

See OverlayElement.

Reimplemented from Ogre::PanelOverlayElement.

bool Ogre::Renderable::getUseIdentityProjection ( void ) const [inherited]

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

Definition at line 178 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityView ( void ) const [inherited]

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

Definition at line 203 of file OgreRenderable.h.

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny ( void ) const [virtual, inherited]

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

Retrieves the custom user value associated with this object.

Definition at line 349 of file OgreRenderable.h.

UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( ) [inherited]

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.

Definition at line 355 of file OgreRenderable.h.

const UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( ) const [inherited]

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.

Definition at line 361 of file OgreRenderable.h.

void Ogre::PanelOverlayElement::getUV	(	Real &	u1,
		Real &	v1,
		Real &	u2,
		Real &	v2
	)		const `[inherited]`

Get the uv coordinates for the panel.

virtual GuiVerticalAlignment Ogre::OverlayElement::getVerticalAlignment ( void ) const [virtual, inherited]

Gets the vertical alignment for this element.

Real Ogre::OverlayElement::getWidth ( void ) const [inherited]

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

void Ogre::OverlayElement::getWorldTransforms ( Matrix4 * xform ) const [virtual, inherited]

See Renderable.

Implements Ogre::Renderable.

ushort Ogre::OverlayElement::getZOrder ( ) const [inherited]

Returns the zOrder of the element.

Definition at line 465 of file OgreOverlayElement.h.

bool Ogre::Renderable::hasCustomParameter ( size_t index ) const [inherited]

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.

Definition at line 259 of file OgreRenderable.h.

virtual void Ogre::OverlayElement::hide ( void ) [virtual, inherited]

Hides this element if it was visible.

virtual void Ogre::BorderPanelOverlayElement::initialise ( void ) [virtual]

Initialise.

Reimplemented from Ogre::PanelOverlayElement.

virtual bool Ogre::OverlayContainer::isChildrenProcessEvents ( ) const [virtual, inherited]

Should this container pass events to their children.

Definition at line 129 of file OgreOverlayContainer.h.

virtual bool Ogre::OverlayElement::isCloneable ( ) const [virtual, inherited]

Definition at line 450 of file OgreOverlayElement.h.

bool Ogre::OverlayContainer::isContainer ( ) const [virtual, inherited]

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

Definition at line 125 of file OgreOverlayContainer.h.

bool Ogre::OverlayElement::isEnabled ( ) const [inherited]

virtual bool Ogre::OverlayElement::isKeyEnabled ( ) const [virtual, inherited]

Definition at line 447 of file OgreOverlayElement.h.

bool Ogre::PanelOverlayElement::isTransparent ( void ) const [inherited]

Returns whether this panel is transparent.

bool Ogre::OverlayElement::isVisible ( void ) const [inherited]

Returns whether or not the element is visible.

template<class Alloc >

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Renderable::postRender	(	SceneManager *	sm,
		RenderSystem *	rsys
	)		`[virtual, inherited]`

Called immediately after the Renderable has been rendered.

Definition at line 128 of file OgreRenderable.h.

virtual bool Ogre::Renderable::preRender	(	SceneManager *	sm,
		RenderSystem *	rsys
	)		`[virtual, inherited]`

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

Definition at line 123 of file OgreRenderable.h.

virtual void Ogre::OverlayContainer::removeChild ( const String & name ) [virtual, inherited]

Removes a named element from this container.

void Ogre::Renderable::removeCustomParameter ( size_t index ) [inherited]

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.

Definition at line 250 of file OgreRenderable.h.

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

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

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

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

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

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

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

Remarks:: See setLeftBorderUV.

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

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

virtual void Ogre::OverlayElement::setCaption ( const DisplayString & text ) [virtual, inherited]

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

virtual void Ogre::OverlayContainer::setChildrenProcessEvents ( bool val ) [virtual, inherited]

Should this container pass events to their children.

Definition at line 133 of file OgreOverlayContainer.h.

virtual void Ogre::OverlayElement::setCloneable ( bool c ) [virtual, inherited]

Definition at line 453 of file OgreOverlayElement.h.

virtual void Ogre::OverlayElement::setColour ( const ColourValue & col ) [virtual, inherited]

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

void Ogre::Renderable::setCustomParameter	(	size_t	index,
		const Vector4 &	value
	)		`[inherited]`

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.

Definition at line 241 of file OgreRenderable.h.

void Ogre::OverlayElement::setDimensions	(	Real	width,
		Real	height
	)		`[inherited]`

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

virtual void Ogre::OverlayElement::setEnabled ( bool b ) [virtual, inherited]

void Ogre::OverlayElement::setHeight ( Real height ) [inherited]

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

virtual void Ogre::OverlayElement::setHorizontalAlignment ( GuiHorizontalAlignment gha ) [virtual, inherited]

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.

void Ogre::OverlayElement::setLeft ( Real left ) [inherited]

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

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

void Ogre::PanelOverlayElement::setMaterialName ( const String & matName ) [virtual, inherited]

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

void Ogre::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::OverlayElement.

virtual bool Ogre::StringInterface::setParameter	(	const String &	name,
		const String &	value
	)		`[virtual, inherited]`

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

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList & paramList ) [virtual, inherited]

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

virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool override ) [virtual, inherited]

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.

Definition at line 324 of file OgreRenderable.h.

void Ogre::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)

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData * val ) const [virtual, inherited]

Sets RenderSystem private data.

Remarks:: This should only be used by a RenderSystem

Definition at line 407 of file OgreRenderable.h.

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

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

Remarks:: See setLeftBorderUV.

void Ogre::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)

void Ogre::OverlayElement::setTop ( Real Top ) [inherited]

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

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

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

Remarks:: See setLeftBorderUV.

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

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

void Ogre::PanelOverlayElement::setTransparent ( bool isTransparent ) [inherited]

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

void Ogre::Renderable::setUseIdentityProjection ( bool useIdentityProjection ) [inherited]

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

Definition at line 164 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityView ( bool useIdentityView ) [inherited]

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

Definition at line 189 of file OgreRenderable.h.

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any & anything ) [virtual, inherited]

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.

Definition at line 344 of file OgreRenderable.h.

void Ogre::PanelOverlayElement::setUV	(	Real	u1,
		Real	v1,
		Real	u2,
		Real	v2
	)		`[inherited]`

Sets the texture coordinates for the panel.

virtual void Ogre::OverlayElement::setVerticalAlignment ( GuiVerticalAlignment gva ) [virtual, inherited]

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.

void Ogre::OverlayElement::setWidth ( Real width ) [inherited]

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

virtual void Ogre::OverlayElement::show ( void ) [virtual, inherited]

Shows this element if it was hidden.

void Ogre::BorderPanelOverlayElement::updatePositionGeometry ( void ) [protected, virtual]

internal method for setting up geometry, called by OverlayElement::update

Reimplemented from Ogre::PanelOverlayElement.

void Ogre::BorderPanelOverlayElement::updateTextureGeometry ( void ) [protected, virtual]

internal method for setting up geometry, called by OverlayElement::update

Reimplemented from Ogre::PanelOverlayElement.

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

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

Parameters:

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

Reimplemented from Ogre::OverlayElement.