root/cafu/trunk/CaWE/ToolManager.hpp

/*
=================================================================================
This file is part of Cafu, the open-source game engine and graphics engine
for multiplayer, cross-platform, real-time 3D action.
Copyright (C) 2002-2012 Carsten Fuchs Software.

Cafu 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.

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

For support and more information about Cafu, visit us at <http://www.cafu.de>.
=================================================================================
*/

#ifndef CAFU_TOOL_MANAGER_HPP_INCLUDED
#define CAFU_TOOL_MANAGER_HPP_INCLUDED

#include "ObserverPatternTools.hpp"
#include "Templates/Array.hpp"


class MapDocumentT;
class ToolT;
class wxWindow;
namespace cf { namespace TypeSys { class TypeInfoT; } }


class ToolManagerT : public ToolsSubjectT
{
    public:

    /// The constructor.
    ToolManagerT(MapDocumentT& MapDoc, wxWindow* ParentToolOptions);

    /// The destructor.
    ~ToolManagerT();


    /// Returns the array of all tools registered with and known to the tool manager.
    const ArrayT<ToolT*>& GetTools() const { return m_Tools; }

    /// Returns the tool instance matching the given type.
    /// NULL is returned when Type is not a type of a valid tool.
    ToolT* GetTool(const cf::TypeSys::TypeInfoT& Type);

    /// Returns the currently active tool.
    ToolT* GetActiveTool() const { return m_ActiveTool; }

    /// Returns the type of the currently active tool.
    /// This method is just a convenience method that saves the caller the explicit check for NULL when calling GetActiveTool().
    const cf::TypeSys::TypeInfoT* GetActiveToolType() const;

    /// Sets the tool of the given type as the currently active tool.
    void SetActiveTool(const cf::TypeSys::TypeInfoT* Type);


    private:

    ToolManagerT(const ToolManagerT&);          ///< Use of the Copy Constructor    is not allowed.
    void operator = (const ToolManagerT&);      ///< Use of the Assignment Operator is not allowed.


    MapDocumentT&  m_MapDoc;        ///< The MapDocumentT whose tool manager we are.
    ArrayT<ToolT*> m_Tools;         ///< The list of all tools available for editing the map document.
    ToolT*         m_ActiveTool;    ///< One of the tools in m_Tools, this is the currently active one. NULL when no tool is currently active.
};

#endif