OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreOverlayContainer.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 
29 #ifndef __OverlayContainer_H__
30 #define __OverlayContainer_H__
31 
33 #include "OgreOverlayElement.h"
34 #include "OgreIteratorWrappers.h"
35 
36 
37 namespace Ogre {
38 
39 
57  {
58  public:
63  protected:
68 
70 
71  public:
73  OverlayContainer(const String& name);
74  virtual ~OverlayContainer();
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 
90  void _addChild(OverlayElement* elem);
91  void _removeChild(OverlayElement* elem) { _removeChild(elem->getName()); }
92  void _removeChild(const String& name);
93 
95  virtual ChildIterator getChildIterator(void);
96 
101  virtual ChildContainerIterator getChildContainerIterator(void);
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, Camera *camera, const Camera *lodCamera);
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 
148 }
149 
150 
151 #endif
152 
virtual bool isChildrenProcessEvents() const
Should this container pass events to their children.
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:82
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:79
float Real
Software floating point type.
ChildMap mChildren
Map of all children.
#define _OgreOverlayExport
bool isContainer() const
Overridden from OverlayElement.
A 2D element which contains other OverlayElement instances.
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
const String & getName(void) const
Gets the name of this overlay.
MapIterator< ChildMap > ChildIterator
MapIterator< ChildContainerMap > ChildContainerIterator
ChildContainerMap mChildContainers
Map of container children (subset of mChildren)
unsigned short ushort
Abstract definition of a 2D element to be displayed in an Overlay.
virtual void setChildrenProcessEvents(bool val)
Should this container pass events to their children.
void _removeChild(OverlayElement *elem)
Class to manage the scene object rendering queue.
_StringBase String
Definition: OgreCommon.h:53
map< String, OverlayContainer * >::type ChildContainerMap
Represents a layer which is rendered on top of the 'normal' scene contents.
Definition: OgreOverlay.h:69
map< String, OverlayElement * >::type ChildMap