SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmmvis::trace::TraceSublayer Class Referencefinal

#include <traceanalysislayer.h>

Inheritance diagram for openswmmvis::trace::TraceSublayer:
Collaboration diagram for openswmmvis::trace::TraceSublayer:

Public Member Functions

 TraceSublayer (SWMMResultsLayer *owner, std::shared_ptr< Result > result, bool travel)
 Create an output-owned static tree row with an independently styled trace painter.
 
Kind kind () const override
 
QString id () const override
 
QString displayName () const override
 
bool isVisible () const override
 
void setVisible (bool v) override
 
qreal opacity () const override
 
void setOpacity (qreal v) override
 
bool isDynamic () const override
 
OpenSWMM::Render::SublayerStyle * style () override
 
QList< OpenSWMM::Render::LegendSymbolItem > legendSymbolItems () const override
 
QSGNode * buildOrUpdateNode (QSGNode *, const OpenSWMM::Render::SublayerContext &) override
 Decline Qt Quick scene-node rendering for this painter-based analysis.
 
TraceAnalysisLayer * layer () const
 
bool travel () const
 
- Public Member Functions inherited from OpenSWMM::Render::ISublayer
 ISublayer (QObject *parent=nullptr)
 Construct a sublayer with ordinary Qt parent ownership.
 
 ~ISublayer () override=default
 Destroy the sublayer and its QObject-owned style resources.
 
virtual Q_INVOKABLE void invalidate ()
 Public entry point hosts call to request a re-render.
 

Additional Inherited Members

- Public Types inherited from OpenSWMM::Render::ISublayer
enum  Kind {
  MarkerKind = 0 ,
  LineKind ,
  FillKind ,
  ArrowKind ,
  ColorRampFillKind ,
  IsolineKind ,
  ContourBandKind ,
  VectorGlyphKind
}
 Coarse taxonomy of sublayer paint behaviours. More...
 
- Signals inherited from OpenSWMM::Render::ISublayer
void invalidated ()
 Style or visibility changed in a way the renderer must observe.
 

Constructor & Destructor Documentation

◆ TraceSublayer()

openswmmvis::trace::TraceSublayer::TraceSublayer ( SWMMResultsLayer *  owner,
std::shared_ptr< Result >  result,
bool  travel 
)

Create an output-owned static tree row with an independently styled trace painter.

Parameters
[in]ownerRequired output QObject owner with stable workspace.
[in]resultRequired valid result; copied so style changes do not alter another view's Result, while immutable dataset remains shared.
[in]travelWhether this row is the expected-time view. Empty saved style then defaults node/link colour and label fields to time.
Note
Owns its TraceAnalysisLayer as a QObject child and forwards visibility/opacity/repaint to invalidate(). No engine recomputation or scene insertion occurs here.
Here is the call graph for this function:

Member Function Documentation

◆ buildOrUpdateNode()

QSGNode * openswmmvis::trace::TraceSublayer::buildOrUpdateNode ( QSGNode *  ,
const OpenSWMM::Render::SublayerContext &   
)
inlineoverridevirtual

Decline Qt Quick scene-node rendering for this painter-based analysis.

Returns
Null; the two unnamed borrowed inputs (prior node and context) are unused and prior-node ownership is unchanged.

Implements OpenSWMM::Render::ISublayer.

◆ displayName()

QString openswmmvis::trace::TraceSublayer::displayName ( ) const
overridevirtual
Returns
Translated flow/time description, seed ID/direction and partial-report suffix from the immutable dataset.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ id()

QString openswmmvis::trace::TraceSublayer::id ( ) const
overridevirtual
Returns
Owned trace:<result-id>:time-or-flow identity; recalculated from the current painter result.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:

◆ isDynamic()

bool openswmmvis::trace::TraceSublayer::isDynamic ( ) const
inlineoverridevirtual
Returns
False because saved analysis values are static, independent of animation frame.

Implements OpenSWMM::Render::ISublayer.

◆ isVisible()

bool openswmmvis::trace::TraceSublayer::isVisible ( ) const
inlineoverridevirtual
Returns
Current owned painter visibility.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ kind()

Kind openswmmvis::trace::TraceSublayer::kind ( ) const
inlineoverridevirtual
Returns
LineKind for this aggregate tree row, despite its painter also rendering nodes/labels.

Implements OpenSWMM::Render::ISublayer.

◆ layer()

TraceAnalysisLayer * openswmmvis::trace::TraceSublayer::layer ( ) const
inline
Returns
Borrowed owned trace painter; callers must not delete it or outlive this tree row.
Here is the caller graph for this function:

◆ legendSymbolItems()

QList< LegendSymbolItem > openswmmvis::trace::TraceSublayer::legendSymbolItems ( ) const
overridevirtual
Returns
Owned combined heading/link/node legend rows with every row ID rewritten to this aggregate trace sublayer ID.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:

◆ opacity()

qreal openswmmvis::trace::TraceSublayer::opacity ( ) const
inlineoverridevirtual
Returns
Current owned painter opacity.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:

◆ setOpacity()

void openswmmvis::trace::TraceSublayer::setOpacity ( qreal  v)
inlineoverridevirtual
Parameters
[in]vPainter opacity forwarded to its base setter, which clamps to[0,1].
Note
Effective changes forward invalidation; no data recalculation.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:

◆ setVisible()

void openswmmvis::trace::TraceSublayer::setVisible ( bool  v)
inlineoverridevirtual
Parameters
[in]vNew painter-layer visibility forwarded to its base setter.
Note
Effective changes forward invalidation through the layer visibility connection; no source data is changed.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:

◆ style()

OpenSWMM::Render::SublayerStyle * openswmmvis::trace::TraceSublayer::style ( )
inlineoverridevirtual
Returns
Borrowed painter-owned TraceStyle; lifetime follows this sublayer.

Implements OpenSWMM::Render::ISublayer.

Here is the call graph for this function:

◆ travel()

bool openswmmvis::trace::TraceSublayer::travel ( ) const
inline
Returns
Immutable flag selecting time versus flow presentation identity.
Here is the caller graph for this function:

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