GNEMoveElement.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
/****************************************************************************/
// Class used for elements that own a movable shape
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/gui/div/GUIGeometry.h>
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNELane;
class GNEMoveElement;
class GNEUndoList;
class GNEViewNet;
class GUIGlObject;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEMoveOperation {
 
public:
    enum class OperationType {
        POSITION,
        ENTIRE_SHAPE,
        GEOMETRY_POINTS,
        WIDTH,
        HEIGHT,
        LENGTH,
        SINGLE_LANE,
        SINGLE_LANE_MOVE_FIRST,
        SINGLE_LANE_MOVE_LAST,
        SINGLE_LANE_MOVE_BOTH,
        MULTIPLE_LANES_MOVE_FIRST,
        MULTIPLE_LANES_MOVE_LAST,
        MULTIPLE_LANES_MOVE_BOTH_FIRST,
        MULTIPLE_LANES_MOVE_BOTH_LAST
    };
 
    GNEMoveOperation(GNEMoveElement* moveElement,
                     const Position originalPosition);
 
    GNEMoveOperation(GNEMoveElement* moveElement,
                     const PositionVector originalShape);
 
    GNEMoveOperation(GNEMoveElement* moveElement,
                     const PositionVector originalShape,
                     const bool firstGeometryPoint,
                     const OperationType operationType);
 
    GNEMoveOperation(GNEMoveElement* moveElement,
                     const PositionVector originalShape,
                     const std::vector<int> originalgeometryPoints,
                     const PositionVector shapeToMove,
                     const std::vector<int> geometryPointsToMove);
 
    GNEMoveOperation(GNEMoveElement* moveElement,
                     const GNELane* lane,
                     const double firstPosition,
                     const bool allowChangeLane);
 
    GNEMoveOperation(GNEMoveElement* moveElement,
                     const GNELane* lane,
                     const double firstPosition,
                     const double lastPosition,
                     const bool allowChangeLane,
                     const OperationType operationType);
 
    GNEMoveOperation(GNEMoveElement* moveElement,
                     const GNELane* firstLane,
                     const double firstStartPos,
                     const GNELane* lastLane,
                     const double lastStartPos,
                     const bool allowChangeLane,
                     const OperationType operationType);
 
    ~GNEMoveOperation();
 
    GNEMoveElement* moveElement;
 
    const PositionVector originalShape;
 
    const std::vector<int> originalGeometryPoints;
 
    const GNELane* firstLane = nullptr;
 
    const double firstPosition = INVALID_DOUBLE;
 
    const GNELane* lastLane = nullptr;
 
    const double lastPosition = INVALID_DOUBLE;
 
    const PositionVector shapeToMove;
 
    const std::vector<int> geometryPointsToMove;
 
    const bool allowChangeLane;
 
    const bool firstGeometryPoint;
 
    const OperationType operationType;
 
private:
    GNEMoveOperation(const GNEMoveOperation&) = delete;
 
    GNEMoveOperation& operator=(const GNEMoveOperation&) = delete;
};
 
class GNEMoveOffset {
 
public:
    GNEMoveOffset();
 
    GNEMoveOffset(const double x, const double y);
 
    GNEMoveOffset(const double z);
 
    ~GNEMoveOffset();
 
    const double x;
 
    const double y;
 
    const double z;
};
 
class GNEMoveResult {
 
public:
    GNEMoveResult(const GNEMoveOperation* moveOperation);
 
    ~GNEMoveResult();
 
    void clearLanes();
 
    PositionVector shapeToUpdate;
 
    std::vector<int> geometryPointsToMove;
 
    const GNEMoveOperation::OperationType operationType;
 
    double firstLaneOffset;
 
    const GNELane* newFirstLane;
 
    double newFirstPos;
 
    double lastLaneOffset;
 
    const GNELane* newLastLane;
 
    double newLastPos;
 
private:
    GNEMoveResult(const GNEMoveResult&) = delete;
};
 
 
class GNEMoveElement {
 
public:
    GNEMoveElement();
 
    virtual ~GNEMoveElement() {}
 
    virtual GNEMoveOperation* getMoveOperation() = 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);
 
protected:
    double myMoveElementLateralOffset;
 
    GNEMoveOperation* calculateMoveShapeOperation(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, const double extremFrom, const double extremTo);
 
    static void calculateMoveResult(GNEMoveResult& moveResult, const GNEViewNet* viewNet, const GNELane* lane, const double pos,
                                    const GNEMoveOffset& offset, const double extremFrom, const double extremTo);
 
    static void calculateMoveResult(GNEMoveResult& moveResult, const GNEViewNet* viewNet, const GNELane* lane, const double firstPos,
                                    const double lastPos, const GNEMoveOffset& offset);
 
    static void calculateMoveResult(GNEMoveResult& moveResult, const GNEViewNet* viewNet, const GNELane* firstLane, const double firstPos,
                                    const GNELane* lastLane, const double lastPos, 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(const GNEMoveElement&) = delete;
 
    GNEMoveElement& operator=(const GNEMoveElement&) = delete;
};