Typed runtime for render property expression value source. More...

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

Inheritance diagram for kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >:

Public Member Functions
	~TypedRenderPropertyExpressionValueSourceRuntime ()
	Destructor.

Public Member Functions inherited from kanzi::RenderPropertyExpressionValueSourceRuntime
string	getPath () const
	Gets source path.

AbstractPropertyType	getPropertyType () const
	Gets property type.

Public Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
void	attach ()
	Attaches this source.

void	detach ()
	Detaches this source.

Variant &	getRegister ()
	Gets the variant from this value source.

const Variant &	getRegister () const
	Gets the variant from this value source.

virtual	~AbstractExpressionValueSourceRuntime ()
	Destructor.

Static Public Member Functions
static AbstractExpressionValueSourceRuntimePtr	create (RenderPropertyExpressionValueSource &valueSource, ExpressionBindingSourceRuntime &sourceRuntime)
	Create a typed object property expression value source runtime.

Protected Types
using	ObjectPropertyListenerType
	Type name for object property listener.

Protected Member Functions
void	attachMaterialListener ()
	Attach material listener.

void	attachOverride () override
	AbstractExpressionValueSource::attachOverride() implementation.

void	detachMaterialListener ()
	Detach material listener.

void	detachOverride () override
	AbstractExpressionValueSource::detachOverride() implementation.

void	localPropertyChange () override
	ObjectPropertyListenerImpl::localPropertyChange() implementation.

bool	readValue (const PropertyObject &object, Variant &value)
	Performs the value read for this source.

	TypedRenderPropertyExpressionValueSourceRuntime (RenderPropertyExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
	Constructor.

Protected Member Functions inherited from kanzi::RenderPropertyExpressionValueSourceRuntime
BindingLookupContext &	getLookupContext () const
	Gets the binding lookup context.

MaterialSharedPtr	getMaterial () const
	Gets the material attached to.

	RenderPropertyExpressionValueSourceRuntime (const RenderPropertyExpressionValueSource &source, ExpressionBindingSourceRuntime &host)
	Constructor.

Protected Member Functions inherited from kanzi::AbstractExpressionValueSourceRuntime
	AbstractExpressionValueSourceRuntime (ExpressionBindingSourceRuntime &host)
	Constructor.

Protected Member Functions inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
void	attachLocalPropertyListener (PropertyObjectSharedPtr object, AbstractPropertyType propertyType)
	Installs local property listener.

void	clearLocalPropertyListener ()
	Clears the property listener object.

void	detachLocalPropertyListener (AbstractPropertyType propertyType)
	Uninstalls local property listener.

PropertyObjectSharedPtr	getLocalPropertyListenerObject () const
	Gets the property object with a local property listener installed.

bool	isLocalPropertyListenerInstalled () const
	Tells whether a local property listener has been installed.

	ObjectPropertyListenerImpl ()=default
	Constructor.

	~ObjectPropertyListenerImpl ()
	Destructor.

Static Protected Member Functions
static void	materialChangeCallback (PropertyObject &, const T &, PropertyNotificationReason reason, void *data)
	Callback for material property changes.

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.

Protected Attributes
bool	m_materialPropertyListenerInstalled
	Is material property listener installed?

Protected Attributes inherited from kanzi::RenderPropertyExpressionValueSourceRuntime
const RenderPropertyExpressionValueSource &	m_source
	Create info containing settings for this source.

Protected Attributes inherited from kanzi::AbstractExpressionValueSourceRuntime
Variant	m_cachedValue
	Cached value stored.

ExpressionBindingSourceRuntime &	m_host
	Host multi binding source.

Protected Attributes inherited from kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >
PropertyObjectWeakPtr	m_localPropertyListenerObject
	The object to which the local property listener has been installed.

Detailed Description

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

Typed runtime for render property expression value source.

Since: Kanzi 3.9.0

Member Typedef Documentation

◆ ObjectPropertyListenerType

template<typename T >

using kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::ObjectPropertyListenerType

protected

Type name for object property listener.

Constructor & Destructor Documentation

◆ ~TypedRenderPropertyExpressionValueSourceRuntime()

template<typename T >

kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::~TypedRenderPropertyExpressionValueSourceRuntime ( )

inline

Destructor.

◆ TypedRenderPropertyExpressionValueSourceRuntime()

template<typename T >

kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::TypedRenderPropertyExpressionValueSourceRuntime	(	RenderPropertyExpressionValueSource &	source,
		ExpressionBindingSourceRuntime &	host )

inlineprotected

Constructor.

Parameters

source	Source for this value source runtime.
host	Host expression binding source runtime.

Member Function Documentation

◆ create()

template<typename T >

static AbstractExpressionValueSourceRuntimePtr kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::create	(	RenderPropertyExpressionValueSource &	valueSource,
		ExpressionBindingSourceRuntime &	sourceRuntime )

inlinestatic

Create a typed object property expression value source runtime.

Parameters

valueSource	Source for this value source runtime.
sourceRuntime	Host expression binding source runtime.

Returns: The created value source runtime.

◆ readValue()

template<typename T >

bool kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::readValue	(	const PropertyObject &	object,
		Variant &	value )

inlineprotected

Performs the value read for this source.

Parameters

object	Object to read from.
value	Value to write to.

Returns: True if read was successful, otherwise false.

◆ attachOverride()

template<typename T >

void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::attachOverride ( )

inlineoverrideprotectedvirtual

AbstractExpressionValueSource::attachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

◆ detachOverride()

template<typename T >

void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::detachOverride ( )

inlineoverrideprotectedvirtual

AbstractExpressionValueSource::detachOverride() implementation.

Implements kanzi::AbstractExpressionValueSourceRuntime.

◆ localPropertyChange()

template<typename T >

void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::localPropertyChange ( )

inlineoverrideprotectedvirtual

ObjectPropertyListenerImpl::localPropertyChange() implementation.

Implements kanzi::ObjectPropertyListenerImpl< T, PropertyObjectWeakPtr, PropertyObjectSharedPtr >.

◆ attachMaterialListener()

template<typename T >

void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::attachMaterialListener ( )

inlineprotected

Attach material listener.

◆ detachMaterialListener()

template<typename T >

void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::detachMaterialListener ( )

inlineprotected

Detach material listener.

◆ materialChangeCallback()

template<typename T >

static void kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::materialChangeCallback	(	PropertyObject &	,
		const T &	,
		PropertyNotificationReason	reason,
		void *	data )

inlinestaticprotected

Callback for material property changes.

Parameters

reason	Reason for the property change.
data	Pointer to the listener.

Member Data Documentation

◆ m_materialPropertyListenerInstalled

template<typename T >

bool kanzi::TypedRenderPropertyExpressionValueSourceRuntime< T >::m_materialPropertyListenerInstalled

protected

Is material property listener installed?

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

kanzi/core.ui/binding/typed_render_property_expression_value_source_runtime.hpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ObjectPropertyListenerType

Constructor & Destructor Documentation

◆ ~TypedRenderPropertyExpressionValueSourceRuntime()

◆ TypedRenderPropertyExpressionValueSourceRuntime()

Member Function Documentation

◆ create()

◆ readValue()

◆ attachOverride()

◆ detachOverride()

◆ localPropertyChange()

◆ attachMaterialListener()

◆ detachMaterialListener()

◆ materialChangeCallback()

Member Data Documentation

◆ m_materialPropertyListenerInstalled