component.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_COMPONENT_H__
#define __ANTARES_TOOLBOX_MAP_COMPONENT_H__
 
#include <antares/study/study.h>
#include "control.h"
#include <wx/stattext.h>
#include <ui/common/component/panel.h>
#include "../button.h"
#include "../notebook/mapnotebook.h"
#include "settings.h"
 
#include <wx/textctrl.h>
 
namespace Antares::Map
{
class Component final: public Antares::Component::Panel, public Yuni::IEventObserver<Component>
{
public:
 
 
    Component(wxWindow* parent);
    virtual ~Component();
 
 
 
    void attachStudy(Data::Study::Ptr study);
 
    void detachStudy(bool canRefresh = true);
 
    Data::Study::Ptr attachedStudy();
 
 
 
    bool loadFromStudy(Data::Study& study);
 
    bool loadFromAttachedStudy();
 
    bool saveToStudy(Data::Study& study, bool incremental = true);
 
    bool saveToAttachedStudy(bool incremental = true);
 
    bool saveToImageFile(const AnyString& filePath, const MapRenderOptions& options);
 
    void clear();
 
 
 
    void recenterView();
 
    void onCenterXY(void*);
 
    void setFocus();
 
    uint selectedAreaCount() const;
 
    void drawerVisible();
 
    void showLayerAll();
 
    void forceReload();
    void refresh();
 
    void refreshHeaderInformations();
 
    void renameNodeFromArea(const Data::Area* area);
 
 
 
    void unselectAll(bool canRefresh = true);
 
    void selectAll();
 
    void reverseSelection();
 
    void selectOnly(const Data::Area::Vector& areas);
 
    void selectOnly(const Data::Area::Vector& areas, const Data::AreaLink::Vector& links);
 
 
 
    void reimportNodeColors(const Data::Area* area);
 
    void moveNodeFromAreaX(const Data::Area* area, int x);
 
    void moveNodeFromAreaY(const Data::Area* area, int y);
 
 
    size_t getActiveLayerID()
    {
        return pMapActiveLayer ? pMapActiveLayer->getUid() : 0;
    }
 
public:
    Yuni::Event<void(int, int)> onPopupEvent;
    Yuni::Event<void(const wxString&)> onStatusBarText;
    Yuni::Event<void(Component&)> onDblClick;
    // Yuni::Event<void (void*)> onTextEnter;
 
private:
    class Drawer final: public Antares::Component::Panel
    {
    public:
        Drawer(wxWindow* parent, Component& com):
            Antares::Component::Panel(parent),
            pComponent(com)
        {
        }
 
        void onDraw(wxPaintEvent& evt);
        void onSize(wxSizeEvent& evt);
 
    private:
        void drawFromDevice(wxDC& dc);
 
    private:
        Component& pComponent;
        DECLARE_EVENT_TABLE()
    };
 
    void onApplicationQuit();
 
    void onPageChanged(Antares::Component::MapNotebook::Page& page);
 
    Antares::Component::MapNotebook::Page* addNewLayer(wxString pageName = wxString(""),
                                                       size_t uID = 0);
 
    void addNewEmptyLayer()
    {
        addNewLayer();
    }
 
    void removeLayer(Antares::Component::MapNotebook::Page& page);
 
    void evtOnPopupEvent(int x, int y);
 
    void evtOnSelectionHide(wxCommandEvent&);
 
    void evtOnSelectionShow(wxCommandEvent&);
 
    void onCopy(void*);
    void onCopyDropdown(Antares::Component::Button&, wxMenu& menu, void*);
    void evtPopupCopy(wxCommandEvent&);
    void evtPopupCopyAll(wxCommandEvent&);
    void evtPopupCopyAllAreas(wxCommandEvent&);
    void evtPopupCopyAllLinks(wxCommandEvent&);
    void onPaste(void*);
    void onPasteDropdown(Antares::Component::Button&, wxMenu& menu, void*);
    void evtPopupPaste(wxCommandEvent&);
    void evtPopupPasteSpecial(wxCommandEvent&);
    void onSelectAll(void*);
 
    void onNew(void*);
    void onNewDropdown(Antares::Component::Button&, wxMenu& menu, void*);
 
    template<unsigned int N>
    inline void evtNewArea(wxCommandEvent&)
    {
        if (pMapActiveLayer)
        {
            pMapActiveLayer->addNewNode(N);
        }
        setFocus();
    }
 
    void onToggleMouseSelectionArea(void*);
    void onToggleMouseSelectionLink(void*);
    void onToggleMouseSelectionPlant(void*);
    void onToggleMouseSelectionConstraint(void*);
 
    void onCenter(void*);
 
    void onEvtCenterXY(wxCommandEvent& WXUNUSED(event));
 
private:
    Control* pMapActiveLayer;
    Antares::Component::MapNotebook* pNoteBook;
    std::vector<Control*> mapLayersPtrList;
 
    wxStaticText* pInfosAreaCount;
    wxStaticText* pInfosConnxCount;
    // Toggle buttons
    // The class wxWindow is used here to not include button.h everywhere
    // It is already such a pain to compile on Windows...
    wxWindow* pBtnSelectionArea;
    wxWindow* pBtnSelectionLink;
    wxWindow* pBtnSelectionPlant;
    wxWindow* pBtnSelectionConstraint;
 
    // PopUp Menu
    wxMenu* pSelectionPopUpMenu;
 
}; // class Component
 
} // namespace Antares::Map
 
#endif // __ANTARES_TOOLBOX_MAP_COMPONENT_H__