GNEAdditional.h

Go to the documentation of this file.

/****************************************************************************/
// A abstract class for representation of additional elements
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef GNEAdditional_h
#define GNEAdditional_h

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

#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

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

#include "GNEAttributeCarrier.h"

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

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

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

class GNEAdditional : public GUIGlObject, public GNEAttributeCarrier {
public:
    GNEAdditional(const std::string& id, GNEViewNet* viewNet, SumoXMLTag tag, GUIIcon icon);

    ~GNEAdditional();

    virtual void writeAdditional(OutputDevice& device, bool volatileOptionsEnabled) const = 0;

    virtual void openAdditionalDialog();

    const std::string& getAdditionalID() const;

    GNEViewNet* getViewNet() const;

    PositionVector getShape() const;

    bool isAdditionalBlocked() const;

    bool isAdditionalInspectionable() const;

    bool isAdditionalSelectable() const;

    bool isAdditionalMovable() const;

    // @brief Check if additional item is selected
    bool isAdditionalSelected() const;

    void setAdditionalID(const std::string& id);

    GNEEdge* getEdge() const;

    GNELane* getLane() const;


    virtual void moveGeometry(const Position& newPosition) = 0;

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

    virtual void updateGeometry() = 0;

    virtual Position getPositionInView() const = 0;

    virtual const std::string& getParentName() const = 0;

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

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

    Boundary getCenteringBoundary() const;

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

    /* @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;

protected:
    void changeEdge(const std::string& edgeID);

    void changeLane(const std::string& laneID);

protected:
    GNEViewNet* myViewNet;

    GNEEdge* myEdge;

    GNELane* myLane;

    PositionVector myShape;

    std::vector<double> myShapeRotations;

    std::vector<double> myShapeLengths;

    bool myRotationLefthand;

    void setBlockIconRotation();

    void drawLockIcon(double size = 0.5) const;

    void drawParentAndChildrenConnections() const;

    Position myBlockIconPosition;

    Position myBlockIconOffset;

    double myBlockIconRotation;

    bool myBlocked;

    bool myInspectionable;

    bool mySelectable;

    bool myMovable;

    GNEAdditionalDialog* myAdditionalDialog;

    std::vector<std::vector<Position> > myConnectionPositions;

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

    GNEAdditional(const GNEAdditional&) = delete;

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

#endif