Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/overlays/OverlayGroup.h @ 2472

Last change on this file since 2472 was 2087, checked in by landauf, 16 years ago

merged objecthierarchy branch back to trunk

  • Property svn:eol-style set to native
File size: 3.2 KB
RevLine 
[1505]1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
[1502]4 *
[1505]5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
[1502]22 *   Author:
[1604]23 *      Reto Grieder
[1502]24 *   Co-authors:
[1604]25 *      ...
[1502]26 *
27 */
[1362]28
[1623]29/**
30@file
31@brief Declaration of the OverlayGroup class.
32*/
33
[1601]34#ifndef _OverlayGroup_H__
35#define _OverlayGroup_H__
[1362]36
[1502]37#include "OrxonoxPrereqs.h"
38
[1604]39#include <map>
[1502]40#include <OgrePrerequisites.h>
[1588]41#include "core/BaseObject.h"
[1502]42#include "util/Math.h"
[1362]43
44namespace orxonox
45{
[1623]46    /**
47    @brief
48        OverlayGroup does almost exactly what it says: It groups OrxonoxOverlays together.
49        You can scroll the entire group by a certain amount. Scale however works differently
50        than expected: Each OrxonoxOverlay scales individually. That's quite useful when you
51        create your HUD with an OverlayGroup and then want to alter its size.
52    */
[1604]53    class _OrxonoxExport OverlayGroup : public BaseObject
[1362]54    {
[1615]55    public:
[2087]56        OverlayGroup(BaseObject* creator);
[1623]57        //! Empty destructor.
[2087]58        ~OverlayGroup();
[1567]59
[1747]60        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
[1588]61
[1604]62        static void toggleVisibility(const std::string& name);
[1614]63        static void scaleGroup(const std::string& name, float scale);
[1615]64        static void scrollGroup(const std::string& name, const Vector2& scroll);
[1567]65
[2087]66        inline const std::map<std::string, OrxonoxOverlay*>& getOverlays() const
67            { return this->hudElements_; }
68
[1747]69        void changedVisibility();
70
[1615]71    private:
[1623]72        //! Scales each OrxonoxOverlay individually by scale.
[1615]73        void scale(const Vector2& scale) { this->setScale(scale * this->scale_); }
74        void setScale(const Vector2& scale);
[1623]75        //! Returns the current size of the group.
[1615]76        Vector2 getScale() const { return this->scale_; }
[1564]77
[1623]78        //! Scrolls each OrxonoxOverlay individually by scroll.
[1615]79        void scroll(const Vector2& scroll) { this->setScroll(scroll + this->scroll_); }
80        void setScroll(const Vector2& scroll);
[1623]81        //! Returns the current scrolling offset of the group.
[1615]82        Vector2 getScroll() const { return this->scale_; }
83
[1601]84        void addElement(OrxonoxOverlay* element);
85        OrxonoxOverlay* getElement(unsigned int index);
[1588]86
[1623]87        std::map<std::string, OrxonoxOverlay*> hudElements_;    //!< Contains all the OrxonoxOverlays of the this group.
88        Vector2 scale_;                                         //!< Current scale (independant of the elements).
89        Vector2 scroll_;                                        //!< Current scrolling offset.
[1362]90    };
91}
92
[1601]93#endif /* _OverlayGroup_H__ */
Note: See TracBrowser for help on using the repository browser.