Kanzi  3.9.7
Kanzi Engine API
kanzi::TypedRenderPropertyBindingSourceRuntime< T > Class Template Reference

Runtime for render property binding source. More...

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

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

Public Member Functions

 ~TypedRenderPropertyBindingSourceRuntime ()
 Destructor. More...
 
- Public Member Functions inherited from kanzi::RenderPropertyBindingSourceRuntime
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
 Gets the binding runtime. More...
 
BindingLookupContextgetLookupContext () const
 Gets the 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...
 

Static Public Member Functions

static BindingSourceRuntimePtr create (const RenderPropertyBindingSource &source)
 Create a new render property binding source runtime. More...
 

Protected Types

using ObjectPropertyListenerType = ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
 Type name for object property listener. More...
 

Protected Member Functions

void attachForReadOverride () override
 BindingSourceRuntime::attachForReadOverride() implementation. More...
 
void attachMaterialListener ()
 Attach material listener. More...
 
void detachMaterialListener ()
 Detach material listener. More...
 
void detachOverride () override
 BindingSourceRuntime::detachOverride() implementation. More...
 
bool isConnectedOverride () override
 BindingSourceRuntime::isConnectedOverride() implementation. More...
 
void localPropertyChange () override
 ObjectPropertyListenerImpl::localPropertyChange() implementation. More...
 
bool readOverride (Variant &value) override
 BindingSourceRuntime::readOverride() implementation. More...
 
 TypedRenderPropertyBindingSourceRuntime (const RenderPropertyBindingSource &source)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::RenderPropertyBindingSourceRuntime
void attachForWriteOverride () override
 BindingSourceRuntime::attachOverride() implementation. More...
 
MaterialSharedPtr getMaterial () const
 Gets the material attached to. More...
 
 RenderPropertyBindingSourceRuntime (const RenderPropertyBindingSource &source)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::BindingSourceRuntime
 BindingSourceRuntime ()=default
 Constructor. More...
 
virtual bool writeOverride (const Variant &value)
 Implementation-dependent write. More...
 
- Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
void attachLocalPropertyListener (PropertyObjectSharedPtr object, AbstractPropertyType propertyType)
 Installs local property listener. More...
 
void clearLocalPropertyListener ()
 Clears the property listener object. More...
 
void detachLocalPropertyListener (AbstractPropertyType propertyType)
 Uninstalls local property listener. More...
 
PropertyObjectSharedPtr getLocalPropertyListenerObject () const
 Gets the property object with a local property listener installed. More...
 
bool isLocalPropertyListenerInstalled () const
 Tells whether a local property listener has been installed. More...
 
 ObjectPropertyListenerImpl ()=default
 Constructor. More...
 
 ~ObjectPropertyListenerImpl ()
 Destructor. More...
 

Static Protected Member Functions

static void materialChangeCallback (PropertyObject &, const int &, PropertyNotificationReason reason, void *data)
 Callback for material property changes. More...
 
- Static Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
static void localPropertyChangeCallback (PropertyObject &, const T &, PropertyNotificationReason reason, void *userData)
 Property change callback for object property. More...
 

Protected Attributes

bool m_materialPropertyListenerInstalled
 Is material property listener installed? More...
 
- Protected Attributes inherited from kanzi::RenderPropertyBindingSourceRuntime
const RenderPropertyBindingSourcem_source
 Host binding source. More...
 
- Protected Attributes inherited from kanzi::BindingSourceRuntime
AbstractBindingRuntimem_bindingRuntime
 Abstract binding runtime for this source. More...
 
BindingProcessorRuntimeContainer m_processorRuntimes
 Binding processors (for the source, forward direction). More...
 
- Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
PropertyObjectWeakPtr m_localPropertyListenerObject
 The object to which the local property listener has been installed. 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

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

Runtime for render property binding source.

Since
Kanzi 3.9.0

Member Typedef Documentation

Constructor & Destructor Documentation

Constructor.

Parameters
sourceHost object property binding source.
Since
Kanzi 3.9.6 Removed BindingLookupContextPtr.

Member Function Documentation

template<typename T >
static BindingSourceRuntimePtr kanzi::TypedRenderPropertyBindingSourceRuntime< T >::create ( const RenderPropertyBindingSource source)
inlinestatic

Create a new render property binding source runtime.

Parameters
sourceHost object property binding source.
Returns
Newly created typed object property binding source runtime.
Since
Kanzi 3.9.6 Removed BindingLookupContextPtr.
template<typename T >
void kanzi::TypedRenderPropertyBindingSourceRuntime< T >::attachForReadOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
void kanzi::TypedRenderPropertyBindingSourceRuntime< T >::detachOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
bool kanzi::TypedRenderPropertyBindingSourceRuntime< T >::isConnectedOverride ( )
inlineoverrideprotectedvirtual
template<typename T >
bool kanzi::TypedRenderPropertyBindingSourceRuntime< T >::readOverride ( Variant value)
inlineoverrideprotectedvirtual
template<typename T >
void kanzi::TypedRenderPropertyBindingSourceRuntime< T >::attachMaterialListener ( )
inlineprotected

Attach material listener.

template<typename T >
void kanzi::TypedRenderPropertyBindingSourceRuntime< T >::detachMaterialListener ( )
inlineprotected

Detach material listener.

template<typename T >
static void kanzi::TypedRenderPropertyBindingSourceRuntime< T >::materialChangeCallback ( PropertyObject ,
const int &  ,
PropertyNotificationReason  reason,
void *  data 
)
inlinestaticprotected

Callback for material property changes.

Parameters
reasonReason for the property change.
dataPointer to the listener.

Member Data Documentation

template<typename T >
bool kanzi::TypedRenderPropertyBindingSourceRuntime< T >::m_materialPropertyListenerInstalled
protected

Is material property listener installed?


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