kanzi::NodeComponent Class Reference

NodeComponent is the base class for all node components. More...

#include <kanzi/core.ui/node_component/node_component.hpp>

Inheritance diagram for kanzi::NodeComponent:

Classes
class	NodeComponentSourceMessageArguments
	Base class for message arguments that are sent by a node component. More...
class	NodeComponentTargetMessageArguments
	Base class for message arguments that are sent to a node component. More...

Public Types
enum	State { StateDetached, StateDetaching, StateAttaching, StateAttached }
	State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
typedef NodeComponentTargetMessageArguments	NodeComponentMessageArguments
	Legacy name for NodeComponentTargetMessageArguments. More...
Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
virtual	~NodeComponent ()
	Destructor. More...
void	setName (string_view name)
	Sets the name of node component. More...
string	getName () const
	Gets the name of node component. More...
NodeSharedPtr	getNode () const
	Returns the node the node component is attached to or null pointer if node component is not attached to a node. More...
void	attach (NodeWeakPtr node)
	Attaches node component to node. More...
void	detach ()
	Detaches node component from the node it was attached to. More...
State	getState () const
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
bool	isAttaching () const
	Indicates whether node component is in the process of attaching to a node. More...
bool	isAttached () const
	Indicates whether node component is attached to a node. More...
bool	isAttachingOrAttached () const
	Indicates whether node component is in the process of attaching to a node or already attached. More...
bool	isDetaching () const
	Indicates whether node component currently detaching from the node. More...
bool	isDetached () const
	Indicates whether node component is detached from any node. More...
bool	isDetachingOrDetached () const
	Indicates whether node component is in the process of detaching from the node or already detached. More...
Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)
virtual	~Object ()
Domain *	getDomain () const
	Returns the domain the object belongs to. More...
KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...
KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...
virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	applyObjectStyles ()
	Apply all styles for an object node. More...
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...
Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...
Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()
virtual	~PropertyObject ()
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...
void	removeKzbProperties ()
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...
template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...
virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
void	validatePropertyModifiers (AbstractPropertyType propertyType)
template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
static PropertyType< string >	NameProperty
	Name property specifies the name of node component. More...

Protected Member Functions
	NodeComponent (Domain *domain, string_view name)
	Constructor. More...
virtual void	attachOverride ()
	NodeComponent calls this function during attaching of node component to a node. More...
virtual void	detachOverride ()
	NodeComponent calls this function during detaching of node component from a node. More...
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, TClass *nodeComponent, TMethod method)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More...
void	removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
	Removes message handler added via addNodeComponentMessageHandler function. More...
template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More...
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()
void	initialize ()
Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...
PropertyStorageContainer::iterator	beginPropertyStorage ()
PropertyStorageContainer::iterator	endPropertyStorage ()
virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
void	onCopy (const PropertyObject &other)

Static Protected Member Functions
template<typename TMessageType , typename TClass , typename TMethod >
static void	nodeComponentMessageHandler (TClass *nodeComponent, TMethod method, typename TMessageType::ArgumentsType &messageArguments)
	Handler function for node component messages. More...

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

NodeComponent is the base class for all node components.

Node component is an isolated piece of logic which can be attached to any node in order to add additional functionality to it. Examples of node component could be Trigger which performs specific actions when certain conditions are met or AnimationPlayer which animates specific properties of the node it is attached to and its child nodes.

Node component can only be attached to a single node at a time. After node component is detached from one node, it can be attached to any other node.

Node component starts to perform its logic after it is attached to a certain node by calling its attach() function. After node component is detached from its node by calling its detach() function it becomes inactive and stops to perform its logic.

Member Typedef Documentation

typedef NodeComponentTargetMessageArguments kanzi::NodeComponent::NodeComponentMessageArguments

Legacy name for NodeComponentTargetMessageArguments.

Deprecated:

In Kanzi 3.6.10. Use NodeComponentTargetMessageArguments instead.

Member Enumeration Documentation

enum kanzi::NodeComponent::State

State indicating if component is attached to a node, detached from any node or in process of attaching/detaching.

Enumerator
StateDetached	Indicates node component detached from any node.
StateDetaching	Indicates node component in progress of detaching from the node.
StateAttaching	Indicates node component in progress of attaching to a node.
StateAttached	Indicates node component attached to a node.

Constructor & Destructor Documentation

virtual kanzi::NodeComponent::~NodeComponent ( )

virtual

Destructor.

kanzi::NodeComponent::NodeComponent ( Domain *  domain, string_view  name  )

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name of node component.

Member Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::NodeComponent::makeEditorInfo ( )

static

void kanzi::NodeComponent::setName

(

string_view

name

)

Sets the name of node component.

Parameters

name	Name of node component.

string kanzi::NodeComponent::getName

(

)

const

Gets the name of node component.

Returns

Name of node component.

NodeSharedPtr kanzi::NodeComponent::getNode

(

)

const

Returns the node the node component is attached to or null pointer if node component is not attached to a node.

Returns

Node the node component is attached to.

void kanzi::NodeComponent::attach

(

NodeWeakPtr

node

)

Attaches node component to node.

void kanzi::NodeComponent::detach

(

)

Detaches node component from the node it was attached to.

State kanzi::NodeComponent::getState

(

)

const

Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.

Returns

State of node component.

bool kanzi::NodeComponent::isAttaching

(

)

const

Indicates whether node component is in the process of attaching to a node.

Returns

true if node component is in the process of attaching, false otherwise.

bool kanzi::NodeComponent::isAttached

(

)

const

Indicates whether node component is attached to a node.

Returns

true if node component is attached, false otherwise.

bool kanzi::NodeComponent::isAttachingOrAttached

(

)

const

Indicates whether node component is in the process of attaching to a node or already attached.

Returns

true if node component is in the process of attaching or already attached, false otherwise.

bool kanzi::NodeComponent::isDetaching

(

)

const

Indicates whether node component currently detaching from the node.

Returns

true if node component currently detaching, false otherwise.

bool kanzi::NodeComponent::isDetached

(

)

const

Indicates whether node component is detached from any node.

Returns

true if node component is detached, false otherwise.

bool kanzi::NodeComponent::isDetachingOrDetached

(

)

const

Indicates whether node component is in the process of detaching from the node or already detached.

Returns

true if node component is in the process of detaching or already detached, false otherwise.

virtual void kanzi::NodeComponent::attachOverride ( )

protectedvirtual

NodeComponent calls this function during attaching of node component to a node.

Subclasses of NodeComponent can override this function to add custom logic which will be performed during node component attach. By default this function does nothing.

Reimplemented in kanzi::AnimationPlayer, kanzi::PropertyTargetInterpolator, kanzi::PropertyDrivenAnimationPlayer, kanzi::Trigger, kanzi::MessageTrigger, kanzi::OnPropertyChangedTrigger, kanzi::TimerTrigger, and kanzi::OnAttachedTrigger.

virtual void kanzi::NodeComponent::detachOverride ( )

protectedvirtual

NodeComponent calls this function during detaching of node component from a node.

Subclasses of NodeComponent can override this function to add custom logic which will be performed during node component detach. By default this function does nothing.

Reimplemented in kanzi::AnimationPlayer, kanzi::PropertyTargetInterpolator, kanzi::PropertyDrivenAnimationPlayer, kanzi::Trigger, kanzi::MessageTrigger, kanzi::OnPropertyChangedTrigger, and kanzi::TimerTrigger.

template<typename TMessageType , typename TClass , typename TMethod >

static void kanzi::NodeComponent::nodeComponentMessageHandler ( TClass *  nodeComponent, TMethod  method, typename TMessageType::ArgumentsType &  messageArguments  )

inlinestaticprotected

Handler function for node component messages.

Does target name checking from the message.

Parameters

nodeComponent	Node component the message handler function of which to call.
method	Message handler function of node component.
messageArguments	Message arguments.

template<typename TMessageType , typename TClass , typename TMethod >

Node::MessageSubscriptionToken kanzi::NodeComponent::addNodeComponentMessageHandler ( TMessageType &  messageType, TClass *  nodeComponent, TMethod  method  )

protected

Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name.

Parameters

messageType	Type of message to handle.
nodeComponent	Node component the message handler of which should be called.
method	Message handler function of node component.

Returns

Message subscription token.

void kanzi::NodeComponent::removeNodeComponentMessageFilter ( Node::MessageSubscriptionToken  subscriptionToken )

protected

Removes message handler added via addNodeComponentMessageHandler function.

Parameters

subscriptionToken

Subscription token of message handler to remove.

template<typename TArgumentsType >

void kanzi::NodeComponent::dispatchMessage ( const MessageType< TArgumentsType > &  messageType, typename MessageType< TArgumentsType >::ArgumentsType &  messageArguments  )

inlineprotected

Adds the name of the node component to the message arguments and dispatches the message to the node of the node component.

You must derive the message arguments from NodeComponentSourceMessageArguments.

Parameters

messageType	The type of the dispatched message.
messageArguments	The arguments of the dispatched message.

Member Data Documentation

PropertyType<string> kanzi::NodeComponent::NameProperty

static

Name property specifies the name of node component.

---

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

• kanzi/core.ui/node_component/node_component.hpp