Temporary debug visualization listing. More...

#include <kanzi/core.ui/application/temporary_debug_visualization_list.hpp>

Public Member Functions
DebugVisualization *	acquireVisualization (Domain *domain, const MaterialSharedPtr &material)
	Acquires the next debug visualization with the given material.

DebugVisualization *	acquireVisualization (Domain *domain, const MaterialSharedPtr &material, const PropertyType< ColorRGBA > &propertyType)
	Acquires the next debug visualization with the given material.

void	beginFrame ()
	Being rendering a new frame that requires debug visualizations.

void	endFrame ()
	End rendering a frame that required debug visualizations.

Protected Attributes
size_t	m_nextDebugVisualization
	Index of the next debug visualization.

vector< kanzi::DebugVisualizationSharedPtr >	m_visualizations
	Listing of debug visualizations to use for rendering the HUD.

Detailed Description

Temporary debug visualization listing.

Used for storing debug visualizations that need reusing in a temporary manner, but are not tied to any nodes. Needs to be reset every frame to walk through and reuse the visualization structures.

For a similar class storing based on node weak pointers, see kanzi::DebugVisualizationStorage.

Since: Kanzi 4.0.0

Member Function Documentation

◆ acquireVisualization() [1/2]

DebugVisualization * kanzi::TemporaryDebugVisualizationList::acquireVisualization	(	Domain *	domain,
		const MaterialSharedPtr &	material,
		const PropertyType< ColorRGBA > &	propertyType )

Acquires the next debug visualization with the given material.

If the visualization is not available, it is created.

Parameters

domain	Domain to use if a new visualization needs to be created.
material	Material to use.
propertyType	Color property type to use for debug visualizations.

Returns: Pointer to visualization structure found or created.

◆ acquireVisualization() [2/2]

DebugVisualization * kanzi::TemporaryDebugVisualizationList::acquireVisualization	(	Domain *	domain,
		const MaterialSharedPtr &	material )

Acquires the next debug visualization with the given material.

If the visualization is not available, it is created. StandardMaterial::EmissiveProperty is used as the property type.

Parameters

domain	Domain to use if a new visualization needs to be created.
material	Material to use.

Returns: Pointer to visualization structure found or created.

◆ beginFrame()

void kanzi::TemporaryDebugVisualizationList::beginFrame ( )

Being rendering a new frame that requires debug visualizations.

endFrame() must be called later. Resents currently used visualization index.

◆ endFrame()

void kanzi::TemporaryDebugVisualizationList::endFrame ( )

End rendering a frame that required debug visualizations.

Must be called at the end of frame if beginFrame() was called. Erase visualizations from the current last used visualization onward.

Member Data Documentation

◆ m_visualizations

vector<kanzi::DebugVisualizationSharedPtr> kanzi::TemporaryDebugVisualizationList::m_visualizations

protected

Listing of debug visualizations to use for rendering the HUD.

◆ m_nextDebugVisualization

size_t kanzi::TemporaryDebugVisualizationList::m_nextDebugVisualization

protected

Index of the next debug visualization.

At the beginning of frame, this value is reset to 0 to represent no visualizations have been used yet.

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

kanzi/core.ui/application/temporary_debug_visualization_list.hpp

Public Member Functions

Protected Attributes