OrxonoxOverlay.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Reto Grieder
 *   Co-authors:
 *      ...
 *
 */

#ifndef _OrxonoxOverlay_H__
#define _OrxonoxOverlay_H__

#include "OrxonoxPrereqs.h"

#include <string>

#include "util/Math.h"
#include "util/OgreForwardRefs.h"
#include "core/BaseObject.h"
#include "core/WindowEventListener.h"
#include "core/class/Super.h"

namespace orxonox
{
    class _OrxonoxExport OrxonoxOverlay : public BaseObject, public WindowEventListener
    {
    public:
        enum class RotationState
        {
            Horizontal,
            Vertical,
            Inbetween
        };

    public:
        OrxonoxOverlay(Context* context);
        virtual ~OrxonoxOverlay();

        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;

        virtual void changedName() override;

        void show() { this->setVisible(true); }
        void hide() { this->setVisible(false); }

        void setAspectCorrection(bool val)        { this->bCorrectAspect_ = val; this->sizeCorrectionChanged(); }
        bool getAspectCorrection() const          { return this->bCorrectAspect_; }

        void setPosition(Vector2 pos)             { this->position_ = pos; this->positionChanged(); }

        const Vector2& getPosition() const        { return this->position_; }

        void scroll(const Vector2& offset)        { this->position_ += offset; this->positionChanged(); }

        void setPickPoint(const Vector2& position){ this->pickPoint_ = position; this->positionChanged(); }

        const Vector2& getPickPoint() const       { return this->pickPoint_; }

        void setRotation(const Degree& angle)     { this->angle_ = angle; this->angleChanged(); }

        const Degree& getRotation() const         { return this->angle_; }

        void rotate(const Degree& angle)          { this->angle_ += angle; this->angleChanged(); }

        void setSize(const Vector2& size)         { this->size_ = size; this->sizeChanged(); }

        const Vector2& getSize() const            { return this->size_; }

        Vector2 getActualSize() const             { return this->size_ * this->sizeCorrection_; }

        const Vector2& getSizeCorrection() const  { return this->sizeCorrection_; }

        void scale(const Vector2& scale)          { this->size_ *= scale; this->sizeChanged(); }

        static void scaleOverlay(const std::string& name, float scale);
        static void scrollOverlay(const std::string& name, const Vector2& scroll);
        static void toggleVisibility(const std::string& name);
        static void showOverlay(const std::string& name);
        static void rotateOverlay(const std::string& name, const Degree& angle);

        void setBackgroundMaterial(const std::string& material);
        const std::string& getBackgroundMaterial() const;

        void setBackgroundTexture(const std::string& texture);
        const std::string& getBackgroundTexture() const;

        void setBackgroundAlpha(float alpha);

        void setBackgroundColour(ColourValue colour);

        virtual void changedVisibility() override;

        inline void setOwner(BaseObject* owner)
        {
            if (this->owner_ != owner)
            {
                this->owner_ = owner;
                this->changedOwner();
            }
        }
        inline BaseObject* getOwner() const
            { return this->owner_; }
        virtual void changedOwner() {}

        void setOverlayGroup(OverlayGroup* group);
        inline OverlayGroup* getOverlayGroup() const
            { return this->group_; }
        virtual void changedOverlayGroup()
            { this->changedVisibility(); }
        void setZOrder(unsigned short order);

    protected:
        virtual void angleChanged();
        virtual void sizeCorrectionChanged();
        virtual void sizeChanged();
        virtual void positionChanged();

        Ogre::Overlay* overlay_;                   
        Ogre::PanelOverlayElement* background_;    

        float windowAspectRatio_;                  
        bool bCorrectAspect_;                      
        Vector2 size_;                             
        Vector2 sizeCorrection_;                   
        Vector2 position_;                         
        Vector2 pickPoint_;                        
        Degree angle_;                             
        RotationState rotState_;                   

    private:
        virtual void windowResized(unsigned int newWidth, unsigned int newHeight) override;

        static unsigned int hudOverlayCounter_s;   

        static std::map<std::string, OrxonoxOverlay*> overlays_s;
        BaseObject* owner_;
        OverlayGroup* group_;
        Ogre::Pass* backgroundAlphaPass_;
  };

  SUPER_FUNCTION(6, OrxonoxOverlay, changedOwner, false);
  SUPER_FUNCTION(7, OrxonoxOverlay, changedOverlayGroup, false);
}

#endif /* _OrxonoxOverlay_H__ */