tool.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator 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
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#ifndef __ANTARES_TOOLBOX_MAP_TOOLS_TOOL_H__
#define __ANTARES_TOOLBOX_MAP_TOOLS_TOOL_H__
 
#include <vector>
#include "../drawingcontext.h"
 
namespace Antares::Map::Tool
{
enum LifeSpan
{
    lifeSpanMouseSelection,
    lifeSpanImmortality,
 
}; // enum LifeSpan
 
class Tool
{
public:
 
 
    Tool(Manager& manager, const char* icon);
    virtual ~Tool();
 
 
 
    Manager& manager()
    {
        return pManager;
    }
 
    const Manager& manager() const
    {
        return pManager;
    }
 
 
 
    int x() const
    {
        return pX;
    }
 
    void x(const int v)
    {
        pX = v;
    }
 
 
    int y() const
    {
        return pY;
    }
 
    void y(const int v)
    {
        pY = v;
    }
 
 
 
    uint width() const
    {
        return pWidth;
    }
 
    uint height() const
    {
        return pHeight;
    }
 
 
 
    const wxBitmap* icon() const
    {
        return pIcon;
    }
 
    void icon(const char* filename);
 
    //}
 
 
    LifeSpan lifeSpan() const
    {
        return lifeSpanMouseSelection;
    }
 
 
 
 
    bool contains(const int x, const int y) const
    {
        return x >= pX && x <= pX + pWidth && y >= pY && y <= pY + pHeight;
    }
 
    virtual void draw(DrawingContext& dc,
                      const bool mouseDown,
                      const wxPoint& position,
                      const wxPoint& absolute) const;
 
 
    virtual bool actionIsImmediate() const
    {
        return true;
    }
 
    virtual bool onMouseUp(const int mx, const int my) = 0;
 
protected:
    Manager& pManager;
    int pX;
    int pY;
    int pWidth;
    int pHeight;
    wxBitmap* pIcon;
 
}; // class Tool
 
using List = std::vector<Tool*>;
 
} // namespace Antares::Map::Tool
 
#endif // __ANTARES_TOOLBOX_MAP_TOOLS_TOOL_H__