GNEAdditional.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A abstract class for representation of additional elements
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/GNEHierarchicalElement.h>
#include <utils/gui/div/GUIGeometry.h>
#include <netedit/GNEPathManager.h>
#include <netedit/GNEMoveElement.h>
#include <netedit/elements/GNEContour.h>
#include <utils/common/Parameterised.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/images/GUITextureSubSys.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEViewNet;
class GNENetworkElement;
class GUIGLObjectPopupMenu;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEAdditional : public GNEPathManager::PathElement, public GNEHierarchicalElement, public GNEMoveElement {
 
public:
    GNEAdditional(const std::string& id, GNENet* net, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon, std::string additionalName,
                  const std::vector<GNEJunction*>& junctionParents,
                  const std::vector<GNEEdge*>& edgeParents,
                  const std::vector<GNELane*>& laneParents,
                  const std::vector<GNEAdditional*>& additionalParents,
                  const std::vector<GNEDemandElement*>& demandElementParents,
                  const std::vector<GNEGenericData*>& genericDataParents);
 
    GNEAdditional(GNENet* net, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon, std::string additionalName,
                  const std::vector<GNEJunction*>& junctionParents,
                  const std::vector<GNEEdge*>& edgeParents,
                  const std::vector<GNELane*>& laneParents,
                  const std::vector<GNEAdditional*>& additionalParents,
                  const std::vector<GNEDemandElement*>& demandElementParents,
                  const std::vector<GNEGenericData*>& genericDataParents);
 
    ~GNEAdditional();
 
    virtual GNEMoveOperation* getMoveOperation() = 0;
 
    void removeGeometryPoint(const Position clickedPosition, GNEUndoList* undoList);
 
    GUIGlObject* getGUIGlObject();
 
    const GUIGlObject* getGUIGlObject() const;
 
    virtual const std::string getOptionalName() const;
 
    const GUIGeometry& getAdditionalGeometry() const;
 
    void setSpecialColor(const RGBColor* color);
 
    void resetAdditionalContour();
 
 
    virtual void writeAdditional(OutputDevice& device) const = 0;
 
    virtual bool isAdditionalValid() const = 0;
 
    virtual std::string getAdditionalProblem() const = 0;
 
    virtual void fixAdditionalProblem() = 0;
 
 
 
    virtual void openAdditionalDialog();
 
    virtual void updateGeometry() = 0;
 
    virtual Position getPositionInView() const = 0;
 
    double getExaggeration(const GUIVisualizationSettings& s) const;
 
    Boundary getCenteringBoundary() const;
 
    virtual void updateCenteringBoundary(const bool updateGrid) = 0;
 
    virtual void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList) = 0;
 
 
 
    bool checkDrawFromContour() const;
 
    bool checkDrawToContour() const;
 
    bool checkDrawRelatedContour() const;
 
    bool checkDrawOverContour() const;
 
    bool checkDrawDeleteContour() const;
 
    bool checkDrawSelectContour() const;
 
    virtual bool checkDrawMoveContour() const = 0;
 
 
 
    virtual GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    const std::string& getOptionalAdditionalName() const;
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
    bool isGLObjectLocked() const;
 
    void markAsFrontElement();
 
    void deleteGLObject();
 
    void selectGLObject();
 
    void updateGLObject();
 
 
 
    virtual void computePathElement();
 
    bool isPathElementSelected() const;
 
    virtual void drawLanePartialGL(const GUIVisualizationSettings& s, const GNEPathManager::Segment* segment, const double offsetFront) const;
 
    virtual void drawJunctionPartialGL(const GUIVisualizationSettings& s, const GNEPathManager::Segment* segment, const double offsetFront) const;
 
    GNELane* getFirstPathLane() const;
 
    GNELane* getLastPathLane() const;
 
 
 
    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    virtual std::string getAttribute(SumoXMLAttr key) const = 0;
 
    /* @brief method for getting the Attribute of an XML key in double format (to avoid unnecessary parse<double>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    virtual double getAttributeDouble(SumoXMLAttr key) const = 0;
 
    /* @brief method for getting the Attribute of an XML key in position format (to avoid unnecessary parse<position>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    virtual Position getAttributePosition(SumoXMLAttr key) const;
 
    virtual const Parameterised::Map& getACParametersMap() const = 0;
 
    virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
 
    virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
 
    virtual std::string getPopUpID() const = 0;
 
    virtual std::string getHierarchyName() const = 0;
 
 
    void drawParentChildLines(const GUIVisualizationSettings& s, const RGBColor& color, const bool onlySymbols = false) const;
 
    void drawUpGeometryPoint(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d, const Position& pos,
                             const double rot, const RGBColor& baseColor, const bool ignoreShift = false) const;
 
    void drawDownGeometryPoint(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d, const Position& pos,
                               const double rot, const RGBColor& baseColor, const bool ignoreShift = false) const;
 
    void drawLeftGeometryPoint(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d, const Position& pos,
                               const double rot, const RGBColor& baseColor, const bool ignoreShift = false) const;
 
    void drawRightGeometryPoint(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d, const Position& pos,
                                const double rot, const RGBColor& baseColor, const bool ignoreShift = false) const;
 
    int getDrawPositionIndex() const;
 
    static bool areLaneConsecutives(const std::vector<GNELane*>& lanes);
 
    static bool areLaneConnected(const std::vector<GNELane*>& lanes);
 
protected:
    Boundary myAdditionalBoundary;
 
    GUIGeometry myAdditionalGeometry;
 
    GNEContour myAdditionalContour;
 
    std::string myAdditionalName;
 
    const RGBColor* mySpecialColor = nullptr;
 
 
    bool isValidAdditionalID(const std::string& value) const;
 
    bool isValidAdditionalID(const std::vector<SumoXMLTag>& tags, const std::string& value) const;
 
    bool isValidDetectorID(const std::string& value) const;
 
    bool isValidDetectorID(const std::vector<SumoXMLTag>& tags, const std::string& value) const;
 
    void setAdditionalID(const std::string& newID);
 
 
    void drawAdditionalID(const GUIVisualizationSettings& s) const;
 
    void drawAdditionalName(const GUIVisualizationSettings& s) const;
 
    void replaceAdditionalParentEdges(const std::string& value);
 
    void replaceAdditionalParentLanes(const std::string& value);
 
    void replaceAdditionalChildEdges(const std::string& value);
 
    void replaceAdditionalChildLanes(const std::string& value);
 
    void replaceAdditionalParent(SumoXMLTag tag, const std::string& value, const int parentIndex);
 
    void replaceDemandElementParent(SumoXMLTag tag, const std::string& value, const int parentIndex);
 
    void shiftLaneIndex();
 
    void calculatePerpendicularLine(const double endLaneposition);
 
    void drawSquaredAdditional(const GUIVisualizationSettings& s, const Position& pos, const double size,
                               GUITexture texture, GUITexture selectedTexture) const;
 
    void drawListedAdditional(const GUIVisualizationSettings& s, const Position& parentPosition, const double offsetX,
                              const double extraOffsetY, const RGBColor baseCol, const RGBColor textCol, GUITexture texture,
                              const std::string text) const;
 
    bool drawMovingGeometryPoints(const bool ignoreShift) const;
 
    void drawDemandElementChildren(const GUIVisualizationSettings& s) const;
 
    GNEMoveOperation* getMoveOperationSingleLane(const double startPos, const double endPos);
 
    GNEMoveOperation* getMoveOperationMultiLane(const double startPos, const double endPos);
 
 
    static std::string getJuPedSimType(SumoXMLTag tag);
 
    static RGBColor getJuPedSimColor(SumoXMLTag tag);
 
    static bool getJuPedSimFill(SumoXMLTag tag);
 
    static double getJuPedSimLayer(SumoXMLTag tag);
 
    static GUIGlObjectType getJuPedSimGLO(SumoXMLTag tag);
 
    static FXIcon* getJuPedSimIcon(SumoXMLTag tag);
 
 
 
    void calculateContourPolygons(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                                  const double layer, const double exaggeration, const bool filledShape) const;
 
 
private:
    virtual bool checkChildAdditionalRestriction() const;
 
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    virtual void setMoveShape(const GNEMoveResult& moveResult) = 0;
 
    virtual void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList) = 0;
 
    void drawSemiCircleGeometryPoint(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                                     const Position& pos, const double rot, const RGBColor& baseColor,
                                     const double fromAngle, const double toAngle, const bool ignoreShift) const;
 
    std::string adjustListedAdditionalText(const std::string& text) const;
 
    GNEAdditional(const GNEAdditional&) = delete;
 
    GNEAdditional& operator=(const GNEAdditional&) = delete;
};