GNEPOI.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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 class for visualizing and editing POIS in netedit (adapted from
// GUIPointOfInterest and NLHandler)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/shapes/Shape.h>
#include <utils/xml/CommonXMLStructure.h>
 
#include "GNEAdditional.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNEMoveElementLaneSingle;
class GNEMoveElementViewResizable;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEPOI : public Shape, public GNEAdditional,  public Parameterised {
 
public:
    // avoid diamond problem
    using GNEAttributeCarrier::getID;
 
    GNEPOI(SumoXMLTag tag, GNENet* net);
 
    GNEPOI(const std::string& id, GNENet* net, const std::string& filename, const std::string& type, const RGBColor& color,
           const Position& pos, const bool geo, POIIcon icon, const double layer, const double angle, const std::string& imgFile,
           const double width, const double height, const std::string& name, const Parameterised::Map& parameters);
 
    GNEPOI(const std::string& id, GNENet* net, const std::string& filename, const std::string& type, const RGBColor& color, GNELane* lane,
           const double posOverLane, const bool friendlyPos, const double posLat, POIIcon icon, const double layer, const double angle,
           const std::string& imgFile, const double width, const double height, const std::string& name, const Parameterised::Map& parameters);
 
    ~GNEPOI();
 
 
    GNEMoveElement* getMoveElement() const override;
 
    Parameterised* getParameters() override;
 
    const Parameterised* getParameters() const override;
 
 
    std::string generateChildID(SumoXMLTag childTag);
 
    CommonXMLStructure::SumoBaseObject* getSumoBaseObject() const;
 
 
    void updateGeometry() override;
 
    Position getPositionInView() const override;
 
    double getExaggeration(const GUIVisualizationSettings& s) const override;
 
    void updateCenteringBoundary(const bool updateGrid) override;
 
    void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement,
                           const GNENetworkElement* newElement, GNEUndoList* undoList) override;
 
    void writeAdditional(OutputDevice& device) const override;
 
    bool isAdditionalValid() const override;
 
    std::string getAdditionalProblem() const override;
 
    void fixAdditionalProblem() override;
 
    GUIGlID getGlID() const;
 
 
 
    bool checkDrawMoveContour() const override;
 
 
 
    std::string getParentName() const override;
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    void drawGL(const GUIVisualizationSettings& s) const override;
 
 
 
    std::string getAttribute(SumoXMLAttr key) const override;
 
    /* @brief method for getting the Attribute of an XML key in double format
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    double getAttributeDouble(SumoXMLAttr key) const override;
 
    /* @brief method for getting the Attribute of an XML key in position format
     * @param[in] key The attribute key
     * @return position with the value associated to key
     */
    Position getAttributePosition(SumoXMLAttr key) const override;
 
    /* @brief method for getting the Attribute of an XML key in positionVector format
     * @param[in] key The attribute key
     * @return positionVector with the value associated to key
     */
    PositionVector getAttributePositionVector(SumoXMLAttr key) const override;
 
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) override;
 
    bool isValid(SumoXMLAttr key, const std::string& value) override;
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    bool isAttributeEnabled(SumoXMLAttr key) const override;
 
 
    std::string getPopUpID() const override;
 
    std::string getHierarchyName() const override;
 
protected:
    Position myPosOverView;
 
    double myPosOverLane = 0;
 
    bool myFriendlyPos = false;
 
    double myWidth = 0;
 
    double myHeight = 0;
 
    double myPosLat = 0;
 
    POIIcon myPOIIcon = POIIcon::NONE;
 
    GNEMoveElementLaneSingle* myMoveElementLaneSingle = nullptr;
 
    GNEMoveElementViewResizable* myMoveElementViewResizable = nullptr;
 
private:
    void drawPOI(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                 const bool movingGeometryPoints) const;
 
    void calculatePOIContour(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                             const double exaggeration, const bool movingGeometryPoints) const;
 
    void setAttribute(SumoXMLAttr key, const std::string& value) override;
 
    GNEPOI(const GNEPOI&) = delete;
 
    GNEPOI& operator=(const GNEPOI&) = delete;
};