OgreOverlayManager.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 __OverlayManager_H__
#define __OverlayManager_H__

#include "OgrePrerequisites.h"
#include "OgreSingleton.h"
#include "OgreStringVector.h"
#include "OgreOverlay.h"
#include "OgreScriptLoader.h"
#include "OgreFrustum.h"

namespace Ogre {

    class _OgreExport OverlayManager : public Singleton<OverlayManager>, public ScriptLoader, public OverlayAlloc
    {
    public:
        typedef map<String, Overlay*>::type OverlayMap;
        typedef map<String, OverlayElement*>::type ElementMap;
        typedef map<String, OverlayElementFactory*>::type FactoryMap;
    protected:
        OverlayMap mOverlayMap;
        StringVector mScriptPatterns;

        void parseNewElement( DataStreamPtr& chunk, String& elemType, String& elemName, 
            bool isContainer, Overlay* pOverlay, bool isTemplate, String templateName = String(""), OverlayContainer* container = 0);
        void parseAttrib( const String& line, Overlay* pOverlay);
        void parseElementAttrib( const String& line, Overlay* pOverlay, OverlayElement* pElement );
        void skipToNextCloseBrace(DataStreamPtr& chunk);
        void skipToNextOpenBrace(DataStreamPtr& chunk);
        
        int mLastViewportWidth, mLastViewportHeight;
        bool mViewportDimensionsChanged;
        OrientationMode mLastViewportOrientationMode;

        bool parseChildren( DataStreamPtr& chunk, const String& line,
            Overlay* pOverlay, bool isTemplate, OverlayContainer* parent = NULL);

        FactoryMap mFactories;

        ElementMap mInstances;
        ElementMap mTemplates;

        typedef set<String>::type LoadedScripts;
        LoadedScripts mLoadedScripts;




        ElementMap& getElementMap(bool isTemplate);

        OverlayElement* createOverlayElementImpl(const String& typeName, const String& instanceName, ElementMap& elementMap);

        OverlayElement* getOverlayElementImpl(const String& name, ElementMap& elementMap);
        
        bool hasOverlayElementImpl(const String& name, ElementMap& elementMap);

        void destroyOverlayElementImpl(const String& instanceName, ElementMap& elementMap);

        void destroyOverlayElementImpl(OverlayElement* pInstance, ElementMap& elementMap);

        void destroyAllOverlayElementsImpl(ElementMap& elementMap);

    public:
        OverlayManager();
        virtual ~OverlayManager();

        const StringVector& getScriptPatterns(void) const;
        void parseScript(DataStreamPtr& stream, const String& groupName);
        Real getLoadingOrder(void) const;

        Overlay* create(const String& name);
        Overlay* getByName(const String& name);
        void destroy(const String& name);
        void destroy(Overlay* overlay);
        void destroyAll(void);
        typedef MapIterator<OverlayMap> OverlayMapIterator;
        OverlayMapIterator getOverlayIterator(void);

        void _queueOverlaysForRendering(Camera* cam, RenderQueue* pQueue, Viewport *vp);

        bool hasViewportChanged(void) const;

        int getViewportHeight(void) const;
        
        int getViewportWidth(void) const;
        Real getViewportAspectRatio(void) const;

        OrientationMode getViewportOrientationMode(void) const;

        OverlayElement* createOverlayElement(const String& typeName, const String& instanceName, bool isTemplate = false);

        OverlayElement* getOverlayElement(const String& name, bool isTemplate = false);

        bool hasOverlayElement(const String& name, bool isTemplate = false);
        
        void destroyOverlayElement(const String& instanceName, bool isTemplate = false);

        void destroyOverlayElement(OverlayElement* pInstance, bool isTemplate = false);

        void destroyAllOverlayElements(bool isTemplate = false);

        void addOverlayElementFactory(OverlayElementFactory* elemFactory);
        
        const FactoryMap& getOverlayElementFactoryMap() const {
            return mFactories;
        }

        OverlayElement* createOverlayElementFromTemplate(const String& templateName, const String& typeName, const String& instanceName, bool isTemplate = false);
        OverlayElement* cloneOverlayElementFromTemplate(const String& templateName, const String& instanceName);

        OverlayElement* createOverlayElementFromFactory(const String& typeName, const String& instanceName);

        typedef MapIterator<ElementMap> TemplateIterator;
        TemplateIterator getTemplateIterator ()
        {
            return TemplateIterator (mTemplates.begin (), mTemplates.end ()) ;
        }
        /* Returns whether the Element with the given name is a Template */
        bool isTemplate (String strName) const {
            return (mTemplates.find (strName) != mTemplates.end()) ;
        }


        static OverlayManager& getSingleton(void);
        static OverlayManager* getSingletonPtr(void);
    };


}


#endif