OgreOverlayContainer.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef __OverlayContainer_H__
#define __OverlayContainer_H__

#include "OgrePrerequisites.h"
#include "OgreOverlayElement.h"
#include "OgreIteratorWrappers.h"


namespace Ogre {


    class _OgreExport OverlayContainer : public OverlayElement
    {
    public:
        typedef map<String, OverlayElement*>::type ChildMap;
        typedef MapIterator<ChildMap> ChildIterator;
        typedef map<String, OverlayContainer*>::type ChildContainerMap;
        typedef MapIterator<ChildContainerMap> ChildContainerIterator;
    protected:
        // Map of all children
        ChildMap mChildren;
        // Map of container children (subset of mChildren)
        ChildContainerMap mChildContainers;

        bool mChildrenProcessEvents;
 
    public:
        OverlayContainer(const String& name);
        virtual ~OverlayContainer();

        virtual void addChild(OverlayElement* elem);
        virtual void addChildImpl(OverlayElement* elem);
        virtual void addChildImpl(OverlayContainer* cont);
        virtual void removeChild(const String& name);
        virtual OverlayElement* getChild(const String& name);

        void initialise(void);

        void _addChild(OverlayElement* elem);
        void _removeChild(OverlayElement* elem) { _removeChild(elem->getName()); }
        void _removeChild(const String& name);

        virtual ChildIterator getChildIterator(void);

        virtual ChildContainerIterator getChildContainerIterator(void);

        virtual void _positionsOutOfDate(void);

        virtual void _update(void);

        virtual ushort _notifyZOrder(ushort newZOrder);

        virtual void _notifyViewport();

        virtual void _notifyWorldTransforms(const Matrix4& xform);

        virtual void _notifyParent(OverlayContainer* parent, Overlay* overlay);

        virtual void _updateRenderQueue(RenderQueue* queue);

        inline bool isContainer() const
        { return true; }

        virtual inline bool isChildrenProcessEvents() const
        { return true; }

        virtual inline void setChildrenProcessEvents(bool val)
        { mChildrenProcessEvents = val; }

        virtual OverlayElement* findElementAt(Real x, Real y);      // relative to parent

        void copyFromTemplate(OverlayElement* templateOverlay);
        virtual OverlayElement* clone(const String& instanceName);

    };


}


#endif