GUIPerspectiveChanger.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
/****************************************************************************/
// A virtual class that allows to steer the visual output in dependence to
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/foxtools/fxheader.h>
#include <utils/geom/Boundary.h>
#include <utils/geom/Position.h>
#include "GUISUMOAbstractView.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUISUMOAbstractView;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUIPerspectiveChanger {
public:
    enum MouseState {
        MOUSEBTN_NONE = 0,
        MOUSEBTN_LEFT = 1,
        MOUSEBTN_RIGHT = 2,
        MOUSEBTN_MIDDLE = 4
    };
 
    GUIPerspectiveChanger(GUISUMOAbstractView& callBack, const Boundary& viewPort);
 
    virtual ~GUIPerspectiveChanger();
 
 
    virtual void onLeftBtnPress(void* data);
 
    virtual bool onLeftBtnRelease(void* data);
 
    virtual void onMiddleBtnPress(void* data);
 
    virtual bool onMiddleBtnRelease(void* data);
 
    virtual void onRightBtnPress(void* data);
 
    virtual bool onRightBtnRelease(void* data);
 
    virtual void onDoubleClicked(void* data);
 
    virtual void onMouseWheel(void* data);
 
    virtual void onMouseMove(void* data);
 
    virtual long onKeyPress(void* data);
 
    virtual long onKeyRelease(void* data);
 
    virtual double getRotation() const = 0;
 
    virtual double getXPos() const = 0;
 
    virtual double getYPos() const = 0;
 
    virtual double getZoom() const = 0;
 
    virtual double getZPos() const = 0;
 
    virtual double zoom2ZPos(double zoom) const = 0;
 
    virtual double zPos2Zoom(double zPos) const = 0;
 
    virtual void centerTo(const Position& pos, double radius, bool applyZoom = true) = 0;
 
    virtual void setViewport(double zoom, double xPos, double yPos) = 0;
 
    virtual void setViewportFrom(double xPos, double yPos, double zPos) = 0;
 
    virtual void setRotation(double rotation) = 0;
 
    FXint getMouseXPosition() const;
 
    FXint getMouseYPosition() const;
 
    /* @brief Adapts the viewport so that a change in canvass size keeps most of the
     * view intact (by showing more / less instead of zooming)
     * The canvass is clipped/enlarged on the left side of the screen
     *
     * @param[in] change The horizontal change in canvas size in pixels
     */
    virtual void changeCanvasSizeLeft(int change) = 0;
 
    Boundary getViewport(bool fixRatio = true);
 
    virtual void setViewport(const Boundary& viewPort);
 
protected:
    GUISUMOAbstractView& myCallback;
 
    FXint myMouseXPosition, myMouseYPosition;
 
    Boundary myViewPort;
 
 
private:
    Boundary patchedViewPort();
 
 
private:
    GUIPerspectiveChanger(const GUIPerspectiveChanger&);
 
    GUIPerspectiveChanger& operator=(const GUIPerspectiveChanger&);
};