OgreOverlay.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 __Overlay_H__
#define __Overlay_H__

#include "OgrePrerequisites.h"
#include "OgreSceneNode.h"
#include "OgreIteratorWrappers.h"
#include "OgreMatrix4.h"

namespace Ogre {


    class _OgreExport Overlay : public OverlayAlloc
    {

    public:
              typedef list<OverlayContainer*>::type OverlayContainerList;
    protected:
        String mName;
        SceneNode* mRootNode;
        // 2D elements
        // OverlayContainers, linked list for easy sorting by zorder later
        // Not a map because sort can be saved since changes infrequent (unlike render queue)
        OverlayContainerList m2DElements;

        // Degrees of rotation around center
        Radian mRotate;
        // Scroll values, offsets
        Real mScrollX, mScrollY;
        // Scale values
        Real mScaleX, mScaleY;

        mutable Matrix4 mTransform;
        mutable bool mTransformOutOfDate;
        bool mTransformUpdated;
        ulong mZOrder;
        bool mVisible;
        bool mInitialised;
        String mOrigin;
        void updateTransform(void) const;
        void initialise(void);
        void assignZOrders(void);

    public:
        Overlay(const String& name);
        virtual ~Overlay();


        OverlayContainer* getChild(const String& name);

        const String& getName(void) const;
        void setZOrder(ushort zorder);
        ushort getZOrder(void) const;

        bool isVisible(void) const;

        bool isInitialised(void) const { return mInitialised; }

        void show(void);

        void hide(void);

        void add2D(OverlayContainer* cont);


        void remove2D(OverlayContainer* cont);

        void add3D(SceneNode* node);

        void remove3D(SceneNode* node);

        void clear();

        void setScroll(Real x, Real y);

        Real getScrollX(void) const;

        Real getScrollY(void) const;

        void scroll(Real xoff, Real yoff);

        void setRotate(const Radian& angle);

        const Radian &getRotate(void) const { return mRotate; }

        void rotate(const Radian& angle);

        void setScale(Real x, Real y);

        Real getScaleX(void) const;

        Real getScaleY(void) const;

        void _getWorldTransforms(Matrix4* xform) const;

        void _findVisibleObjects(Camera* cam, RenderQueue* queue);

        virtual OverlayElement* findElementAt(Real x, Real y);

        typedef VectorIterator<OverlayContainerList> Overlay2DElementsIterator ;
        Overlay2DElementsIterator get2DElementsIterator ()
        {
            return Overlay2DElementsIterator (m2DElements.begin(), m2DElements.end());
        }
        const String& getOrigin(void) const { return mOrigin; }
        void _notifyOrigin(const String& origin) { mOrigin = origin; }


    };
}


#endif