OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::BorderPanelOverlayElement Class Reference

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

#include <OgreBorderPanelOverlayElement.h>

+ Inheritance diagram for Ogre::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 Member Functions

 BorderPanelOverlayElement (const String &name)
 Constructor. More...
 
virtual ~BorderPanelOverlayElement ()
 
virtual void _releaseManualHardwareResources ()
 Notifies that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies that hardware resources should be restored. More...
 
void _update (void)
 Internal method to update the element based on transforms applied. More...
 
void _updateRenderQueue (RenderQueue *queue)
 Overridden from OverlayElement. More...
 
const StringgetBorderMaterialName (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
 
Real getLeftBorderSize (void) const
 Gets the size of the left border. More...
 
String getLeftBorderUVString () const
 
Real getRightBorderSize (void) const
 Gets the size of the right border. More...
 
String getRightBorderUVString () const
 
Real getTopBorderSize (void) const
 Gets the size of the top border. More...
 
String getTopBorderUVString () const
 
String getTopLeftBorderUVString () const
 
String getTopRightBorderUVString () const
 
const StringgetTypeName (void) const
 See OverlayElement. More...
 
virtual void initialise (void)
 Initialise. More...
 
void setBorderMaterialName (const String &name, const String &group=DEFAULT_RESOURCE_GROUP)
 Sets the name of the material to use for the borders. More...
 
void setBorderSize (Real left, Real right, Real top, Real bottom)
 Sets the size of the border separately for all borders. 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 size)
 Sets the size of the border. 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...
 
void setLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
 Sets the texture coordinates for the left edge of the border. More...
 
void setMetricsMode (GuiMetricsMode gmm)
 Tells this element how to interpret the position and dimension values it is given. More...
 
void setRightBorderUV (Real u1, Real v1, Real u2, Real v2)
 Sets the texture coordinates for the right edge of the border. 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 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. More...
 
- Public Member Functions inherited from Ogre::PanelOverlayElement
 PanelOverlayElement (const String &name)
 Constructor. More...
 
virtual ~PanelOverlayElement ()
 
void _updateRenderQueue (RenderQueue *queue)
 Overridden from OverlayContainer. More...
 
void getRenderOperation (RenderOperation &op)
 See Renderable. More...
 
Real getTileX (ushort layer=0) const
 
Real getTileY (ushort layer=0) const
 Gets the number of times the texture should repeat vertically. More...
 
void getUV (Real &u1, Real &v1, Real &u2, Real &v2) const
 Get the uv coordinates for the panel. More...
 
bool isTransparent (void) const
 Returns whether this panel is transparent. More...
 
void setTiling (Real x, Real y, ushort layer=0)
 Sets the number of times textures should repeat. 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 setUV (Real u1, Real v1, Real u2, Real v2)
 Sets the texture coordinates for the panel. More...
 
- Public Member Functions inherited from Ogre::OverlayContainer
 OverlayContainer (const String &name)
 Constructor: do not call direct, use OverlayManager::createOverlayElement. More...
 
virtual ~OverlayContainer ()
 
void _addChild (OverlayElement *elem)
 
virtual void _notifyParent (OverlayContainer *parent, Overlay *overlay)
 Overridden from OverlayElement. More...
 
virtual void _notifyViewport ()
 Overridden from OverlayElement. More...
 
virtual void _notifyWorldTransforms (const Matrix4 &xform)
 Overridden from OverlayElement. More...
 
virtual ushort _notifyZOrder (ushort newZOrder)
 Overridden from OverlayElement. More...
 
virtual void _positionsOutOfDate (void)
 Tell the object and its children to recalculate. More...
 
void _removeChild (const String &name)
 
void _removeChild (OverlayElement *elem)
 
virtual void addChild (OverlayElement *elem)
 Adds another OverlayElement to this container. More...
 
virtual void addChildImpl (OverlayContainer *cont)
 Add a nested container to this container. More...
 
virtual void addChildImpl (OverlayElement *elem)
 Adds another OverlayElement to this container. More...
 
virtual OverlayElementclone (const String &instanceName)
 
void copyFromTemplate (OverlayElement *templateOverlay)
 
virtual OverlayElementfindElementAt (Real x, Real y)
 This returns a OverlayElement at position x,y. More...
 
virtual OverlayElementgetChild (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)
 
const ChildMapgetChildren () const
 Gets all the children of this object. More...
 
virtual bool isChildrenProcessEvents () const
 Should this container pass events to their children. More...
 
bool isContainer () const
 Overridden from OverlayElement. More...
 
virtual void removeChild (const String &name)
 Removes a named element from this container. More...
 
virtual void setChildrenProcessEvents (bool val)
 Should this container pass events to their children. More...
 
- Public Member Functions inherited from Ogre::OverlayElement
 OverlayElement (const String &name)
 Constructor: do not call direct, use OverlayManager::createElement. More...
 
virtual ~OverlayElement ()
 
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...
 
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...
 
void _setLeft (Real left)
 Sets the left of this element in relation to the screen (where 1.0 = screen width) 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...
 
virtual void _updateFromParent (void)
 Updates this elements transform based on it's parent. More...
 
virtual bool contains (Real x, Real y) const
 Returns true if xy is within the constraints of the component. More...
 
virtual const DisplayStringgetCaption (void) const
 Gets the caption for this element. More...
 
virtual const ColourValuegetColour (void) const
 Gets the colour for this element. More...
 
Real getHeight (void) const
 Gets the height of this element in relation to the screen (where 1.0 = screen height) More...
 
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...
 
const LightListgetLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
const MaterialPtrgetMaterial (void) const
 See Renderable. More...
 
virtual const StringgetMaterialName (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 StringgetName (void) const
 Gets the name of this overlay. More...
 
OverlayContainergetParent ()
 Returns the parent container. More...
 
const OverlayElementgetSourceTemplate () const
 Returns the SourceTemplate for this element. More...
 
Real getSquaredViewDepth (const Camera *cam) const
 Overridden from Renderable. More...
 
Real getTop (void) const
 Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
More...
 
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...
 
ushort getZOrder () const
 Returns the zOrder of the element. More...
 
virtual void hide (void)
 Hides this element if it was visible. More...
 
virtual bool isCloneable () const
 
bool isEnabled () const
 
virtual bool isKeyEnabled () const
 
bool isVisible (void) const
 Returns whether or not the element is visible. More...
 
virtual void setCaption (const DisplayString &text)
 Sets the caption on elements that support it. More...
 
virtual void setCloneable (bool c)
 
virtual void setColour (const ColourValue &col)
 Sets the colour on elements that support it. 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 setMaterial (const MaterialPtr &mat)
 Sets the the material this element will use. More...
 
void setMaterialName (const String &matName, const String &group=DEFAULT_RESOURCE_GROUP)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
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 setTop (Real Top)
 Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) 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...
 
void 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. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
- Public Member Functions inherited from Ogre::Renderable
 Renderable ()
 
virtual ~Renderable ()
 Virtual destructor needed as class has virtual methods. 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 bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
const RenderSystemDataPtrgetRenderSystemData () const
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. 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...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. More...
 
void 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 setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
void setRenderSystemData (RenderSystemDataPtr val) const
 
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...
 
void setUserAny (const Any &anything)
 

Additional Inherited Members

- Public Types inherited from Ogre::OverlayContainer
typedef MapIterator< ChildContainerMapChildContainerIterator
 
typedef std::map< String, OverlayContainer * > ChildContainerMap
 
typedef MapIterator< ChildMapChildIterator
 
typedef std::map< String, OverlayElement * > ChildMap
 
- Public Types inherited from Ogre::Renderable
enum  { DEFAULT_PRIORITY = 100 }
 
typedef SharedPtr< RenderSystemDataRenderSystemDataPtr
 
- Static Public Member Functions inherited from Ogre::StringInterface
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...
 
- Static Public Attributes inherited from Ogre::OverlayElement
static const StringDEFAULT_RESOURCE_GROUP
 

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.

Constructor & Destructor Documentation

◆ BorderPanelOverlayElement()

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

Constructor.

◆ ~BorderPanelOverlayElement()

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

Member Function Documentation

◆ initialise()

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

Initialise.

Reimplemented from Ogre::PanelOverlayElement.

◆ _releaseManualHardwareResources()

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

Notifies that hardware resources were lost.

Reimplemented from Ogre::PanelOverlayElement.

◆ _restoreManualHardwareResources()

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

Notifies that hardware resources should be restored.

Reimplemented from Ogre::PanelOverlayElement.

◆ getTypeName()

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

See OverlayElement.

Reimplemented from Ogre::PanelOverlayElement.

◆ setBorderSize() [1/3]

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
sizeThe 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::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
sidesThe size of the side borders as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.
topAndBottomThe size of the top and bottom borders as a factor of the screen dimensions.

◆ setBorderSize() [3/3]

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
leftThe size of the left border as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.
rightThe size of the left border as a factor of the screen dimensions.
topThe size of the top border as a factor of the screen dimensions.
bottomThe size of the bottom border as a factor of the screen dimensions.

◆ getLeftBorderSize()

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

Gets the size of the left border.

◆ getRightBorderSize()

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

Gets the size of the right border.

◆ getTopBorderSize()

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

Gets the size of the top border.

◆ getBottomBorderSize()

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

Gets the size of the bottom border.

◆ setLeftBorderUV()

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.

◆ setRightBorderUV()

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.

◆ setTopBorderUV()

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.

◆ setBottomBorderUV()

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.

◆ setTopLeftBorderUV()

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.

◆ setTopRightBorderUV()

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.

◆ setBottomLeftBorderUV()

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.

◆ setBottomRightBorderUV()

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.

◆ getLeftBorderUVString()

String Ogre::BorderPanelOverlayElement::getLeftBorderUVString ( ) const

◆ getRightBorderUVString()

String Ogre::BorderPanelOverlayElement::getRightBorderUVString ( ) const

◆ getTopBorderUVString()

String Ogre::BorderPanelOverlayElement::getTopBorderUVString ( ) const

◆ getBottomBorderUVString()

String Ogre::BorderPanelOverlayElement::getBottomBorderUVString ( ) const

◆ getTopLeftBorderUVString()

String Ogre::BorderPanelOverlayElement::getTopLeftBorderUVString ( ) const

◆ getTopRightBorderUVString()

String Ogre::BorderPanelOverlayElement::getTopRightBorderUVString ( ) const

◆ getBottomLeftBorderUVString()

String Ogre::BorderPanelOverlayElement::getBottomLeftBorderUVString ( ) const

◆ getBottomRightBorderUVString()

String Ogre::BorderPanelOverlayElement::getBottomRightBorderUVString ( ) const

◆ setBorderMaterialName()

void Ogre::BorderPanelOverlayElement::setBorderMaterialName ( const String name,
const String group = DEFAULT_RESOURCE_GROUP 
)

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

◆ getBorderMaterialName()

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

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

◆ _updateRenderQueue()

void Ogre::BorderPanelOverlayElement::_updateRenderQueue ( RenderQueue queue)
virtual

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayContainer.

◆ visitRenderables()

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
visitorPointer 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.
debugRenderablesIf false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

◆ setMetricsMode()

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.

◆ _update()

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

Internal method to update the element based on transforms applied.

Reimplemented from Ogre::OverlayContainer.


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