connection.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_CONNECTION_H__
#define __ANTARES_TOOLBOX_MAP_CONNECTION_H__
 
#include "item.h"
#include "node.h"
#include "../tools/tool.h"
#include <antares/study/area/area.h>
 
namespace Antares::Map
{
// Forward declaration
namespace Tool
{
class Tool;
}
 
class Connection: public Item
{
public:
    enum Direction
    {
        dirNone,
        dirDirect,
        dirIndirect,
    };
 
public:
 
 
    Connection(Manager& manager, Item* a, Item* b);
    virtual ~Connection();
 
 
 
    bool isVisibleOnLayer(const size_t& layerID) const;
 
    virtual Type type() const;
 
    Item* leftSide()
    {
        return pA;
    }
 
    const Item* leftSide() const
    {
        return pA;
    }
 
    Item* rightSide()
    {
        return pB;
    }
 
    const Item* rightSide() const
    {
        return pB;
    }
 
    Direction arrowDirection() const
    {
        return pArrowDirection;
    }
 
    void arrowDirection(const Direction& d);
 
    Direction direction() const
    {
        return pDirection;
    }
 
    void direction(const Direction& d);
 
    virtual void refreshCache(wxDC& dc);
 
    virtual bool contains(const int x, const int y, double& distance);
 
    virtual bool isContained(const int x1, const int y1, const int x2, const int y2) const;
 
    virtual void draw(DrawingContext& dc);
 
    virtual void extendBoundingBox(wxPoint& topLeft, wxPoint& bottomRight);
 
 
    virtual bool selected() const;
    virtual void selected(bool v);
 
 
    Data::AreaLink* attachedAreaLink() const;
    void attachedAreaLink(Data::AreaLink* a);
 
    void createANewConnectionIfNeeded();
 
private:
    void drawArrow(wxDC& dc, const Direction direction, const wxPoint& rA, const wxPoint& rB);
 
    void destroyTools();
    void createTools();
 
private:
    Item* pA;
    Item* pB;
    Direction pDirection;
    Direction pArrowDirection;
 
    wxPoint pCachedAbsolutePosition;
    wxPoint pCachedSize;
    wxPoint pCachedMiddlePoint;
    wxPoint pCachedTextPos;
    bool pCachedError;
 
    bool pHaveTools;
    Tool::Tool* pToolDirection;
 
    Data::AreaLink* pAttachedAreaLink;
 
    wxPen pDefaultPen;
    wxPen pErrorPen;
 
}; // class Connection
 
} // namespace Antares::Map
 
#include "connection.hxx"
 
#endif // __ANTARES_TOOLBOX_MAP_CONNECTION_H__