OGRE: OgreOverlayContainer.h Source File - OGRE Documentation

# OgreOverlayContainer.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028
    00029 #ifndef __OverlayContainer_H__
    00030 #define __OverlayContainer_H__
    00031
    00032 #include "OgrePrerequisites.h"
    00033 #include "OgreOverlayElement.h"
    00034 #include "OgreIteratorWrappers.h"
    00035
    00036
    00037 namespace Ogre {
    00038
    00039
    00056     class _OgreExport OverlayContainer : public OverlayElement
    00057     {
    00058     public:
    00059         typedef map<String, OverlayElement*>::type ChildMap;
    00060         typedef MapIterator<ChildMap> ChildIterator;
    00061         typedef map<String, OverlayContainer*>::type ChildContainerMap;
    00062         typedef MapIterator<ChildContainerMap> ChildContainerIterator;
    00063     protected:
    00064         // Map of all children
    00065         ChildMap mChildren;
    00066         // Map of container children (subset of mChildren)
    00067         ChildContainerMap mChildContainers;
    00068
    00069         bool mChildrenProcessEvents;
    00070
    00071     public:
    00073         OverlayContainer(const String& name);
    00074         virtual ~OverlayContainer();
    00075
    00077         virtual void addChild(OverlayElement* elem);
    00079         virtual void addChildImpl(OverlayElement* elem);
    00081         virtual void addChildImpl(OverlayContainer* cont);
    00083         virtual void removeChild(const String& name);
    00085         virtual OverlayElement* getChild(const String& name);
    00086
    00088         void initialise(void);
    00089
    00090         void _addChild(OverlayElement* elem);
    00091         void _removeChild(OverlayElement* elem) { _removeChild(elem->getName()); }
    00092         void _removeChild(const String& name);
    00093
    00095         virtual ChildIterator getChildIterator(void);
    00096
    00101         virtual ChildContainerIterator getChildContainerIterator(void);
    00102
    00104         virtual void _positionsOutOfDate(void);
    00105
    00107         virtual void _update(void);
    00108
    00110         virtual ushort _notifyZOrder(ushort newZOrder);
    00111
    00113         virtual void _notifyViewport();
    00114
    00116         virtual void _notifyWorldTransforms(const Matrix4& xform);
    00117
    00119         virtual void _notifyParent(OverlayContainer* parent, Overlay* overlay);
    00120
    00122         virtual void _updateRenderQueue(RenderQueue* queue);
    00123
    00125         inline bool isContainer() const
    00126         { return true; }
    00127
    00129         virtual inline bool isChildrenProcessEvents() const
    00130         { return true; }
    00131
    00133         virtual inline void setChildrenProcessEvents(bool val)
    00134         { mChildrenProcessEvents = val; }
    00135
    00137         virtual OverlayElement* findElementAt(Real x, Real y);      // relative to parent
    00138
    00139         void copyFromTemplate(OverlayElement* templateOverlay);
    00140         virtual OverlayElement* clone(const String& instanceName);
    00141
    00142     };
    00143
    00144
    00148 }
    00149
    00150
    00151 #endif
    00152

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52