GNEMoveElement.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
/****************************************************************************/
// Class used for elements that can be moved
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/xml/SUMOXMLDefinitions.h>
 
#include "GNEMoveOffset.h"
#include "GNEMoveResult.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNEAttributeCarrier;
class GNEUndoList;
class GNEViewNet;
class GUIGlObject;
class Parameterised;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEMoveElement {
 
public:
    GNEMoveElement(GNEAttributeCarrier* movedElement);
 
    virtual ~GNEMoveElement();
 
    virtual GNEMoveOperation* getMoveOperation() = 0;
 
 
    virtual std::string getMovingAttribute(SumoXMLAttr key) const = 0;
 
    virtual double getMovingAttributeDouble(SumoXMLAttr key) const = 0;
 
    virtual Position getMovingAttributePosition(SumoXMLAttr key) const = 0;
 
    virtual PositionVector getMovingAttributePositionVector(SumoXMLAttr key) const = 0;
 
    virtual void setMovingAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
 
    virtual bool isMovingAttributeValid(SumoXMLAttr key, const std::string& value) const = 0;
 
    virtual void setMovingAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
 
    virtual void removeGeometryPoint(const Position clickedPosition, GNEUndoList* undoList) = 0;
 
    static void moveElement(const GNEViewNet* viewNet, GNEMoveOperation* moveOperation, const GNEMoveOffset& offset);
 
    static void commitMove(const GNEViewNet* viewNet, GNEMoveOperation* moveOperation, const GNEMoveOffset& offset, GNEUndoList* undoList);
 
    double myMovingLateralOffset = 0;
 
protected:
    GNEAttributeCarrier* myMovedElement = nullptr;
 
    GNEMoveOperation* getEditShapeOperation(const GUIGlObject* obj, const PositionVector originalShape, const bool maintainShapeClosed);
 
private:
    virtual void setMoveShape(const GNEMoveResult& moveResult) = 0;
 
    virtual void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList) = 0;
 
    static double calculateLaneOffset(const GNEViewNet* viewNet, const GNELane* lane, const double firstPosition,
                                      const double lastPosition, const GNEMoveOffset& offset);
 
    static void calculateLanePosition(double& starPos, const GNEViewNet* viewNet, const GNELane* lane,
                                      const double posOverLane, const GNEMoveOffset& offset);
 
    static void calculateLanePositions(double& starPos, double& endPos, const GNEViewNet* viewNet, const GNELane* lane,
                                       const double firstPosOverLane, const double lastPosOverLane, const GNEMoveOffset& offset);
 
    static void calculateLanePositions(double& starPos, double& endPos, const GNEViewNet* viewNet, const GNELane* firstLane,
                                       const double firstPosOverLane, const GNELane* lastLane, const double lastPosOverLane,
                                       const bool firstLaneClicked, const GNEMoveOffset& offset);
 
    static void calculateNewLaneChange(const GNEViewNet* viewNet, const GNELane* originalLane, const GNELane*& newLane, double& laneOffset);
 
    static PositionVector calculateExtrapolatedVector(const GNEMoveOperation* moveOperation, const GNEMoveResult& moveResult);
 
    GNEMoveElement() = delete;
 
    GNEMoveElement(const GNEMoveElement&) = delete;
 
    GNEMoveElement& operator=(const GNEMoveElement&) = delete;
};