source: code/branches/core5/src/orxonox/gamestates/GSGraphics.h @ 5871

/*
 *   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:
 *      Benjamin Knecht (documentation)
 *
 */

/**
@file
@brief
    Declaration of the Graphics GameState class.
*/

#ifndef _GSGraphics_H__
#define _GSGraphics_H__

#include "OrxonoxPrereqs.h"
#include "core/GameState.h"

namespace orxonox
{
    /**
    @brief
        Game state used when displaying graphics of any kind. Another blubb resides here.

        This game state is only left out if we start a dedicated server where no graphics are present.
    */
    class _OrxonoxExport GSGraphics : public GameState
    {
    public:
        GSGraphics(const GameStateInfo& info);
        ~GSGraphics();

        void activate();
        void deactivate();
        void update(const Clock& time);

        void toggleGUI();

    private:
        XMLFile*              debugOverlay_;
        ConsoleCommand*       ccToggleGUI_;         //!< Console command to toggle GUI
    };
}

#endif /* _GSGraphics_H__ */