OpenSWMMVisMapToolZoom Class Reference

Tool that zooms the map canvas by rubber-band rectangle or mouse wheel. More...

#include <maptoolzoom.h>

Inheritance diagram for OpenSWMMVisMapToolZoom:

Collaboration diagram for OpenSWMMVisMapToolZoom:

Signals
void	zoomFactorChanged (double factor)
Signals inherited from OpenSWMMVisMapTool
void	cursorChanged (const QCursor &cursor)
void	activeChanged (bool active)
void	repaintRequested ()
	Emitted to instruct the canvas to repaint its overlay.

Public Member Functions
	OpenSWMMVisMapToolZoom (MapCanvas *canvas, QObject *parent=nullptr)
QCursor	cursor () const override
	Returns the mouse cursor to display while this tool is active.
double	zoomFactor () const
	Returns the wheel-scroll zoom factor (default 2.0).
void	setZoomFactor (double factor)
bool	zoomInMode () const
	Returns true if the tool always zooms in on left-click (default true).
void	setZoomInMode (bool zoomIn)
void	activate () override
	Called by the canvas when this tool becomes the active tool.
void	deactivate () override
	Called by the canvas when another tool replaces this one.
void	mousePressEvent (QMouseEvent *event) override
void	mouseMoveEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override
void	wheelEvent (QWheelEvent *event) override
void	paint (QPainter *painter, const MapExtent &canvasExtent, const SpatialReferenceSystem *canvasSRS) override
	Called by the canvas in drawForeground() so the tool can draw transient overlay graphics (rubber-band, measure segments, etc.).
Public Member Functions inherited from OpenSWMMVisMapTool
	OpenSWMMVisMapTool (const QString &toolName, MapCanvas *canvas, QObject *parent=nullptr)
virtual	~OpenSWMMVisMapTool ()=default
QString	toolName () const
	Returns the human-readable name of this tool.
bool	isActive () const
	Returns true when this tool is the active tool on its canvas.
MapCanvas *	canvas () const
	Returns the MapCanvas this tool is attached to.
virtual void	mouseDoubleClickEvent (QMouseEvent *event)
virtual void	keyPressEvent (QKeyEvent *event)
virtual void	keyReleaseEvent (QKeyEvent *event)
QGraphicsScene *	scene () const
	Returns the scene this tool's canvas is using.
void	toMapCoords (int px, int py, double &mapX, double &mapY) const
	Converts a widget pixel position to map coordinates.
void	toPixelCoords (double mapX, double mapY, int &px, int &py) const
	Converts map coordinates to widget pixel position.

Properties
double	zoomFactor
bool	zoomInMode
Properties inherited from OpenSWMMVisMapTool
QString	toolName
QCursor	cursor
bool	active

Additional Inherited Members
Protected Attributes inherited from OpenSWMMVisMapTool
QString	m_toolName
MapCanvas *	m_canvas = nullptr

Detailed Description

Tool that zooms the map canvas by rubber-band rectangle or mouse wheel.

Left-click-drag draws a rubber-band rectangle; releasing zooms in to fit that rectangle. Right-click-drag zooms out. The scroll wheel zooms about the cursor position by a configurable factor (default ×2). Each zoom operation pushes an undo command so the user can reverse it.

Constructor & Destructor Documentation

OpenSWMMVisMapToolZoom()

OpenSWMMVisMapToolZoom::OpenSWMMVisMapToolZoom ( MapCanvas *  canvas, QObject *  parent = nullptr  )

explicit

Member Function Documentation

activate()

void OpenSWMMVisMapToolZoom::activate ( )

overridevirtual

Called by the canvas when this tool becomes the active tool.

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

cursor()

QCursor OpenSWMMVisMapToolZoom::cursor ( ) const

overridevirtual

Returns the mouse cursor to display while this tool is active.

Reimplemented from OpenSWMMVisMapTool.

deactivate()

void OpenSWMMVisMapToolZoom::deactivate ( )

overridevirtual

Called by the canvas when another tool replaces this one.

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

mouseMoveEvent()

void OpenSWMMVisMapToolZoom::mouseMoveEvent ( QMouseEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

mousePressEvent()

void OpenSWMMVisMapToolZoom::mousePressEvent ( QMouseEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

mouseReleaseEvent()

void OpenSWMMVisMapToolZoom::mouseReleaseEvent ( QMouseEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

paint()

void OpenSWMMVisMapToolZoom::paint ( QPainter *  painter, const MapExtent &  canvasExtent, const SpatialReferenceSystem *  canvasSRS  )

overridevirtual

Called by the canvas in drawForeground() so the tool can draw transient overlay graphics (rubber-band, measure segments, etc.).

Override this to paint tool overlays directly via QPainter in view coordinates.

Reimplemented from OpenSWMMVisMapTool.

setZoomFactor()

void OpenSWMMVisMapToolZoom::setZoomFactor

(

double

factor

)

Here is the call graph for this function:

setZoomInMode()

void OpenSWMMVisMapToolZoom::setZoomInMode

(

bool

zoomIn

)

Here is the caller graph for this function:

wheelEvent()

void OpenSWMMVisMapToolZoom::wheelEvent ( QWheelEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

zoomFactor()

double OpenSWMMVisMapToolZoom::zoomFactor

(

)

const

Returns the wheel-scroll zoom factor (default 2.0).

zoomFactorChanged

void OpenSWMMVisMapToolZoom::zoomFactorChanged ( double  factor )

signal

Here is the caller graph for this function:

zoomInMode()

bool OpenSWMMVisMapToolZoom::zoomInMode

(

)

const

Returns true if the tool always zooms in on left-click (default true).

Property Documentation

zoomFactor

double OpenSWMMVisMapToolZoom::zoomFactor

readwrite

zoomInMode

bool OpenSWMMVisMapToolZoom::zoomInMode

readwrite

---

The documentation for this class was generated from the following files:

• /home/runner/work/openswmm.gui/openswmm.gui/include/map/tools/maptoolzoom.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/map/tools/maptoolzoom.cpp