kanzi::GraphicsEntry Class Reference

Base class for graphics entries. More...

#include <kanzi/core.ui/graphics3d/graphics_entry.hpp>

Inheritance diagram for kanzi::GraphicsEntry:

Public Member Functions
MaterialSharedPtr	getMaterial () const
	Gets the associated material.
Node3D *	getNode () const
	Gets the associated node.
RenderPass &	getRenderPass ()
	Gets the associated render pass.
RenderState &	getRenderState ()
	Gets the internal render state.
void	initializeState (MaterialSharedPtr sharedMaterial)
	Initialize the state of the graphics entry.
Public Member Functions inherited from kanzi::VariableBindingHost
void	addAvailableVariableSource (AbstractBindingVariableSource &variableSource)
	Add a variable source to the list of available sources.
void	addBindingRuntime (AbstractBindingRuntimeSharedPtr bindingRuntime)
	Adds a binding runtime to the list of binding runtimes.
void	addVariableTarget (VariableBindingTargetRuntime &targetRuntime)
	Adds variable binding target runtime into the variable host.
BindingRuntimeIterator	beginBindingRuntimes ()
	Gets an iterator to the beginning of binding runtimes.
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Gets an iterator to the beginning of binding runtimes.
BindingRuntimeIterator	endBindingRuntimes ()
	Gets an iterator to the end of binding runtimes.
BindingRuntimeConstIterator	endBindingRuntimes () const
	Gets an iterator to the end of binding runtimes.
BindingRuntimeIterator	endFixedRuntimes ()
	Gets an iterator to the end of fixed binding runtimes.
BindingRuntimeConstIterator	endFixedRuntimes () const
	Gets an iterator to the end of fixed binding runtimes.
VariableBindingTargetRuntime *	getVariableBindingTargetRuntime (AbstractPropertyType propertyType)
	Gets an existing variable binding target runtime based on a property type.
void	removeAvailableVariableSource (AbstractBindingVariableSource &variableSource)
	Remove a variable source from the list of available sources.
void	removeBindingRuntime (AbstractBindingRuntime &bindingRuntime)
	Removes a binding runtime.
void	removeVariableTarget (VariableBindingTargetRuntime &targetRuntime)
	Removes a variable binding target from the variable host.
	~VariableBindingHost ()
	Destructor.

Protected Member Functions
	GraphicsEntry (RenderPass &renderPass, Node3D *node)
	Constructor.
void	updateBindingsWithFixedUniformInputs ()
	Execute all bindings needing manual execution.

Protected Attributes
Node3D *	m_node
	Pointer to source node.
RenderPass &	m_renderPass
	Base render pass.
RenderState	m_renderState
	Contained render state.

Additional Inherited Members
Public Types inherited from kanzi::VariableBindingHost
using	BindingRuntimeConstIterator
	Const iterator for binding runtimes.
using	BindingRuntimeContainer
	Binding runtime container.
using	BindingRuntimeIterator
	Iterator for binding runtimes.
using	BindingTargetMapping
	Binding target mapping.

Detailed Description

Base class for graphics entries.

Contains references to the render pass, node, and render state that are common to all graphics entries.

Since

Kanzi 4.1.0

Constructor & Destructor Documentation

GraphicsEntry()

kanzi::GraphicsEntry::GraphicsEntry ( RenderPass & renderPass, Node3D * node )

explicitprotected

Constructor.

Parameters

renderPass	Owning render pass.
node	Node associated.

Member Function Documentation

getRenderPass()

RenderPass & kanzi::GraphicsEntry::getRenderPass ( )

inline

Gets the associated render pass.

Returned render pass cannot be invalid, since the association is owned by it.

Returns

Render pass.

getNode()

Node3D * kanzi::GraphicsEntry::getNode ( ) const

inline

Gets the associated node.

Returns

Pointer to node. May be invalid if node has been destroyed.

getRenderState()

RenderState & kanzi::GraphicsEntry::getRenderState ( )

inline

Gets the internal render state.

Returns

Reference to the render state.

getMaterial()

MaterialSharedPtr kanzi::GraphicsEntry::getMaterial ( ) const

inline

Gets the associated material.

Returns

Material.

initializeState()

void kanzi::GraphicsEntry::initializeState

(

MaterialSharedPtr

sharedMaterial

)

Initialize the state of the graphics entry.

Attach render state to material. Create binding runtimes for render value bindings and attach them.

Parameters

sharedMaterial

Material to attach to.

updateBindingsWithFixedUniformInputs()

void kanzi::GraphicsEntry::updateBindingsWithFixedUniformInputs ( )

protected

Execute all bindings needing manual execution.

Used internally by the binding functions.

Member Data Documentation

m_renderPass

RenderPass& kanzi::GraphicsEntry::m_renderPass

protected

Base render pass.

The render pass owns the association, so this reference can never be invalid.

m_node

Node3D* kanzi::GraphicsEntry::m_node

protected

Pointer to source node.

If this pointer is marked as nullptr, the entry is invalid.

m_renderState

RenderState kanzi::GraphicsEntry::m_renderState

protected

Contained render state.

---

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

• kanzi/core.ui/graphics3d/graphics_entry.hpp