Kanzi  3.9.5
Kanzi Engine API
kanzi::RenderPropertyBindingSourceRuntime Class Reference

Runtime for RenderPropertyBindingSource. More...

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

Inheritance diagram for kanzi::RenderPropertyBindingSourceRuntime:
[legend]

Public Member Functions

string getPath () const
 Gets the path to object. More...
 
AbstractPropertyType getPropertyType () const
 Gets property type. More...
 
- Public Member Functions inherited from kanzi::BindingSourceRuntime
void attachForRead ()
 Attaches the binding source runtime for reading. More...
 
void attachForWrite ()
 Attaches the binding source runtime for writing. More...
 
BindingProcessorRuntimeConstIterator beginProcessorRuntimes () const
 Gets an iterator to the beginning of binding processors. More...
 
void createBindingProcessorRuntimes (const AbstractBinding &binding)
 Creates a processor runtime for each BindingProcessor held by the binding parameter. More...
 
void detach ()
 Detaches the binding source runtime. More...
 
BindingProcessorRuntimeConstIterator endProcessorRuntimes () const
 Gets an iterator to the end of binding processors. More...
 
AbstractBindingRuntimegetBindingRuntime () const
 Returns the source lookup context. More...
 
BindingLookupContextgetLookupContext () const
 Returns the source lookup context. More...
 
bool isConnected ()
 Indicates whether this source is connected. More...
 
bool read (Variant &value)
 Reads a value from binding source. More...
 
void setBindingRuntime (AbstractBindingRuntime &bindingRuntime)
 Sets the binding runtime. More...
 
bool write (const Variant &value)
 Writes a value to binding source. More...
 
virtual ~BindingSourceRuntime ()=default
 Destructor. More...
 

Protected Member Functions

void attachForWriteOverride () override
 BindingSourceRuntime::attachOverride() implementation. More...
 
MaterialSharedPtr getMaterial () const
 Gets the material attached to. More...
 
 RenderPropertyBindingSourceRuntime (const RenderPropertyBindingSource &source, BindingLookupContextPtr lookupContext)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
virtual void attachForReadOverride ()=0
 Implementation-dependent attach for read. More...
 
 BindingSourceRuntime (BindingLookupContextPtr lookupContext)
 Constructor. More...
 
virtual void detachOverride ()=0
 Implementation-dependent detach. More...
 
virtual bool isConnectedOverride ()=0
 Implementation-dependent connected check. More...
 
virtual bool readOverride (Variant &value)=0
 Implementation-dependent read. More...
 
virtual bool writeOverride (const Variant &value)
 Implementation-dependent write. More...
 

Protected Attributes

const RenderPropertyBindingSourcem_source
 Host binding source. More...
 
- Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this source. More...
 
BindingLookupContextPtr m_lookupContext
 Binding lookup context for wherever this binding source runtime is attached to. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors (for the source, forward direction). More...
 

Additional Inherited Members

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

Detailed Description

Runtime for RenderPropertyBindingSource.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ RenderPropertyBindingSourceRuntime()

kanzi::RenderPropertyBindingSourceRuntime::RenderPropertyBindingSourceRuntime ( const RenderPropertyBindingSource source,
BindingLookupContextPtr  lookupContext 
)
inlineexplicitprotected

Constructor.

Parameters
sourceHost object property binding source.
lookupContextLookup context for this binding source runtime.

Member Function Documentation

◆ getPath()

string kanzi::RenderPropertyBindingSourceRuntime::getPath ( ) const

Gets the path to object.

Returns
Path.

◆ getPropertyType()

AbstractPropertyType kanzi::RenderPropertyBindingSourceRuntime::getPropertyType ( ) const

Gets property type.

Returns
Property type for this source.

◆ getMaterial()

MaterialSharedPtr kanzi::RenderPropertyBindingSourceRuntime::getMaterial ( ) const
protected

Gets the material attached to.

Returns
Material the render state is using.

◆ attachForWriteOverride()

void kanzi::RenderPropertyBindingSourceRuntime::attachForWriteOverride ( )
overrideprotectedvirtual

BindingSourceRuntime::attachOverride() implementation.

Implements kanzi::BindingSourceRuntime.

Member Data Documentation

◆ m_source

const RenderPropertyBindingSource& kanzi::RenderPropertyBindingSourceRuntime::m_source
protected

Host binding source.


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