OGRE  1.9.0
OgreOverlayContainer.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28
29#ifndef __OverlayContainer_H__
30#define __OverlayContainer_H__
31
33#include "OgreOverlayElement.h"
35
36
37namespace Ogre {
38
39
57 {
58 public:
63 protected:
68
70
71 public:
75
77 virtual void addChild(OverlayElement* elem);
79 virtual void addChildImpl(OverlayElement* elem);
81 virtual void addChildImpl(OverlayContainer* cont);
83 virtual void removeChild(const String& name);
85 virtual OverlayElement* getChild(const String& name);
86
88 void initialise(void);
89
92 void _removeChild(const String& name);
93
96
102
104 virtual void _positionsOutOfDate(void);
105
107 virtual void _update(void);
108
110 virtual ushort _notifyZOrder(ushort newZOrder);
111
113 virtual void _notifyViewport();
114
116 virtual void _notifyWorldTransforms(const Matrix4& xform);
117
119 virtual void _notifyParent(OverlayContainer* parent, Overlay* overlay);
120
122 virtual void _updateRenderQueue(RenderQueue* queue);
123
125 inline bool isContainer() const
126 { return true; }
127
129 virtual inline bool isChildrenProcessEvents() const
130 { return true; }
131
133 virtual inline void setChildrenProcessEvents(bool val)
134 { mChildrenProcessEvents = val; }
135
137 virtual OverlayElement* findElementAt(Real x, Real y); // relative to parent
138
139 void copyFromTemplate(OverlayElement* templateOverlay);
140 virtual OverlayElement* clone(const String& instanceName);
141
142 };
143
144
147
148}
149
150
151#endif
152
#define _OgreOverlayExport
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
Class encapsulating a standard 4x4 homogeneous matrix.
Definition OgreMatrix4.h:79
MapIterator< ChildContainerMap > ChildContainerIterator
OverlayContainer(const String &name)
Constructor: do not call direct, use OverlayManager::createOverlayElement.
void _addChild(OverlayElement *elem)
map< String, OverlayElement * >::type ChildMap
void _removeChild(OverlayElement *elem)
bool isContainer() const
Overridden from OverlayElement.
void copyFromTemplate(OverlayElement *templateOverlay)
virtual void _notifyParent(OverlayContainer *parent, Overlay *overlay)
Overridden from OverlayElement.
virtual void _notifyWorldTransforms(const Matrix4 &xform)
Overridden from OverlayElement.
virtual void _updateRenderQueue(RenderQueue *queue)
Overridden from OverlayElement.
virtual void _notifyViewport()
Overridden from OverlayElement.
ChildContainerMap mChildContainers
Map of container children (subset of mChildren)
virtual bool isChildrenProcessEvents() const
Should this container pass events to their children.
void _removeChild(const String &name)
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 void _update(void)
Overridden from OverlayElement.
ChildMap mChildren
Map of all children.
void initialise(void)
Initialise gui element.
virtual ushort _notifyZOrder(ushort newZOrder)
Overridden from OverlayElement.
virtual void addChild(OverlayElement *elem)
Adds another OverlayElement to this container.
MapIterator< ChildMap > ChildIterator
virtual void removeChild(const String &name)
Removes a named element from this container.
virtual void _positionsOutOfDate(void)
Tell the object and its children to recalculate.
virtual void addChildImpl(OverlayElement *elem)
Adds another OverlayElement to this container.
virtual void setChildrenProcessEvents(bool val)
Should this container pass events to their children.
virtual void addChildImpl(OverlayContainer *cont)
Add a nested container to this container.
virtual OverlayElement * clone(const String &instanceName)
map< String, OverlayContainer * >::type ChildContainerMap
virtual ChildIterator getChildIterator(void)
Gets an object for iterating over all the children of this object.
virtual OverlayElement * findElementAt(Real x, Real y)
This returns a OverlayElement at position x,y.
OverlayElement(const String &name)
Constructor: do not call direct, use OverlayManager::createElement.
const String & getName(void) const
Gets the name of this overlay.
Represents a layer which is rendered on top of the 'normal' scene contents.
Definition OgreOverlay.h:71
Class to manage the scene object rendering queue.
float Real
Software floating point type.
_StringBase String
unsigned short ushort
std::map< K, V, P, A > type