OpenSWMMVisMapToolAddSubcatchment Class Reference

Click-to-place polygon vertices; double-click to close and commit. More...

#include <maptooladdsubcatchment.h>

Inheritance diagram for OpenSWMMVisMapToolAddSubcatchment:

Collaboration diagram for OpenSWMMVisMapToolAddSubcatchment:

Signals
void	subcatchmentAdded (const QString &name)
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
	OpenSWMMVisMapToolAddSubcatchment (MapCanvas *canvas, QObject *parent=nullptr)
QCursor	cursor () const override
	Returns the mouse cursor to display while this tool is active.
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	mouseDoubleClickEvent (QMouseEvent *event) override
void	keyPressEvent (QKeyEvent *event) override
void	paint (QPainter *painter, const MapExtent &extent, const SpatialReferenceSystem *srs) 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	mouseReleaseEvent (QMouseEvent *event)
virtual void	wheelEvent (QWheelEvent *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.

Additional Inherited Members
Protected Attributes inherited from OpenSWMMVisMapTool
QString	m_toolName
MapCanvas *	m_canvas = nullptr
Properties inherited from OpenSWMMVisMapTool
QString	toolName
QCursor	cursor
bool	active

Detailed Description

Click-to-place polygon vertices; double-click to close and commit.

Interaction:

• Left-click → add vertex; rubber-band polygon updates.
• Double-click → add the clicked point as the final vertex, then close the polygon and commit (minimum 3 vertices).
• Right-click → remove last vertex (or cancel if < 2 remain).
• Enter / Return → commit (same as double-click).
• Escape → cancel.

Constructor & Destructor Documentation

OpenSWMMVisMapToolAddSubcatchment()

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

explicit

Member Function Documentation

activate()

void OpenSWMMVisMapToolAddSubcatchment::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 OpenSWMMVisMapToolAddSubcatchment::cursor ( ) const

overridevirtual

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

Reimplemented from OpenSWMMVisMapTool.

deactivate()

void OpenSWMMVisMapToolAddSubcatchment::deactivate ( )

overridevirtual

Called by the canvas when another tool replaces this one.

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

keyPressEvent()

void OpenSWMMVisMapToolAddSubcatchment::keyPressEvent ( QKeyEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

mouseDoubleClickEvent()

void OpenSWMMVisMapToolAddSubcatchment::mouseDoubleClickEvent ( QMouseEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

mouseMoveEvent()

void OpenSWMMVisMapToolAddSubcatchment::mouseMoveEvent ( QMouseEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

mousePressEvent()

void OpenSWMMVisMapToolAddSubcatchment::mousePressEvent ( QMouseEvent *  event )

overridevirtual

Reimplemented from OpenSWMMVisMapTool.

Here is the call graph for this function:

paint()

void OpenSWMMVisMapToolAddSubcatchment::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.

Here is the call graph for this function:

subcatchmentAdded

void OpenSWMMVisMapToolAddSubcatchment::subcatchmentAdded ( const QString &  name )

signal

---

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

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