Kanzi 4.0.0-beta2
kanzi::DebugRenderRegistry::DebugRenderStorage Class Reference

Storage class for storing visualizations used with debug rendering. More...

#include <kanzi/core.ui/node/debug_render_registry.hpp>

Inheritance diagram for kanzi::DebugRenderRegistry::DebugRenderStorage:
[legend]

Public Member Functions

 DebugRenderStorage (const DebugRenderRegistry &registry)
 Default constructor.
 
DebugVisualizationevaluateVisualization (Renderer &renderer, DebugVisualization *visualization, const shared_ptr< TNode > &sharedNode)
 Draws the stored visualization.
 
- Public Member Functions inherited from kanzi::DebugVisualizationStorage< Node, DebugRenderStorage >
void clearExpiredVisualizations ()
 Clears expired bounding visualizations.
 
 DebugVisualizationStorage ()=default
 Constructor.
 
 DebugVisualizationStorage (const DebugVisualizationStorage &)=delete
 Deleted copy constructor.
 
DebugVisualizationemplace (const shared_ptr< TNode > &sharedNode, DebugVisualizationSharedPtr sharedVisualization)
 Emplaces the visualization into the internal storage.
 
void eraseVisualization (const shared_ptr< TNode > &node)
 Erase a single visualization from the storage, if it exists.
 
void eraseVisualizations ()
 Erase all visualizations in the storage.
 
DebugVisualizationevaluateVisualizationForNode (Renderer &renderer, const shared_ptr< TNode > &sharedNode)
 Evaluates a visualization for given node.
 
DebugRenderStorage * getThisObject ()
 Gets the derived class object.
 
DebugVisualizationStorageoperator= (const DebugVisualizationStorage &)=delete
 Deleted copy operator.
 

Protected Attributes

const DebugRenderRegistrym_registry
 Registry for looking up the debug rendering functions.
 
- Protected Attributes inherited from kanzi::DebugVisualizationStorage< Node, DebugRenderStorage >
InternalDebugVisualizationStorage m_storage
 Storage for visualizations.
 

Additional Inherited Members

- Public Types inherited from kanzi::DebugVisualizationStorage< Node, DebugRenderStorage >
using InternalDebugVisualizationStorage
 Bounding visualization storage.
 
using TNode
 Node type being drawn.
 

Detailed Description

Storage class for storing visualizations used with debug rendering.

Since
Kanzi 4.0.0

Constructor & Destructor Documentation

◆ DebugRenderStorage()

kanzi::DebugRenderRegistry::DebugRenderStorage::DebugRenderStorage ( const DebugRenderRegistry & registry)
explicit

Default constructor.

Member Function Documentation

◆ evaluateVisualization()

DebugVisualization * kanzi::DebugRenderRegistry::DebugRenderStorage::evaluateVisualization ( Renderer & renderer,
DebugVisualization * visualization,
const shared_ptr< TNode > & sharedNode )

Draws the stored visualization.

Parameters
rendererRenderer to use.
visualizationVisualization to use for drawing.
sharedNodeNode the visualization is being used for.
Returns
Always nullptr.

Member Data Documentation

◆ m_registry

const DebugRenderRegistry& kanzi::DebugRenderRegistry::DebugRenderStorage::m_registry
protected

Registry for looking up the debug rendering functions.


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