overlay.h

/*
   Copyright (C) 2014 - 2016 Mutzii

   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 3 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, see <http://www.gnu.org/licenses/>.

*/
#ifndef OVERLAY_H
#define OVERLAY_H

#include "index.h"
#include "rendercomponent.h"
#include "rendersystem.h"

namespace Engine
{
    /* List of Element Renderobjects */
    using Elements = std::list< RenderElement *>;

    class Overlay
    {
        public:

           explicit Overlay( const std::string & overlay_name );
           ~Overlay() = default;

            void finish(void);

           const std::string & getName(void) const;

           void addElement( RenderElement * element );

           void remove( RenderElement * element );

           Elements getElements(void);

           void render( const DrawEvent & event );

           bool isVisible(void);
           void setVisible( bool status );

        private:

           std::string mName;  
           bool m_visible;

           Elements mElements; 
    };
}

#endif // OVERLAY_H