#include <annotationlayer.h>

Inheritance diagram for OpenSWMMVisAnnotationLayer:

Collaboration diagram for OpenSWMMVisAnnotationLayer:

Public Member Functions
	OpenSWMMVisAnnotationLayer (const QString &name=QStringLiteral("Annotations"), OpenSWMMVisWorkspace *parent=nullptr)

	~OpenSWMMVisAnnotationLayer () override

bool	addAnnotation (AnnotationTextItem *item)

bool	removeAnnotation (const QString &id)

AnnotationTextItem *	takeAnnotation (const QString &id)

AnnotationTextItem *	annotation (const QString &id) const

QVector< AnnotationTextItem * >	annotations () const

AnnotationTextItem *	annotationAtScenePos (const QPointF &scenePos) const

QJsonArray	toJson () const

void	fromJson (const QJsonArray &arr)

QString	sourceDescription () const override
	Human-readable source of this layer: a file path, a service URL, or a description for in-memory / derived layers.

QVector< QPair< QString, QString > >	extendedMetadata () const override
	Ordered key→value pairs of TYPE-SPECIFIC metadata, rendered by the Metadata tab below the common block the dialog builds itself.

void	populateScene (QGraphicsScene scene, const MapExtent &canvasExtent, const SpatialReferenceSystem canvasSRS) override
	Creates / updates QGraphicsItems representing this layer in the scene.

void	depopulateScene (QGraphicsScene *scene) override
	Removes all QGraphicsItems belonging to this layer from the scene.

void	refreshScene (QGraphicsScene scene, const MapExtent &canvasExtent, const SpatialReferenceSystem canvasSRS) override
	Smart scene refresh — updates existing items instead of destroying and recreating.

void	onCanvasCRSChanged (const SpatialReferenceSystem *newCanvasSRS) override
	Called when the user changes the canvas CRS so layers can pre-compute any CRS-dependent transform caches.

Public Member Functions inherited from OpenSWMMVisLayer
	OpenSWMMVisLayer (OpenSWMMVisWorkspace *parent)

	OpenSWMMVisLayer (const QString &name="Unlabeled Layer", OpenSWMMVisWorkspace *parent=nullptr)

virtual	~OpenSWMMVisLayer ()

QString	layerId () const
	Returns the layer's immutable unique identifier (UUID).

QString	name () const
	Returns the user-visible name of this layer.

void	setName (const QString &name)
	Sets the user-visible name.

OpenSWMMVisLayerType	layerType () const
	Returns the layer type discriminator.

bool	isVisible () const
	Returns true when this layer should be drawn.

void	setVisible (bool visible)
	Shows or hides this layer.

double	opacity () const
	Returns the layer opacity in the range [0.0, 1.0]. 0.0 = fully transparent; 1.0 = fully opaque.

void	setOpacity (double opacity)
	Sets the layer opacity. Values are clamped to [0.0, 1.0].

SpatialReferenceSystem *	srs () const
	Returns the spatial reference system for this layer, or nullptr if the layer has no known CRS.

void	setSRS (SpatialReferenceSystem *srs, bool ownsSRS=false)
	Sets (or replaces) the CRS for this layer.

QString	crsDescription () const
	Returns a human-readable summary of this layer's CRS for display in the Properties window.

MapExtent	extent () const
	Returns the layer extent in the layer's own CRS.

void	setExtent (const MapExtent &extent)
	Sets the layer spatial extent (in the layer's CRS).

virtual bool	isRasterLayer () const
	Returns true for layers that render into a raster buffer (WMS, WMTS, GISRaster) rather than populating QGraphicsItems.

virtual bool	isBasemapLayer () const
	Returns true for world-spanning basemap layers (XYZ tile providers, WMS/WMTS services covering the whole world) that should NOT be included when computing the data-driven full extent.

virtual void	render (QPainter painter, const MapExtent &extent, const QSize &imageSize, const SpatialReferenceSystem srs)
	Renders this layer's content directly into `painter`.

virtual void	fetchCache (const MapExtent &extent, const QSize &viewportSize, const SpatialReferenceSystem *srs)
	Triggers any asynchronous (or synchronous) tile/data fetch needed to populate this layer's internal cache for the given view state.

void	setViewportSize (int w, int h)
	Called by MapCanvas before refreshScene so layers can request the correct pixel dimensions for tile/image requests.

int	viewportWidth () const

int	viewportHeight () const

QVector< OpenSWMMVisLayer * >	children () const
	Returns the ordered list of child layers.

double	layerZValue () const
	Returns the z-value base assigned to this layer by the canvas. Items within the layer should use z-values relative to this.

virtual std::vector< std::unique_ptr< openswmmvis::ui::ILayerStyleSubject > >	styleSubjects ()
	Slice U-2 — return the styleable subjects for the unified LayerStyleDialog.

void	setLayerZValue (double z)
	Called by the canvas to set this layer's z-value band.

virtual OpenSWMM::Render::IFeatureRenderer *	renderer () const

virtual void	setRenderer (std::unique_ptr< OpenSWMM::Render::IFeatureRenderer >)

virtual OpenSWMM::Render::RuleList *	ruleList ()

virtual const OpenSWMM::Render::RuleList *	ruleList () const

const OpenSWMM::Render::TemporalSpec &	temporalSpec () const

void	setTemporalSpec (const OpenSWMM::Render::TemporalSpec &spec)

const OpenSWMM::Render::LabelConfig &	labelConfig () const

virtual void	setLabelConfig (const OpenSWMM::Render::LabelConfig &cfg)

const OpenSWMM::Render::MaskSpec &	maskSpec () const

void	setMaskSpec (const OpenSWMM::Render::MaskSpec &spec)

const OpenSWMM::Render::AuxiliaryStorageSpec &	auxStorageSpec () const

void	setAuxStorageSpec (const OpenSWMM::Render::AuxiliaryStorageSpec &spec)

const QVector< OpenSWMM::Render::JoinSpec > &	joins () const

void	setJoins (const QVector< OpenSWMM::Render::JoinSpec > &joins)

const OpenSWMM::Render::DiagramSpec &	diagramSpec () const

void	setDiagramSpec (const OpenSWMM::Render::DiagramSpec &spec)

OpenSWMMVisWorkspace *	workspace () const

void	setBasicAuth (const QString &username, const QString &password)
	Sets HTTP Basic authentication for all subsequent network requests.

void	setHttpHeaders (const BasemapHttpHeaders &headers)
	Sets arbitrary extra HTTP headers applied to every request.

BasemapHttpHeaders	httpHeaders () const

Additional Inherited Members
Public Types inherited from OpenSWMMVisLayer
enum	OpenSWMMVisLayerType { SWMMDefaultLayer = 0 , SWMMModelLayer = 1 , SWMMResultsLayer = 2 , SWMMGISLayer = 3 , SWMMVectorLayer = 4 , SWMMRasterLayer = 5 , SWMMImageryLayer = 6 , SWMMTabularDataLayer = 7 , SWMMTabularyTimeSeriesLayer = 8 , SWMMSubProjectLayer = 9 , SWMMWMSLayer = 10 , SWMMWMTSLayer = 11 , SWMM2DMeshLayer = 12 , SWMM2DResultsLayer = 13 , SWMMAnnotationLayer = 14 , SWMMFeatureLayer = 15 }
	Discriminator for the concrete layer class. More...

Signals inherited from OpenSWMMVisLayer
void	nameChanged (const QString &newName)

void	layerTypeChanged (OpenSWMMVisLayerType newType)

void	visibilityChanged (bool visible)

void	opacityChanged (double opacity)

void	srsChanged (SpatialReferenceSystem *newSRS)

void	extentChanged (const MapExtent &newExtent)

void	childrenChanged ()

void	repaintRequested ()

void	temporalSpecChanged (const OpenSWMM::Render::TemporalSpec &spec)

void	maskSpecChanged (const OpenSWMM::Render::MaskSpec &spec)

void	auxStorageSpecChanged (const OpenSWMM::Render::AuxiliaryStorageSpec &spec)

void	joinsChanged (const QVector< OpenSWMM::Render::JoinSpec > &joins)

void	diagramSpecChanged (const OpenSWMM::Render::DiagramSpec &spec)

void	labelConfigChanged ()

Protected Member Functions inherited from OpenSWMMVisLayer
bool	addChild (OpenSWMMVisLayer *child)

bool	removeChild (OpenSWMMVisLayer *child)

void	setLayerType (OpenSWMMVisLayerType type)

Protected Attributes inherited from OpenSWMMVisLayer
QByteArray	m_authHeader
	"Basic <base64>" or empty

BasemapHttpHeaders	m_httpHeaders
	arbitrary headers (incl. "referer")

Properties inherited from OpenSWMMVisLayer
QString	Name

bool	Visible

double	Opacity

QString	LayerId

OpenSWMMVisLayerType	LayerType

QVector< OpenSWMMVisLayer * >	Children

QString	CRS

Constructor & Destructor Documentation

◆ OpenSWMMVisAnnotationLayer()

OpenSWMMVisAnnotationLayer::OpenSWMMVisAnnotationLayer	(	const QString &	name = `QStringLiteral("Annotations")`,
		OpenSWMMVisWorkspace *	parent = `nullptr`
	)

explicit

Here is the call graph for this function:

◆ ~OpenSWMMVisAnnotationLayer()

OpenSWMMVisAnnotationLayer::~OpenSWMMVisAnnotationLayer ( )

override

Here is the call graph for this function:

Member Function Documentation

◆ addAnnotation()

bool OpenSWMMVisAnnotationLayer::addAnnotation ( AnnotationTextItem * item )

Append an existing item; takes QObject parent ownership. Returns true on success (item not null and not already in the layer). Emits repaintRequested() so the canvas updates.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ annotation()

AnnotationTextItem * OpenSWMMVisAnnotationLayer::annotation ( const QString & id ) const

Look up an annotation by id; null if absent.

Here is the caller graph for this function:

◆ annotationAtScenePos()

AnnotationTextItem * OpenSWMMVisAnnotationLayer::annotationAtScenePos ( const QPointF & scenePos ) const

Hit-test: returns the topmost annotation whose rendered bounds contain the given scene-space point, or null if none. Used by the Add Text tool to distinguish "create new" from "edit existing".

Here is the caller graph for this function:

◆ annotations()

QVector< AnnotationTextItem * > OpenSWMMVisAnnotationLayer::annotations ( ) const

inline

Snapshot of all annotations. Order is insertion order.

◆ depopulateScene()

void OpenSWMMVisAnnotationLayer::depopulateScene ( QGraphicsScene * scene )

overridevirtual

Removes all QGraphicsItems belonging to this layer from the scene.

Reimplemented from OpenSWMMVisLayer.

Here is the caller graph for this function:

◆ extendedMetadata()

QVector< QPair< QString, QString > > OpenSWMMVisAnnotationLayer::extendedMetadata ( ) const

inlineoverridevirtual

Ordered key→value pairs of TYPE-SPECIFIC metadata, rendered by the Metadata tab below the common block the dialog builds itself.

Default empty. Subclasses add only what is unique to them (e.g. a mesh: vertices / cells / edges / elevation range). QVector<QPair> preserves insertion order without a new type.

Reimplemented from OpenSWMMVisLayer.

◆ fromJson()

void OpenSWMMVisAnnotationLayer::fromJson ( const QJsonArray & arr )

Here is the call graph for this function:

◆ onCanvasCRSChanged()

void OpenSWMMVisAnnotationLayer::onCanvasCRSChanged ( const SpatialReferenceSystem * newCanvasSRS )

overridevirtual

Called when the user changes the canvas CRS so layers can pre-compute any CRS-dependent transform caches.

Parameters

newCanvasSRS The new canvas CRS.

Reimplemented from OpenSWMMVisLayer.

Here is the call graph for this function:

◆ populateScene()

void OpenSWMMVisAnnotationLayer::populateScene	(	QGraphicsScene *	scene,
		const MapExtent &	canvasExtent,
		const SpatialReferenceSystem *	canvasSRS
	)

overridevirtual

Creates / updates QGraphicsItems representing this layer in the scene.

Derived classes override this to add their items to the scene. Items should be created in scene coordinates (= map CRS coordinates) after reprojecting from the layer's native CRS.

Called by the MapCanvas when:

The layer is first added.
The canvas CRS changes (after onCanvasCRSChanged).
The layer data changes (model loaded, tile fetched, etc.).

Parameters

scene	The shared OpenSWMMVisScene to add items to.
canvasExtent	Visible extent in canvas-CRS coordinates.
canvasSRS	The CRS currently used by the MapCanvas.

Implements OpenSWMMVisLayer.

Here is the caller graph for this function:

◆ refreshScene()

void OpenSWMMVisAnnotationLayer::refreshScene	(	QGraphicsScene *	scene,
		const MapExtent &	canvasExtent,
		const SpatialReferenceSystem *	canvasSRS
	)

overridevirtual

Smart scene refresh — updates existing items instead of destroying and recreating.

Override in subclasses to provide efficient incremental updates. The default implementation calls depopulateScene() then populateScene(), which is backward-compatible but causes flicker for raster/tile layers.

Raster/WMS layers should override to keep persistent scene items and update them in-place. Vector layers should override to skip rebuilding when only the view extent has changed (items are already in scene coords).

Reimplemented from OpenSWMMVisLayer.

Here is the call graph for this function:

◆ removeAnnotation()

bool OpenSWMMVisAnnotationLayer::removeAnnotation ( const QString & id )

Remove and delete the annotation with this id. Returns true if found.

Here is the call graph for this function:

◆ sourceDescription()

QString OpenSWMMVisAnnotationLayer::sourceDescription ( ) const

inlineoverridevirtual

Human-readable source of this layer: a file path, a service URL, or a description for in-memory / derived layers.

Default empty — the dialog shows "(none)". Concrete layers override to return their real origin (e.g. modelFilePath(), resultsFilePath(), serviceUrl(), or "(generated mesh)").

Reimplemented from OpenSWMMVisLayer.

◆ takeAnnotation()

AnnotationTextItem * OpenSWMMVisAnnotationLayer::takeAnnotation ( const QString & id )

Detach the annotation with this id from the layer without deleting. Caller takes ownership. Used by undo commands.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toJson()

QJsonArray OpenSWMMVisAnnotationLayer::toJson ( ) const

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

/home/runner/work/openswmm.gui/openswmm.gui/include/layers/annotationlayer.h
/home/runner/work/openswmm.gui/openswmm.gui/src/layers/annotationlayer.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ OpenSWMMVisAnnotationLayer()

◆ ~OpenSWMMVisAnnotationLayer()

Member Function Documentation

◆ addAnnotation()

◆ annotation()

◆ annotationAtScenePos()

◆ annotations()

◆ depopulateScene()

◆ extendedMetadata()

◆ fromJson()

◆ onCanvasCRSChanged()

◆ populateScene()

◆ refreshScene()

◆ removeAnnotation()

◆ sourceDescription()

◆ takeAnnotation()

◆ toJson()