GNEAdditional.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// A abstract class for representation of additional elements
/****************************************************************************/
#ifndef GNEAdditional_h
#define GNEAdditional_h

// ===========================================================================
// included modules
// ===========================================================================

#include <config.h>

#include <string>
#include <vector>
#include <utils/common/Parameterised.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/settings/GUIPropertySchemeStorage.h>
#include <netedit/GNEAttributeCarrier.h>

// ===========================================================================
// class declarations
// ===========================================================================

class GNEAdditionalDialog;
class GNEEdge;
class GNELane;
class GNENet;
class GNEViewNet;
class GUIGLObjectPopupMenu;

// ===========================================================================
// class definitions
// ===========================================================================

class GNEAdditional : public GUIGlObject, public GNEAttributeCarrier, public Parameterised {

public:
    GNEAdditional(const std::string& id, GNEViewNet* viewNet, GUIGlObjectType type, SumoXMLTag tag, std::string additionalName, bool blockMovement);

    GNEAdditional(GNEAdditional* singleAdditionalParent, GNEViewNet* viewNet, GUIGlObjectType type, SumoXMLTag tag, std::string additionalName, bool blockMovement);

    GNEAdditional(GNEAdditional* firstAdditionalParent, GNEAdditional* secondAdditionalParent, GNEViewNet* viewNet, GUIGlObjectType type, SumoXMLTag tag, std::string additionalName, bool blockMovement);

    GNEAdditional(const std::string& id, GNEViewNet* viewNet, GUIGlObjectType type, SumoXMLTag tag, std::string additionalName, bool blockMovement, std::vector<GNEEdge*> edgeChilds);

    GNEAdditional(const std::string& id, GNEViewNet* viewNet, GUIGlObjectType type, SumoXMLTag tag, std::string additionalName, bool blockMovement, std::vector<GNELane*> laneChilds);

    ~GNEAdditional();

    void writeAdditional(OutputDevice& device) const;

    virtual void openAdditionalDialog();

    void startGeometryMoving();

    void endGeometryMoving();

    virtual void moveGeometry(const Position& oldPos, const Position& offset) = 0;

    virtual void commitGeometryMoving(const Position& oldPos, GNEUndoList* undoList) = 0;

    virtual void updateGeometry(bool updateGrid) = 0;

    virtual Position getPositionInView() const = 0;

    GNEViewNet* getViewNet() const;

    PositionVector getShape() const;

    bool isAdditionalBlocked() const;

    // @brief get first additional parent
    GNEAdditional* getFirstAdditionalParent() const;

    // @brief get second additional parent
    GNEAdditional* getSecondAdditionalParent() const;

    std::string generateAdditionalChildID(SumoXMLTag childTag);


    void addAdditionalChild(GNEAdditional* additional);

    void removeAdditionalChild(GNEAdditional* additional);

    const std::vector<GNEAdditional*>& getAdditionalChilds() const;

    void sortAdditionalChilds();

    bool checkAdditionalChildsOverlapping() const;

    void addEdgeChild(GNEEdge* edge);

    void removeEdgeChild(GNEEdge* edge);

    const std::vector<GNEEdge*>& getEdgeChilds() const;

    void addLaneChild(GNELane* lane);

    void removeLaneChild(GNELane* lane);

    const std::vector<GNELane*>& getLaneChilds() const;



    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);

    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);

    Boundary getCenteringBoundary() const;

    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;

    void selectAttributeCarrier(bool changeFlag = true);

    void unselectAttributeCarrier(bool changeFlag = true);

    bool isAttributeCarrierSelected() 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;

    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;


    bool addGenericParameter(const std::string& key, const std::string& value);

    bool removeGenericParameter(const std::string& key);

    bool updateGenericParameter(const std::string& oldKey, const std::string& newKey);

    bool updateGenericParameterValue(const std::string& key, const std::string& newValue);

    std::string getGenericParametersStr() const;

    std::vector<std::pair<std::string, std::string> > getGenericParameters() const;

    void setGenericParametersStr(const std::string& value);


    static bool isRouteValid(const std::vector<GNEEdge*>& edges, bool report);

protected:
    GNEViewNet* myViewNet;

    PositionVector myShape;

    Boundary myMovingGeometryBoundary;

    std::string myAdditionalName;

    std::vector<double> myShapeRotations;

    std::vector<double> myShapeLengths;

    bool myBlockMovement;

    GNEAdditional* myFirstAdditionalParent;

    GNEAdditional* mySecondAdditionalParent;

    std::vector<GNEAdditional*> myAdditionalChilds;

    std::vector<GNEEdge*> myEdgeChilds;

    std::vector<GNELane*> myLaneChilds;

    void setDefaultValues();

    void setBlockIconRotation(GNELane* additionalLane = nullptr);

    void drawLockIcon(double size = 0.5) const;

    Position myBlockIconPosition;

    Position myBlockIconOffset;

    double myBlockIconRotation;


    const std::string& getAdditionalID() const;

    bool isValidAdditionalID(const std::string& newID) const;

    void changeAdditionalID(const std::string& newID);

    GNEEdge* changeEdge(GNEEdge* oldEdge, const std::string& newEdgeID);

    GNELane* changeLane(GNELane* oldLane, const std::string& newLaneID);

    void changeFirstAdditionalParent(const std::string& newAdditionalParentID);

    void changeSecondAdditionalParent(const std::string& newAdditionalParentID);



    void updateChildConnections();

    void drawChildConnections() const;

    std::vector<std::pair<Position, double> > mySymbolsPositionAndRotation;

    std::vector<PositionVector> myChildConnectionPositions;


private:
    virtual bool checkAdditionalChildRestriction() const;

    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;

    void mouseOverObject(const GUIVisualizationSettings& s) const;

    GNEAdditional(const GNEAdditional&) = delete;

    GNEAdditional& operator=(const GNEAdditional&) = delete;
};

#endif