OGRE-Next  3.0.0
Object-Oriented Graphics Rendering Engine
Ogre::v1::PanelOverlayElement Class Reference

OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements. More...

#include <OgrePanelOverlayElement.h>

+ Inheritance diagram for Ogre::v1::PanelOverlayElement:

Classes

class  CmdTiling
 Command object for specifying tiling (see ParamCommand). More...
 
class  CmdTransparent
 Command object for specifying transparency (see ParamCommand). More...
 
class  CmdUVCoords
 Command object for specifying UV coordinates (see ParamCommand). More...
 

Public Member Functions

 PanelOverlayElement (const String &name)
 Constructor. More...
 
 ~PanelOverlayElement () override
 
void _releaseManualHardwareResources () override
 
void _restoreManualHardwareResources () override
 
void _updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera) override
 Overridden from OverlayContainer. More...
 
void getRenderOperation (v1::RenderOperation &op, bool casterPass) override
 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...
 
const StringgetTypeName () const override
 See OverlayElement. More...
 
void getUV (Real &u1, Real &v1, Real &u2, Real &v2) const
 Get the uv coordinates for the panel. More...
 
void initialise () override
 Initialise. More...
 
bool isTransparent () const
 Returns whether this panel is transparent. More...
 
void setMaterialName (const String &matName) override
 Overridden from OverlayElement. 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::v1::OverlayContainer
 OverlayContainer (const String &name)
 Constructor: do not call direct, use OverlayManager::createOverlayElement. More...
 
 ~OverlayContainer () override
 
void _addChild (OverlayElement *elem)
 
void _notifyParent (OverlayContainer *parent, Overlay *overlay) override
 Overridden from OverlayElement. More...
 
void _notifyViewport () override
 Overridden from OverlayElement. More...
 
void _positionsOutOfDate () override
 Tell the object and its children to recalculate. More...
 
void _removeChild (const String &name)
 
void _removeChild (OverlayElement *elem)
 
void _update () override
 Overridden from OverlayElement. More...
 
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...
 
OverlayElementclone (const String &instanceName) override
 
void copyFromTemplate (OverlayElement *templateOverlay) override
 
OverlayElementfindElementAt (Real x, Real y) override
 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 ()
 Gets an iterator for just the container children of this object. More...
 
virtual ChildIterator getChildIterator ()
 Gets an object for iterating over all the children of this object. More...
 
virtual bool isChildrenProcessEvents () const
 Should this container pass events to their children. More...
 
bool isContainer () const override
 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::v1::OverlayElement
 OverlayElement (const String &name)
 Constructor: do not call direct, use OverlayManager::createElement. More...
 
 ~OverlayElement () override
 
virtual void _getClippingRegion (RealRect &clippingRegion)
 Gets the clipping region of the element. More...
 
virtual Real _getDerivedLeft ()
 Gets the 'left' position as derived from own left and that of parents. More...
 
virtual Real _getDerivedTop ()
 Gets the 'top' position as derived from own left and that of parents. More...
 
Real _getHeight () const
 Gets the height of this element in relation to the screen (where 1.0 = screen height)
More...
 
Real _getLeft () const
 Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
virtual Real _getRelativeHeight ()
 Gets the 'height' as derived from own height and metrics mode. More...
 
virtual Real _getRelativeWidth ()
 Gets the 'width' as derived from own width and metrics mode. More...
 
Real _getTop () const
 Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
Real _getWidth () 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 ()
 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 () const
 Gets the caption for this element. More...
 
virtual const ColourValuegetColour () const
 Gets the colour for this element. More...
 
Real getHeight () const
 Gets the height of this element in relation to the screen (where 1.0 = screen height) More...
 
virtual GuiHorizontalAlignment getHorizontalAlignment () const
 Gets the horizontal alignment for this element. More...
 
Real getLeft () const
 Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
const LightListgetLights () const override
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
const MaterialPtrgetMaterial () const
 See Renderable. More...
 
virtual const StringgetMaterialName () const
 Gets the name of the material this element uses. More...
 
virtual GuiMetricsMode getMetricsMode () const
 Retrieves the current settings of how the element metrics are interpreted. More...
 
const StringgetName () 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 getTop () const
 Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
More...
 
virtual GuiVerticalAlignment getVerticalAlignment () const
 Gets the vertical alignment for this element. More...
 
Real getWidth () const
 Gets the width of this element in relation to the screen (where 1.0 = screen width) More...
 
void getWorldTransforms (Matrix4 *xform) const override
 See Renderable. More...
 
virtual void hide ()
 Hides this element if it was visible. More...
 
virtual bool isCloneable () const
 
bool isEnabled () const
 
virtual bool isKeyEnabled () const
 
bool isVisible () 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...
 
virtual void setMetricsMode (GuiMetricsMode gmm)
 Tells this element how to interpret the position and dimension values it is given. 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 ()
 Shows this element if it was hidden. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary ()
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary () const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters () const
 Retrieves a list of parameters valid for this object. More...
 
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
- Public Member Functions inherited from Ogre::Renderable
 Renderable ()
 
virtual ~Renderable ()
 Virtual destructor needed as class has virtual methods. More...
 
virtual void _setHlmsHashes (uint32 hash, uint32 casterHash)
 Manually sets the hlms hashes. Don't call this directly. More...
 
virtual void _setNullDatablock ()
 Sets the datablock to a null pointer. More...
 
virtual void _updateCustomGpuParameter (const GpuProgramParameters_AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...
 
void addPoseWeight (size_t index, float w)
 
virtual bool getCastsShadows () const
 Method which reports whether this renderable would normally cast a shadow. More...
 
uint8 getCurrentMaterialLod () const
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
const CustomParameterMapgetCustomParameters () const
 
HlmsDatablockgetDatablock () const
 
const StringgetDatablockOrMaterialName () const
 
uint32 getHlmsCasterHash () const
 
uint32 getHlmsHash () const
 
MaterialPtr getMaterial () const
 Retrieves the material this renderable object uses. More...
 
unsigned short getNumPoses () const
 
virtual unsigned short getNumWorldTransforms () const
 Returns the number of world transform matrices this renderable requires. More...
 
virtual bool getPolygonModeOverrideable () const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
bool getPoseHalfPrecision () const
 
bool getPoseNormals () const
 
TexBufferPackedgetPoseTexBuffer () const
 
float getPoseWeight (size_t index) const
 
float * getPoseWeights () const
 
uint8 getRenderQueueSubGroup () const
 
bool getUseIdentityProjection () const
 Returns whether or not to use an 'identity' projection. More...
 
bool getUseIdentityView () const
 Returns whether or not to use an 'identity' view. More...
 
virtual bool getUseIdentityViewProjMatrixIsDynamic () const
 Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization) More...
 
virtual bool getUseIdentityWorldMatrix () const
 Returns whether the world matrix is an identity matrix. More...
 
virtual OGRE_DEPRECATED const AnygetUserAny () 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...
 
const VertexArrayObjectArraygetVaos (VertexPass vertexPass) const
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
bool hasSkeletonAnimation () const
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. More...
 
void setCustomParameter (size_t index, const Vector4 &value)
 Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...
 
virtual void setDatablock (HlmsDatablock *datablock)
 Assigns a datablock (i.e. HLMS Material) to this renderable. More...
 
void setDatablock (IdString datablockName)
 Assigns a datablock (i.e. More...
 
void setDatablockOrMaterialName (String materialName, String groupName)
 First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials. More...
 
virtual void setMaterial (const MaterialPtr &material)
 Sets the given material. Overrides HLMS materials. More...
 
void setMaterialName (const String &name, const String &groupName)
 Sets the name of the Material to be used. Prefer using HLMS. More...
 
virtual void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
void setPoseWeight (size_t index, float w)
 
void setRenderQueueSubGroup (uint8 subGroup)
 Sets the render queue sub group. More...
 
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection. More...
 
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view. More...
 
virtual OGRE_DEPRECATED void setUserAny (const Any &anything)
 

Additional Inherited Members

- Public Types inherited from Ogre::v1::OverlayContainer
typedef MapIterator< ChildContainerMapChildContainerIterator
 
typedef map< String, OverlayContainer * >::type ChildContainerMap
 
typedef MapIterator< ChildMapChildIterator
 
typedef map< String, OverlayElement * >::type ChildMap
 
- Public Types inherited from Ogre::Renderable
typedef map< size_t, Vector4 >::type CustomParameterMap
 
- 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 Member Functions inherited from Ogre::Renderable
static uint8 getDefaultRenderQueueSubGroup ()
 
static void setDefaultRenderQueueSubGroup (uint8 subGroup)
 Sets the default render queue sub group for all future Renderable instances. More...
 
- Public Attributes inherited from Ogre::Renderable
uint8 mCustomParameter
 
uint32 mHlmsGlobalIndex
 Index in the vector holding this Rendrable reference in the HLMS datablock. More...
 
bool mRenderableVisible
 Control visibility at Renderable (e.g. More...
 

Detailed Description

OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements.

Remarks
This class subclasses OverlayContainer because it can contain other elements. Like other containers, if hidden it's contents are also hidden, if moved it's contents also move etc. The panel itself is a 2D rectangle which is either completely transparent, or is rendered with a single material. The texture(s) on the panel can be tiled depending on your requirements.
This component is suitable for backgrounds and grouping other elements. Note that because it has a single repeating material it cannot have a discrete border (unless the texture has one and the texture is tiled only once). For a bordered panel, see it's subclass BorderPanelOverlayElement.
Note that the material can have all the usual effects applied to it like multiple texture layers, scrolling / animated textures etc. For multiple texture layers, you have to set the tiling level for each layer.

Constructor & Destructor Documentation

◆ PanelOverlayElement()

Ogre::v1::PanelOverlayElement::PanelOverlayElement ( const String name)

Constructor.

◆ ~PanelOverlayElement()

Ogre::v1::PanelOverlayElement::~PanelOverlayElement ( )
override

Member Function Documentation

◆ _releaseManualHardwareResources()

void Ogre::v1::PanelOverlayElement::_releaseManualHardwareResources ( )
overridevirtual

Reimplemented from Ogre::v1::OverlayElement.

◆ _restoreManualHardwareResources()

void Ogre::v1::PanelOverlayElement::_restoreManualHardwareResources ( )
overridevirtual

Reimplemented from Ogre::v1::OverlayElement.

◆ _updateRenderQueue()

void Ogre::v1::PanelOverlayElement::_updateRenderQueue ( RenderQueue queue,
Camera camera,
const Camera lodCamera 
)
overridevirtual

Overridden from OverlayContainer.

Reimplemented from Ogre::v1::OverlayContainer.

◆ getRenderOperation()

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

See Renderable.

Implements Ogre::Renderable.

◆ getTileX()

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

◆ getTileY()

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

Gets the number of times the texture should repeat vertically.

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

◆ getTypeName()

const String& Ogre::v1::PanelOverlayElement::getTypeName ( ) const
overridevirtual

◆ getUV()

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

Get the uv coordinates for the panel.

◆ initialise()

void Ogre::v1::PanelOverlayElement::initialise ( )
overridevirtual

Initialise.

Reimplemented from Ogre::v1::OverlayContainer.

◆ isTransparent()

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

Returns whether this panel is transparent.

◆ setMaterialName()

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

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ setTiling()

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

Sets the number of times textures should repeat.

Parameters
xThe number of times the texture should repeat horizontally
yThe number of times the texture should repeat vertically
layerThe texture layer to specify (only needs to be altered if you're using a multi-texture layer material)

◆ setTransparent()

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

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

◆ setUV()

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

Sets the texture coordinates for the panel.


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