Kanzi  3.9.4
Kanzi Engine API
kanzi::TypedRenderValueBindingTargetRuntime< T > Class Template Reference

Typed runtime for render value binding target. More...

#include <kanzi/core.ui/binding/typed_render_value_binding_target_runtime.hpp>

Inheritance diagram for kanzi::TypedRenderValueBindingTargetRuntime< T >:
[legend]

Public Member Functions

 ~TypedRenderValueBindingTargetRuntime ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::RenderValueBindingTargetRuntime
GlRenderStategetRenderState () const
 Gets the render state from the associated render value lookup context. More...
 
BindingRenderValueLookupContextgetRenderValueLookupContext () const
 Gets the lookup context as correct type. More...
 
string getRenderValueName () const
 Gets the name of the render value used. More...
 
- Public Member Functions inherited from kanzi::BindingTargetRuntime
void attachForRead ()
 Attaches the binding target runtime for reading. More...
 
void attachForWrite ()
 Attaches the binding target runtime for writing. More...
 
BindingProcessorRuntimeConstIterator beginProcessorRuntimes () const
 Gets an iterator to the beginning of binding processor runtimes. More...
 
void createBindingProcessorsRuntimes (const AbstractBinding &binding)
 Creates a processor runtime for each BindingProcessor held by the binding parameter. More...
 
void detach ()
 Detaches binding target runtime. More...
 
BindingProcessorRuntimeConstIterator endProcessorRuntimes () const
 Gets an iterator to the end of binding processor runtimes. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Gets the binding runtime. More...
 
BindingLookupContextgetLookupContext () const
 Accesses target lookup context. More...
 
bool isConnected ()
 Indicates whether this source is connected. More...
 
bool read (Variant &value)
 Reads a value from the binding target. More...
 
void setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
 Sets the binding runtime. More...
 
bool write (const Variant &value)
 Writes a value to the binding target. More...
 
virtual ~BindingTargetRuntime ()=default
 Destructor. More...
 

Static Public Member Functions

static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, string_view renderValueName)
 Create a render value binding target runtime. More...
 
- Static Public Member Functions inherited from kanzi::RenderValueBindingTargetRuntime
static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, PropertyDataType dataType, string_view renderValueName)
 Creates a new object render value binding target runtime. More...
 
static BindingTargetRuntimePtr create (BindingLookupContextPtr lookupContext, AbstractPropertyType propertyType)
 Creates a new object render value binding target runtime. More...
 

Protected Member Functions

GlRenderState::HandleType allocateHandle ()
 Allocates a handle from the render state. More...
 
 TypedRenderValueBindingTargetRuntime (BindingLookupContextPtr lookupContext, string_view renderValueName)
 Constructor. More...
 
bool writeOverride (const Variant &value) override
 BindingTargetRuntime::writeOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::RenderValueBindingTargetRuntime
void attachForReadOverride () override
 BindingTargetRuntime::attachForReadOverride() implementation. More...
 
void attachForWriteOverride () override
 BindingTargetRuntime::attachForWriteOverride() implementation. More...
 
void detachOverride () override
 BindingTargetRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingTargetRuntime::isConnectedOverride() implementation. More...
 
 RenderValueBindingTargetRuntime (BindingLookupContextPtr lookupContext, string_view renderValueName)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingTargetRuntime
 BindingTargetRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 
virtual bool readOverride (Variant &value)
 Implementation-dependent read. More...
 

Protected Attributes

GlRenderState::HandleType m_handle
 Handle acquired from render state. More...
 
- Protected Attributes inherited from kanzi::RenderValueBindingTargetRuntime
string m_renderValueName
 Target property type. More...
 
- Protected Attributes inherited from kanzi::BindingTargetRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this target. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding target runtime is attached to. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors runtimes (for the target, backward direction). More...
 

Additional Inherited Members

- Public Types inherited from kanzi::BindingTargetRuntime
using BindingProcessorRuntimeConstIterator = BindingProcessorRuntimeContainer::const_iterator
 Binding processor iterator type. More...
 
using BindingProcessorRuntimeContainer = vector< BindingProcessorRuntimePtr >
 Binding processor container type. More...
 

Detailed Description

template<typename T>
class kanzi::TypedRenderValueBindingTargetRuntime< T >

Typed runtime for render value binding target.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ ~TypedRenderValueBindingTargetRuntime()

Destructor.

◆ TypedRenderValueBindingTargetRuntime()

template<typename T >
kanzi::TypedRenderValueBindingTargetRuntime< T >::TypedRenderValueBindingTargetRuntime ( BindingLookupContextPtr  lookupContext,
string_view  renderValueName 
)
inlineexplicitprotected

Constructor.

Parameters
lookupContextBinding lookup context to use.
renderValueNameName of the render value to use.

Member Function Documentation

◆ create()

template<typename T >
static BindingTargetRuntimePtr kanzi::TypedRenderValueBindingTargetRuntime< T >::create ( BindingLookupContextPtr  lookupContext,
string_view  renderValueName 
)
inlinestatic

Create a render value binding target runtime.

Parameters
lookupContextBinding lookup context to use.
renderValueNameName of the render value to use.

◆ allocateHandle()

template<typename T >
GlRenderState::HandleType kanzi::TypedRenderValueBindingTargetRuntime< T >::allocateHandle ( )
inlineprotected

Allocates a handle from the render state.

Returns
Corresponding handle that can be used for writing the value.

◆ writeOverride()

template<typename T >
bool kanzi::TypedRenderValueBindingTargetRuntime< T >::writeOverride ( const Variant value)
inlineoverrideprotectedvirtual

Member Data Documentation

◆ m_handle

template<typename T >
GlRenderState::HandleType kanzi::TypedRenderValueBindingTargetRuntime< T >::m_handle
protected

Handle acquired from render state.


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