Data and functionality required for rendering Node2D visuals. More...

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

Classes
struct	BrushState
	State associated with brush rendering. More...

Public Member Functions
tuple< QuadDescription, unsigned int >	calculateContentStretch (int contentStretch, Vector2 renderSize, Vector2 contentSize)
	Calculates foreground content stretch.

BrushRenderer *	getBackgroundBrushRenderer () const
	Gets background brush renderer.

const Geometry &	getBackgroundGeometry () const
	Gets a pointer to the background geometry.

Matrix3x3	getBackgroundLocalTransformation () const
	Gets transformation for transforming the background geometry vertex positions relative to the node top left corner.

Vector2	getBackgroundTiling () const
	Gets background tiling from brush if present.

BrushRenderer *	getForegroundBrushRenderer () const
	Gets foreground brush renderer.

const Geometry &	getForegroundGeometry () const
	Gets a pointer to the foreground geometry.

Matrix3x3	getForegroundLocalTransformation () const
	Gets transformation for transforming the foreground geometry vertex positions relative to the node top left corner.

Vector2	getForegroundTiling () const
	Gets foreground tiling from brush if present.

optional< float >	getHorizontalTilingOverride () const
	Gets the horizontal tiling override.

optional< float >	getVerticalTilingOverride () const
	Gets the vertical tiling override.

bool	isBackgoundBrushTilingDirty () const
	Returns whether the tiling of the Background Brush has changed.

bool	isBackgroundGeometryValid () const
	Indicates whether background geometry is set and is valid.

bool	isBackgroundOpaque () const
	Indicates whether background brush is present and is opaque.

bool	isForegoundBrushTilingDirty () const
	Returns whether the tiling of the Foreground Brush has changed.

bool	isForegroundGeometryValid () const
	Indicates whether foreground geometry is set and is valid.

bool	isForegroundOpaque () const
	Indicates whether foreground brush is present and is opaque.

void	onDetached ()
	Kanzi calls this function when the node that owns the visual becomes detached.

void	renderBackground (Renderer3D &renderer, const Geometry &geometry, const Matrix3x3 &transform)
	Render using background brush wrapper.

void	renderBackground (Renderer3D &renderer, const Geometry &geometry, const Matrix4x4 &transform)
	Renders using background brush.

void	renderBackground (Renderer3D &renderer, const Matrix3x3 &transform)
	Render using background brush wrapper.

void	renderBackground (Renderer3D &renderer, const Matrix4x4 &transform)
	Renders using background brush.

void	renderBackground (Renderer3D &renderer, const Matrix4x4 &transform, BrushRenderer &brushRenderer)
	Renders background using an override brush renderer.

void	renderForeground (Renderer3D &renderer, const Matrix3x3 &transform)
	Renders using foreground brush wrapper.

void	renderForeground (Renderer3D &renderer, const Matrix4x4 &transform)
	Renders using foreground brush.

void	renderForeground (Renderer3D &renderer, const Matrix4x4 &transform, BrushRenderer &brushRenderer)
	Renders foreground using an override brush renderer.

void	resetBackgroundBrush ()
	Resets background brush renderer.

void	resetBackgroundGeometry ()
	Resets outside area quad.

void	resetForegroundBrush ()
	Resets foreground brush renderer.

void	resetForegroundGeometry ()
	Resets foreground geometry.

void	restoreResources ()
	Restores resources to GPU, if applicable.

void	setBackgroundBrush (Brush *brush, Node &node)
	Creates background brush renderer.

void	setBackgroundGeometry (Domain *domain, const FrameDescription &frame)
	Creates the outside area quad.

void	setBackgroundGeometry (Domain *domain, const QuadDescription &bg, const QuadDescription &fg, unsigned int clippingResult)
	Creates the outside area quad.

void	setBackgroundGeometry (Domain *domain, const QuadDescription &quad)
	Creates a background quad.

void	setForegroundBrushRenderer (Brush *brush, Node &node)
	Creates foreground brush renderer.

void	setForegroundGeometry (Domain *domain, const QuadDescription &quad)
	Sets foreground quad with full data.

void	setHorizontalTilingOverride (optional< float > tiling)
	Sets the horizontal tiling override.

void	setVerticalTilingOverride (optional< float > tiling)
	Sets the vertical tiling override.

void	updateBlendSettings (bool selfInCompositionTarget)
	Updates brush renderers for rendering.

void	updateContentTexture (TextureSharedPtr texture)
	Updates content texture in foreground brush renderer, if it exists.

void	updateRender (optional< int > blendMode, float layoutOpacity)
	Stores rendering parameters for the brushes and selects materials.

Static Public Member Functions
static unique_ptr< NodeVisual2D >	create ()
	Creates a NodeVisual2D.

Protected Member Functions
	NodeVisual2D ()=default
	Default constructor.

Protected Attributes
BrushState	m_backgroundBrushState
	State associated with background brush rendering.

optional< int >	m_blendMode
	Saved blend mode parameter.

bool	m_brushRenderersDirty
	Brush renderer dirty flag.

BrushState	m_foregroundBrushState
	State associated with foreground brush rendering.

optional< float >	m_horizontalTilingOverride
	Optional horizontal tiling override.

float	m_layoutOpacity
	Saved opacity parameter.

bool	m_selfInCompositionTarget
	Flag that indicates whether the node is rendered to a composition target.

optional< float >	m_verticalTilingOverride
	Optional vertical tiling override.

Detailed Description

Data and functionality required for rendering Node2D visuals.

Constructor & Destructor Documentation

◆ NodeVisual2D()

kanzi::NodeVisual2D::NodeVisual2D ( )

explicitprotecteddefault

Default constructor.

Member Function Documentation

◆ create()

static unique_ptr< NodeVisual2D > kanzi::NodeVisual2D::create ( )

static

Creates a NodeVisual2D.

Returns: NodeCompositor2D unique pointer.

◆ onDetached()

void kanzi::NodeVisual2D::onDetached ( )

Kanzi calls this function when the node that owns the visual becomes detached.

◆ calculateContentStretch()

tuple< QuadDescription, unsigned int > kanzi::NodeVisual2D::calculateContentStretch	(	int	contentStretch,
		Vector2	renderSize,
		Vector2	contentSize )

Calculates foreground content stretch.

Parameters

contentStretch	Content stretch mode of type Node2D::ContentStretch.
renderSize	Render size.
contentSize	Content size.

Returns: Tuple of foreground quad and clipping result mask.

◆ renderBackground() [1/5]

void kanzi::NodeVisual2D::renderBackground	(	Renderer3D &	renderer,
		const Matrix4x4 &	transform,
		BrushRenderer &	brushRenderer )

Renders background using an override brush renderer.

Parameters

renderer	Renderer to use.
transform	Transform for the quad.
brushRenderer	Brush renderer to use.

Since: Kanzi 3.9.5

◆ renderBackground() [2/5]

void kanzi::NodeVisual2D::renderBackground	(	Renderer3D &	renderer,
		const Geometry &	geometry,
		const Matrix4x4 &	transform )

Renders using background brush.

Parameters

renderer	Renderer to use.
geometry	Quad to render.
transform	Transform for the quad.

◆ renderBackground() [3/5]

void kanzi::NodeVisual2D::renderBackground	(	Renderer3D &	renderer,
		const Geometry &	geometry,
		const Matrix3x3 &	transform )

inline

Render using background brush wrapper.

◆ renderBackground() [4/5]

void kanzi::NodeVisual2D::renderBackground	(	Renderer3D &	renderer,
		const Matrix4x4 &	transform )

Renders using background brush.

Uses background quad from visual.

Parameters

renderer	Renderer to use.
transform	Transform for the quad.

◆ renderBackground() [5/5]

void kanzi::NodeVisual2D::renderBackground	(	Renderer3D &	renderer,
		const Matrix3x3 &	transform )

inline

Render using background brush wrapper.

◆ renderForeground() [1/3]

void kanzi::NodeVisual2D::renderForeground	(	Renderer3D &	renderer,
		const Matrix4x4 &	transform,
		BrushRenderer &	brushRenderer )

Renders foreground using an override brush renderer.

Parameters

renderer	Renderer to use.
transform	Transform for the quad.
brushRenderer	Brush renderer to use.

Since: Kanzi 3.9.5

◆ renderForeground() [2/3]

void kanzi::NodeVisual2D::renderForeground	(	Renderer3D &	renderer,
		const Matrix4x4 &	transform )

Renders using foreground brush.

Parameters

renderer	Renderer to use.
transform	Transform for the quad.

◆ renderForeground() [3/3]

void kanzi::NodeVisual2D::renderForeground	(	Renderer3D &	renderer,
		const Matrix3x3 &	transform )

inline

Renders using foreground brush wrapper.

◆ restoreResources()

void kanzi::NodeVisual2D::restoreResources ( )

Restores resources to GPU, if applicable.

Since: Kanzi 3.9.5 removed renderer parameter.

◆ updateRender()

void kanzi::NodeVisual2D::updateRender	(	optional< int >	blendMode,
		float	layoutOpacity )

Stores rendering parameters for the brushes and selects materials.

Kanzi calls this function during Node2D::updateRender(). To select the materials, this function calls BrushRenderer::updateRender() on the brush renderers. Kanzi calls updateBlendSettings() later during rendering, after determining whether to composit.

Parameters

blendMode	The blend mode of the node. If the node is composited, pass nullopt.
layoutOpacity	The layout opacity of the node.

Since: Kanzi 3.9.1 added blendMode parameter.; Kanzi 3.9.6 removed foregroundOpaquenessHint parameter.; Kanzi 3.9.9 renamed from storeRenderingParameters() to updateRender() and removed foregroundTranslucencyHint parameter.

◆ updateBlendSettings()

void kanzi::NodeVisual2D::updateBlendSettings ( bool selfInCompositionTarget )

Updates brush renderers for rendering.

If no settings have changed, this call is a NOP.

Parameters

selfInCompositionTarget Whether the node is rendered to a composition target.

Since: Kanzi 3.9.9 renamed from updateBrushRenderers() to updateBlendSettings().

◆ getBackgroundBrushRenderer()

BrushRenderer * kanzi::NodeVisual2D::getBackgroundBrushRenderer ( ) const

inline

Gets background brush renderer.

◆ setBackgroundBrush()

void kanzi::NodeVisual2D::setBackgroundBrush	(	Brush *	brush,
		Node &	node )

inline

Creates background brush renderer.

Parameters

node	The node to which to attach.
brush	The brush from which to create the renderer.

Since: Kanzi 3.9.1 data type of brush parameter changed from BrushSharedPtr to Brush*.

◆ resetBackgroundBrush()

void kanzi::NodeVisual2D::resetBackgroundBrush ( )

inline

Resets background brush renderer.

◆ getForegroundBrushRenderer()

BrushRenderer * kanzi::NodeVisual2D::getForegroundBrushRenderer ( ) const

inline

Gets foreground brush renderer.

◆ setForegroundBrushRenderer()

void kanzi::NodeVisual2D::setForegroundBrushRenderer	(	Brush *	brush,
		Node &	node )

inline

Creates foreground brush renderer.

Parameters

node	The node to which to attach.
brush	The brush from which to create the renderer.

Since: Kanzi 3.9.1 data type of brush parameter changed from BrushSharedPtr to Brush*.

◆ resetForegroundBrush()

void kanzi::NodeVisual2D::resetForegroundBrush ( )

inline

Resets foreground brush renderer.

◆ getForegroundGeometry()

const Geometry & kanzi::NodeVisual2D::getForegroundGeometry ( ) const

inline

Gets a pointer to the foreground geometry.

Call this function only if you know that foreground geometry is valid.

See also: isForegroundGeometryValid()

Returns: Pointer to valid foreground geometry or nullptr.

◆ isForegroundGeometryValid()

bool kanzi::NodeVisual2D::isForegroundGeometryValid ( ) const

Indicates whether foreground geometry is set and is valid.

Returns: If foreground geometry is set and valid, true, otherwise false.

◆ setForegroundGeometry()

void kanzi::NodeVisual2D::setForegroundGeometry	(	Domain *	domain,
		const QuadDescription &	quad )

Sets foreground quad with full data.

Parameters

domain	Domain to use.
quad	The quad to set.

◆ resetForegroundGeometry()

void kanzi::NodeVisual2D::resetForegroundGeometry ( )

Resets foreground geometry.

◆ getForegroundLocalTransformation()

Matrix3x3 kanzi::NodeVisual2D::getForegroundLocalTransformation ( ) const

Gets transformation for transforming the foreground geometry vertex positions relative to the node top left corner.

Returns: Transformation for foreground geometry.

Since: Kanzi 3.9.5

◆ getBackgroundTiling()

Vector2 kanzi::NodeVisual2D::getBackgroundTiling ( ) const

Gets background tiling from brush if present.

◆ getForegroundTiling()

Vector2 kanzi::NodeVisual2D::getForegroundTiling ( ) const

Gets foreground tiling from brush if present.

◆ isBackgroundOpaque()

bool kanzi::NodeVisual2D::isBackgroundOpaque ( ) const

inline

Indicates whether background brush is present and is opaque.

◆ isForegroundOpaque()

bool kanzi::NodeVisual2D::isForegroundOpaque ( ) const

inline

Indicates whether foreground brush is present and is opaque.

◆ getBackgroundGeometry()

const Geometry & kanzi::NodeVisual2D::getBackgroundGeometry ( ) const

inline

Gets a pointer to the background geometry.

Call this function only if you know that background geometry is valid.

Returns: Pointer to valid background geometry or nullptr.

See also: isBackgroundGeometryValid()

◆ isBackgroundGeometryValid()

bool kanzi::NodeVisual2D::isBackgroundGeometryValid ( ) const

Indicates whether background geometry is set and is valid.

Returns: If background geometry is set and valid, true, otherwise false.

◆ setBackgroundGeometry() [1/3]

void kanzi::NodeVisual2D::setBackgroundGeometry	(	Domain *	domain,
		const QuadDescription &	quad )

Creates a background quad.

Parameters

domain	Domain to use.
quad	Quad description.

◆ setBackgroundGeometry() [2/3]

void kanzi::NodeVisual2D::setBackgroundGeometry	(	Domain *	domain,
		const FrameDescription &	frame )

Creates the outside area quad.

Creates a frame that does not include the foreground area.

Parameters

domain	Domain to use.
frame	The frame description to use.

◆ setBackgroundGeometry() [3/3]

void kanzi::NodeVisual2D::setBackgroundGeometry	(	Domain *	domain,
		const QuadDescription &	bg,
		const QuadDescription &	fg,
		unsigned int	clippingResult )

Creates the outside area quad.

Creates a frame that does not include the foreground area.

Parameters

domain	Domain to use.
bg	Whole background area quad.
fg	Whole foreground area quad.
clippingResult	Clipping result.

◆ resetBackgroundGeometry()

void kanzi::NodeVisual2D::resetBackgroundGeometry ( )

Resets outside area quad.

◆ getBackgroundLocalTransformation()

Matrix3x3 kanzi::NodeVisual2D::getBackgroundLocalTransformation ( ) const

Gets transformation for transforming the background geometry vertex positions relative to the node top left corner.

Returns: Transformation for background geometry.

Since: Kanzi 3.9.5

◆ updateContentTexture()

void kanzi::NodeVisual2D::updateContentTexture ( TextureSharedPtr texture )

inline

Updates content texture in foreground brush renderer, if it exists.

◆ setHorizontalTilingOverride()

void kanzi::NodeVisual2D::setHorizontalTilingOverride ( optional< float > tiling )

inline

Sets the horizontal tiling override.

This overrides the horizontal tiling set in a brush.

Parameters

tiling Horizontal tiling override to use, or nullopt to disable the override.

Since: Kanzi 3.9.5

◆ getHorizontalTilingOverride()

optional< float > kanzi::NodeVisual2D::getHorizontalTilingOverride ( ) const

inline

Gets the horizontal tiling override.

Returns: Horizontal tiling override, or nullopt if tiling override is not enabled.

Since: Kanzi 3.9.5

◆ setVerticalTilingOverride()

void kanzi::NodeVisual2D::setVerticalTilingOverride ( optional< float > tiling )

inline

Sets the vertical tiling override.

This overrides the vertical tiling set in a brush.

Parameters

tiling Vertical tiling override to use, or nullopt to disable the override.

Since: Kanzi 3.9.5

◆ getVerticalTilingOverride()

optional< float > kanzi::NodeVisual2D::getVerticalTilingOverride ( ) const

inline

Gets the vertical tiling override.

Returns: Vertical tiling override, or nullopt if tiling override is not enabled.

Since: Kanzi 3.9.5

◆ isForegoundBrushTilingDirty()

bool kanzi::NodeVisual2D::isForegoundBrushTilingDirty ( ) const

inline

Returns whether the tiling of the Foreground Brush has changed.

Returns: If Foreground Brush tiling has changed, true, otherwise false.

Since: Kanzi 3.9.9

◆ isBackgoundBrushTilingDirty()

bool kanzi::NodeVisual2D::isBackgoundBrushTilingDirty ( ) const

inline

Returns whether the tiling of the Background Brush has changed.

Returns: If Background Brush tiling has changed, true, otherwise false.

Since: Kanzi 3.9.9

Member Data Documentation

◆ m_backgroundBrushState

BrushState kanzi::NodeVisual2D::m_backgroundBrushState

protected

State associated with background brush rendering.

Since: Kanzi 3.9.5

◆ m_foregroundBrushState

BrushState kanzi::NodeVisual2D::m_foregroundBrushState

protected

State associated with foreground brush rendering.

Since: Kanzi 3.9.5

◆ m_blendMode

optional<int> kanzi::NodeVisual2D::m_blendMode

protected

Saved blend mode parameter.

Affects brush selection unless the node is composited.

Since: Kanzi 3.9.1

◆ m_layoutOpacity

float kanzi::NodeVisual2D::m_layoutOpacity

protected

Saved opacity parameter.

◆ m_selfInCompositionTarget

bool kanzi::NodeVisual2D::m_selfInCompositionTarget

protected

Flag that indicates whether the node is rendered to a composition target.

◆ m_brushRenderersDirty

bool kanzi::NodeVisual2D::m_brushRenderersDirty

protected

Brush renderer dirty flag.

◆ m_horizontalTilingOverride

optional<float> kanzi::NodeVisual2D::m_horizontalTilingOverride

protected

Optional horizontal tiling override.

Since: Kanzi 3.9.5

◆ m_verticalTilingOverride

optional<float> kanzi::NodeVisual2D::m_verticalTilingOverride

protected

Optional vertical tiling override.

Since: Kanzi 3.9.5

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

kanzi/core.ui/node/node_visual2d.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NodeVisual2D()

Member Function Documentation

◆ create()

◆ onDetached()

◆ calculateContentStretch()

◆ renderBackground() [1/5]

◆ renderBackground() [2/5]

◆ renderBackground() [3/5]

◆ renderBackground() [4/5]

◆ renderBackground() [5/5]

◆ renderForeground() [1/3]

◆ renderForeground() [2/3]

◆ renderForeground() [3/3]

◆ restoreResources()

◆ updateRender()

◆ updateBlendSettings()

◆ getBackgroundBrushRenderer()

◆ setBackgroundBrush()

◆ resetBackgroundBrush()

◆ getForegroundBrushRenderer()

◆ setForegroundBrushRenderer()

◆ resetForegroundBrush()

◆ getForegroundGeometry()

◆ isForegroundGeometryValid()

◆ setForegroundGeometry()

◆ resetForegroundGeometry()

◆ getForegroundLocalTransformation()

◆ getBackgroundTiling()

◆ getForegroundTiling()

◆ isBackgroundOpaque()

◆ isForegroundOpaque()

◆ getBackgroundGeometry()

◆ isBackgroundGeometryValid()

◆ setBackgroundGeometry() [1/3]

◆ setBackgroundGeometry() [2/3]

◆ setBackgroundGeometry() [3/3]

◆ resetBackgroundGeometry()

◆ getBackgroundLocalTransformation()

◆ updateContentTexture()

◆ setHorizontalTilingOverride()

◆ getHorizontalTilingOverride()

◆ setVerticalTilingOverride()

◆ getVerticalTilingOverride()

◆ isForegoundBrushTilingDirty()

◆ isBackgoundBrushTilingDirty()

Member Data Documentation

◆ m_backgroundBrushState

◆ m_foregroundBrushState

◆ m_blendMode

◆ m_layoutOpacity

◆ m_selfInCompositionTarget

◆ m_brushRenderersDirty

◆ m_horizontalTilingOverride

◆ m_verticalTilingOverride