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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/

#ifndef __Overlay_H__
#define __Overlay_H__

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

namespace Ogre {


    class _OgreExport Overlay 
    {

    public:
              typedef std::list<OverlayContainer*> 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);

    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);
#ifndef OGRE_FORCE_ANGLE_TYPES
        inline void setRotate(Real degrees) {
            setRotate ( Angle(degrees) );
        }
#endif//OGRE_FORCE_ANGLE_TYPES

        Radian getRotate(void) const { return mRotate; }

        void rotate(const Radian& angle);
#ifndef OGRE_FORCE_ANGLE_TYPES
        inline void rotate(Real degrees) {
            rotate ( Angle(degrees) );
        }
#endif//OGRE_FORCE_ANGLE_TYPES

        void setScale(Real x, Real y);

        Real getScaleX(void) const;

        Real getScaleY(void) const;

        void _getWorldTransforms(Matrix4* xform) const;
        const Quaternion& getWorldOrientation(void) const;
        const Vector3& getWorldPosition(void) 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

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:48 2006