The base class for the Kanzi input manipulators. More...

#include <kanzi/core.ui/input/input_manipulator.hpp>

Inheritance diagram for kanzi::InputManipulator:

Classes
struct	Collection
	Common functions of collections of attached InputManipulators processing a specific input event type. More...

class	InputMessageArguments
	Message arguments for input manipulator messages. More...

class	KeyInputMessageArguments
	Represents base message arguments for key input messages. More...

struct	TouchInfo
	Structure to hold the state of the current touch points. More...

Public Types
enum	EventRoutingMode { RoutingBubbling, RoutingTunneling }
	Enumeration for the available input event routing modes. More...

enum	ManipulatorType { ManipulatorType::TouchInputHandler, ManipulatorType::KeyInputHandler }
	Enumeration for the input manipulator type. More...

enum	State { StateReady, StatePossible, StateBegin, StateChange, StateEnd, StateFail, StateDelayed, StateCanceled }
	Enumeration for possible input manipulator states during touch, mouse, or key input sequence. More...

using	TouchEventRoutingMode = EventRoutingMode
	Enumeration for the available touch event routing modes. More...

using	TouchPointsConstIterator = TouchPointsContainer::const_iterator

using	TouchPointsContainer = vector< TouchPoint * >

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
void	attach (Node &node)
	Attaches an input manipulator to a node. More...

void	cancel ()
	Notify manipulator of touch canceling. More...

void	detach ()
	Detaches an input manipulator. More...

Node *	getAttachedNode () const
	Gets the node to which the input manipulator is attached. More...

InputManipulator *	getDependantManipulator () const
	Gets the dependant input manipulator. More...

EventRoutingMode	getEventRoutingMode ()
	Returns the current input event routing mode. More...

InputManipulatorWeakPtr	getFailManipulator () const
	Gets the fail manipulator. More...

State	getState () const
	Get the state of an input manipulator. More...

KZ_DEPRECATED TouchEventRoutingMode	getTouchEventRoutingMode ()
	Returns the current touch event routing mode. More...

ManipulatorType	getType () const
	Returns the type of the input manipulator. More...

bool	isActive () const
	Checks whether an input manipulator is in active state. More...

bool	isAttached () const
	Tells whether the input manipulator is attached to a node. More...

bool	isCancelable () const
	Returns whether an input manipulator is in a cancelable state. More...

bool	isResettable () const
	Returns whether an input manipulator is in a resettable state. More...

void	requireToFail (InputManipulatorWeakPtr manipulatorToFail)
	Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. More...

void	reset ()
	Reset the manipulator. More...

void	setEventRoutingMode (EventRoutingMode mode)
	Sets the input event routing mode that you want the input manager to use when distributing the input event data to manipulators. More...

void	setReferenceNode (NodeWeakPtr referenceNode)
	Override the attached node as the hit test reference node. More...

void	setState (State state)
	Set the state of an input manipulator. More...

KZ_DEPRECATED void	setTouchEventRoutingMode (TouchEventRoutingMode mode)
	Sets the touch event routing mode that you want the input manager to use when distributing the touch points to input manipulators. More...

	~InputManipulator () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

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

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 >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, 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	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. 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 >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. 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...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Protected Member Functions
void	addHitTestArguments (MessageArguments &message, const TouchPoint &touchPoint)
	Add hit test information arguments to the message from the touch point. More...

bool	detectKeyGesture (const KeyEvent &event, KeyGestureInfo &gesture)
	Detects key gestures from the event that you pass as an argument. More...

Node2D *	findNearestParent2D ()
	Find the 2D manipulator node for this input manipulator. More...

InputManager *	getInputManager () const
	Get the attached input manager of an input manipulator. More...

	InputManipulator (Domain *domain, ManipulatorType type=ManipulatorType::TouchInputHandler)
	Constructor. More...

virtual bool	isCancelableOverride () const
	Overridable check for the cancelable status of an input manipulator. More...

virtual bool	isResettableOverride () const
	Overridable check for the resettable status of an input manipulator. More...

void	markTouchPointConsumed (const TouchPoint &touchPoint)
	Marks the passed touch point handled. More...

virtual bool	notifyKeyInput (const KeyEvent &event)
	Notify an input manipulator about a key event that occurs on the attached node. More...

virtual void	notifyTouchInside (const TouchInfo &touchInfo)
	Notify an input manipulator about touch events that occur inside the subtree of the input manipulator. More...

virtual void	notifyTouchOutside (const TouchInfo &touchInfo)
	Notify an input manipulator about touch events that occur outside the subtree of the input manipulator. More...

virtual void	onAttach ()
	Attach function for input manipulators. More...

virtual void	onCancel ()
	Cancel function for input manipulators. More...

virtual void	onDetach ()
	Detach function for input manipulators. More...

virtual void	onFail ()
	Fail function for input manipulators. More...

virtual void	onKeyPressGesture (KeyGestureInfo &gesture)
	The detectKeyGesture() method calls this method when it detects a key press gesture. More...

virtual void	onKeyReleaseGesture (KeyGestureInfo &gesture)
	The detectKeyGesture() method calls this method when it detects a key release gesture. More...

virtual void	onPartialKeyPressGesture (KeyGestureInfo &gesture)
	The detectKeyGesture() method calls this method when it detects a partial key press gesture. More...

virtual void	onReset ()
	Reset function for input manipulators. Kanzi calls this method when an input manipulator is reset. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Additional Inherited Members
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...

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

The base class for the Kanzi input manipulators.

Use the input manipulators to recognize gestures, such as click or pinch, or hardware key gestures from incoming events. Kanzi has specialized subclasses to handle touch gestures and hardware key gestures. Kanzi converts and handles mouse events as touch gestures.

To use an input manipulator on a node, add it to that node with the Node::addInputManipulator() method. You can add more than one input manipulator to a node, but you can use only one input manipulator to recognize a given gesture type. When you want to handle more than one gesture type on a node, link the input manipulators to each other in order of importance of the gestures that they recognize.

You can link input manipulators sequentially. For example, if you want a node to recognize the pan, double-click, and click gestures in this order, link the ClickManipulator to the MultiClickManipulator, and the MultiClickManipulator to the PanManipulator.

The linking of the manipulators is directional and hierarchical. The linked manipulator is called the dependant manipulator and the manipulator the dependant is linked to is called the fail manipulator. The dependant manipulator has lower priority than the fail manipulator. Lower priority manipulator succeeds only when the higher priority manipulators fail to recognize a gesture. You can link the two manipulators by calling requireToFail() on the dependant manipulator, passing the fail manipulator as argument.

To receive both click and multi-click messages on a node, you need to configure the click manipulator to wait for the failure of the multi-click manipulator:

        ClickManipulatorSharedPtr clickManipulator = ClickManipulator::create(domain);
        node->addInputManipulator(clickManipulator);
        MultiClickManipulatorSharedPtr doubleClickManipulator =
            MultiClickManipulator::create(domain);
        node->addInputManipulator(doubleClickManipulator);
        doubleClickManipulator->setClickCount(2);
        MultiClickManipulatorSharedPtr tripleClickManipulator =
            MultiClickManipulator::create(domain);
        tripleClickManipulator->setClickCount(3);
        node->addInputManipulator(tripleClickManipulator);
        // Configure the click manipulator to wait for the failure of the double-click manipulator.
        clickManipulator->requireToFail(doubleClickManipulator);
        // Configure the double-click manipulator to wait for the failure of the triple-click manipulator
        doubleClickManipulator->requireToFail(tripleClickManipulator);

If the dependant manipulator supports delay, when it recognizes a gesture and the fail manipulator has not finished recognizing a gesture, the dependant manipulator sets its own state to StateDelayed. When an input manipulator is in the StateDelayed state, it stops handling events and waits until the fail manipulator finishes recognizing its gesture.

If the fail manipulator fails, Kanzi calls the onFail() of the dependant manipulator. In that case the onFail() method generates the message that was delayed. If the fail manipulator succeeds, Kanzi cancels the dependant manipulator.

To add delay functionality to your own input manipulators, when that input manipulator recognizes a gesture and there is an input manipulator on which your input manipulator depends, your input manipulator must first enter the StateDelayed state. In this case, do not send any messages. When the fail manipulator fails, Kanzi calls the onFail() on your input manipulator. Use this method to send delayed messages. When the fail manipulator succeeds, Kanzi cancels your input manipulator.

You can cancel an input manipulator after it enters one of the following states: -StatePossible -StateBegin -StateChange -StateDelayed.

When you cancel an input manipulator, that input manipulator:

Stops receiving gesture recognition
Enters the StateCanceled state
Calls the onCancel() method
Enters the StateReady state

Kanzi cancels an input manipulator when:

You call cancel()
One of the other input manipulators that are attached to the same node enter one of these states:
An input manipulator is in one of these states and you call reset():
- StateBegin
- StateChange
- StateEnd. Kanzi first cancels and then resets the input manipulator.

Gesture recognition

Kanzi dispatches the incoming event data to manipulators attached to nodes in phases:

Kanzi tunnels the event data to nodes starting from the root node and ending at the hit test node or at the focus node. In this phase only the input manipulators that have the RoutingTunneling routing mode set receive the event data for recognition.
Kanzi continues to bubble the event data from the hit test or focus node node to the root node, updating the nodes with input manipulators that have the RoutingBubbling routing mode set.
Kanzi updates the input manipulators that are outside of the hierarchy of the hit test or active focus node.

The touch gesture recognition happens in the notifyTouchInside() or notifyTouchOutside() methods of an input manipulator. Every input manipulator attached to a hit test node receives all the touch points that occurred in the application. In each input manipulator you must set the correct state to inform Kanzi that the input manipulator recognized a gesture. You do this by calling the setState() method with the appropriate State value.

When an input manipulator recognizes a touch event as a starting action of a gesture:

The input manipulator enters the StatePossible state. Usually every input manipulator takes the first touch point as a possible starting point of the gesture it recognizes. In this phase, every input manipulator in the StatePossible state receives the touch event.
When the input manipulator recognizes the incoming touch event as a comprehensive gesture, depending on the type of the gesture, this input manipulator sets its state to either StateBegin, StateEnd, or StateFail state.
Input manipulators which recognize gestures where the touch point location is not changing, such as click or multi-click, and gestures where the touch location is updated, set the state to StateEnd.
If the gesture recognition fails, input manipulators set the StateFail state value. It is important that you mark the gesture recognition failure in the failing input manipulator. This enables Kanzi to continue dispatching the touch event to the dependant input manipulators. Kanzi calls onFail() method on the dependant input manipulator linked, continuing the gesture recognition in that input manipulator.

Key gesture recognition happens in the notifyKeyInput() method of an input manipulator. Every input manipulator attached to a node that is the focus node of the ascendant node of the focus node receives the key event. To recognize the key event as a key gesture, call the detectKeyGesture() method for each key gesture that your input manipulator handles. The method calls onPartialKeyPressGesture(), onKeyPressGesture(), and onKeyReleaseGesture() when Kanzi recognizes a key event as a partial key press gesture, a full key press gesture, or a key release gesture. A partial key press gesture usually happens with key gestures composed of a key value and key modifiers. Just like with touch gestures, in each input manipulator you must set the correct state to inform Kanzi that the input manipulator recognized a key gesture.

During and on gesture recognition, input manipulators can dispatch messages to the attached node, to inform the subscribed message handlers about the progress of the gesture.

See also: ClickManipulator, DragAndDropManipulator, LongPressManipulator, MultiClickManipulator, PanManipulator, PinchManipulator

Member Typedef Documentation

◆ TouchPointsContainer

using kanzi::InputManipulator::TouchPointsContainer = vector<TouchPoint*>

◆ TouchPointsConstIterator

using kanzi::InputManipulator::TouchPointsConstIterator = TouchPointsContainer::const_iterator

◆ TouchEventRoutingMode

using kanzi::InputManipulator::TouchEventRoutingMode = EventRoutingMode

Enumeration for the available touch event routing modes.

Deprecated:: Use InputManipulator::EventRoutingMode instead.

Member Enumeration Documentation

◆ ManipulatorType

enum kanzi::InputManipulator::ManipulatorType

strong

Enumeration for the input manipulator type.

Enumerator
TouchInputHandler	The manipulator handles touch and pointer input only.
KeyInputHandler	The manipulator handles key input only.

◆ State

enum kanzi::InputManipulator::State

Enumeration for possible input manipulator states during touch, mouse, or key input sequence.

Enumerator
StateReady	The manipulator is in initial state.
StatePossible	The manipulator started processing, but has not yet recognized a gesture. The system can fail the manipulator automatically.
StateBegin	The manipulator recognized a continuous gesture.
StateChange	The manipulator recognized changes in a continuous gesture.
StateEnd	The manipulator finished recognizing a gesture.
StateFail	The manipulator failed recognizing a gesture.
StateDelayed	The manipulator waits for the failure of its fail manipulator in order to proceed.
StateCanceled	The manipulator is canceled and no longer recognizes gestures.

◆ EventRoutingMode

enum kanzi::InputManipulator::EventRoutingMode

Enumeration for the available input event routing modes.

Enumerator
RoutingBubbling	The input event data is dispatched to the manipulators from the hit test node or the focus node to the root node.
RoutingTunneling	The input event data is dispatched to the manipulators from the root node to the hit test node or to the focus node.

Constructor & Destructor Documentation

◆ ~InputManipulator()

kanzi::InputManipulator::~InputManipulator ( )

override

Destructor.

◆ InputManipulator()

kanzi::InputManipulator::InputManipulator	(	Domain *	domain,
		ManipulatorType	type = `ManipulatorType::TouchInputHandler`
	)

explicitprotected

Constructor.

Member Function Documentation

◆ setTouchEventRoutingMode()

KZ_DEPRECATED void kanzi::InputManipulator::setTouchEventRoutingMode ( TouchEventRoutingMode mode )

inline

Sets the touch event routing mode that you want the input manager to use when distributing the touch points to input manipulators.

The default mode is RoutingBubbling.

Set the mode to RoutingTunneling when you want Kanzi to recognize an underlying gesture before the gestures in the child nodes of the node with an input manipulator. For example, use the RoutingTunneling routing mode for a node with a two-finger pan input manipulator which has a Scroll View child node. With this setting the input manager recognizes the two-finger pan before the pan in the Scroll View node.

Parameters

mode	The touch event routing mode you want the input manager to use.

See also: TouchEventRoutingMode

Deprecated:: Use setEventRoutingMode instead.

◆ getTouchEventRoutingMode()

KZ_DEPRECATED TouchEventRoutingMode kanzi::InputManipulator::getTouchEventRoutingMode ( )

inline

Returns the current touch event routing mode.

Returns: The current touch event routing mode that the input manager uses.

Deprecated:: Use getEventRoutingMode instead.

◆ getType()

ManipulatorType kanzi::InputManipulator::getType ( ) const

inline

Returns the type of the input manipulator.

Returns: The type of the input manipulator.

◆ reset()

void kanzi::InputManipulator::reset ( )

Reset the manipulator.

When you reset a manipulator, you set its state to the initial state (StateReady).

See also: isResettable()

◆ cancel()

void kanzi::InputManipulator::cancel ( )

Notify manipulator of touch canceling.

See also: isCancelable()

◆ isActive()

bool kanzi::InputManipulator::isActive ( ) const

Checks whether an input manipulator is in active state.

The active state can mean different things for individual manipulator types. You can override this method to specify when your manipulator is in active state.

Returns: If the manipulator is active, returns true, otherwise false.

Since: Kanzi 3.8.0

◆ isResettable()

bool kanzi::InputManipulator::isResettable ( ) const

Returns whether an input manipulator is in a resettable state.

When a manipulator is in resettable state, you can reset it with reset().

Returns: If the manipulator is in a resettable state, returns true, otherwise false.

Since: Kanzi 3.8.0

◆ isCancelable()

bool kanzi::InputManipulator::isCancelable ( ) const

Returns whether an input manipulator is in a cancelable state.

When a manipulator is in cancelable state, you can cancel it with cancel().

Returns: If the manipulator is in a cancelable state, returns true, otherwise false.

Since: Kanzi 3.8.0

◆ getState()

State kanzi::InputManipulator::getState ( ) const

Get the state of an input manipulator.

Returns: The current state of the input manipulator.

◆ setState()

void kanzi::InputManipulator::setState ( State state )

Set the state of an input manipulator.

Parameters

state The new state of the input manipulator.

◆ getAttachedNode()

Node* kanzi::InputManipulator::getAttachedNode ( ) const

Gets the node to which the input manipulator is attached.

Returns: The pointer to the node to which the input manipulator is attached. If the input manipulator is not attached to any node, nullptr.

◆ requireToFail()

void kanzi::InputManipulator::requireToFail ( InputManipulatorWeakPtr manipulatorToFail )

Sets the input manipulator that must fail before Kanzi can recognize this input manipulator.

Parameters

manipulatorToFail The manipulator whose failure is required in order for this manipulator to succeed.

◆ getFailManipulator()

InputManipulatorWeakPtr kanzi::InputManipulator::getFailManipulator ( ) const

Gets the fail manipulator.

Returns: The input manipulator on which this input manipulator depends.

◆ getDependantManipulator()

InputManipulator* kanzi::InputManipulator::getDependantManipulator ( ) const

Gets the dependant input manipulator.

When this input manipulator fails, Kanzi notifies the dependant input manipulator.

Returns: The manipulator object that is dependent of this manipulator.

◆ isAttached()

bool kanzi::InputManipulator::isAttached ( ) const

inline

Tells whether the input manipulator is attached to a node.

Returns: If the input manipulator is attached, true, otherwise false.

◆ setReferenceNode()

void kanzi::InputManipulator::setReferenceNode ( NodeWeakPtr referenceNode )

inline

Override the attached node as the hit test reference node.

Parameters

referenceNode The pointer to the reference node.

◆ setEventRoutingMode()

void kanzi::InputManipulator::setEventRoutingMode ( EventRoutingMode mode )

inline

Sets the input event routing mode that you want the input manager to use when distributing the input event data to manipulators.

The default mode is RoutingBubbling.

Set the mode to RoutingTunneling when you want Kanzi to recognize an underlying gesture before the gestures in the child nodes of the node with an input manipulator. For example, use the RoutingTunneling routing mode for a node with a two-finger pan input manipulator which has a Scroll View child node. With this setting the input manager recognizes the two-finger pan before the pan in the Scroll View node.

Parameters

mode	The input event routing mode you want the input manager to use.

See also: EventRoutingMode

◆ getEventRoutingMode()

EventRoutingMode kanzi::InputManipulator::getEventRoutingMode ( )

inline

Returns the current input event routing mode.

Returns: The current input event routing mode that the input manager uses.

◆ attach()

void kanzi::InputManipulator::attach ( Node & node )

Attaches an input manipulator to a node.

Kanzi calls this method when you add an input manipulator to a node.

Parameters

node	The node to which the input manipulator attaches.

Since: Kanzi 3.9.0

◆ detach()

void kanzi::InputManipulator::detach ( )

Detaches an input manipulator.

Kanzi calls this method when you remove an input manipulator from a node.

Since: Kanzi 3.9.0

◆ onAttach()

virtual void kanzi::InputManipulator::onAttach ( )

protectedvirtual

Attach function for input manipulators.

Kanzi calls this method when an input manipulator is attached to a node.

◆ onDetach()

virtual void kanzi::InputManipulator::onDetach ( )

protectedvirtual

Detach function for input manipulators.

Kanzi calls this method when an input manipulator is detached from a node.

◆ onReset()

virtual void kanzi::InputManipulator::onReset ( )

protectedvirtual

Reset function for input manipulators. Kanzi calls this method when an input manipulator is reset.

Reimplemented in kanzi::TextInputManipulator, kanzi::PanManipulator, kanzi::NavigationManipulator, kanzi::PinchManipulator, kanzi::KeyManipulator, kanzi::MultiClickManipulator, kanzi::ClickManipulator, kanzi::DragAndDropManipulator, kanzi::FocusNavigationManipulator, and kanzi::LongPressManipulator.

◆ onCancel()

virtual void kanzi::InputManipulator::onCancel ( )

protectedvirtual

Cancel function for input manipulators.

Kanzi calls this method when the gesture recognition for an input manipulator is canceled.

Reimplemented in kanzi::TextInputManipulator, kanzi::PanManipulator, kanzi::NavigationManipulator, kanzi::PinchManipulator, kanzi::KeyManipulator, kanzi::MultiClickManipulator, kanzi::ClickManipulator, kanzi::DragAndDropManipulator, kanzi::LongPressManipulator, and kanzi::FocusNavigationManipulator.

◆ isResettableOverride()

virtual bool kanzi::InputManipulator::isResettableOverride ( ) const

protectedvirtual

Overridable check for the resettable status of an input manipulator.

You can override this method to control the resettable state of your manipulator.

Returns: If the manipulator is resettable, returns true, otherwise false. The default implementation always returns true.

Since: Kanzi 3.8.0

◆ isCancelableOverride()

virtual bool kanzi::InputManipulator::isCancelableOverride ( ) const

protectedvirtual

Overridable check for the cancelable status of an input manipulator.

You can override this method to control the cancelable state of your manipulator.

Returns: If the manipulator is cancelable, returns true, otherwise false. The default implementation always returns true.

Since: Kanzi 3.8.0

Reimplemented in kanzi::DragAndDropManipulator.

◆ onFail()

virtual void kanzi::InputManipulator::onFail ( )

protectedvirtual

Fail function for input manipulators.

Called by the fail input manipulator when its gesture recognition fails.

Reimplemented in kanzi::MultiClickManipulator, and kanzi::ClickManipulator.

◆ notifyTouchInside()

virtual void kanzi::InputManipulator::notifyTouchInside ( const TouchInfo & touchInfo )

protectedvirtual

Notify an input manipulator about touch events that occur inside the subtree of the input manipulator.

Parameters

touchInfo The available touch points, including those that occur over the attached node.

Reimplemented in kanzi::PanManipulator, kanzi::PinchManipulator, kanzi::MultiClickManipulator, kanzi::ClickManipulator, kanzi::DragAndDropManipulator, and kanzi::LongPressManipulator.

◆ notifyTouchOutside()

virtual void kanzi::InputManipulator::notifyTouchOutside ( const TouchInfo & touchInfo )

protectedvirtual

Notify an input manipulator about touch events that occur outside the subtree of the input manipulator.

Parameters

touchInfo The touch points occurring outside of the subtree.

Reimplemented in kanzi::PanManipulator, kanzi::PinchManipulator, kanzi::MultiClickManipulator, kanzi::ClickManipulator, kanzi::DragAndDropManipulator, and kanzi::LongPressManipulator.

◆ notifyKeyInput()

virtual bool kanzi::InputManipulator::notifyKeyInput ( const KeyEvent & event )

protectedvirtual

Notify an input manipulator about a key event that occurs on the attached node.

Parameters

event The information about the event.

Returns: If this input manipulator handles the key event, true, otherwise false.

Reimplemented in kanzi::TextInputManipulator, kanzi::NavigationManipulator, kanzi::KeyManipulator, and kanzi::FocusNavigationManipulator.

◆ detectKeyGesture()

bool kanzi::InputManipulator::detectKeyGesture	(	const KeyEvent &	event,
		KeyGestureInfo &	gesture
	)

protected

Detects key gestures from the event that you pass as an argument.

Call this method to detect a key gesture from a key event.

The method calls

onPartialKeyPressGesture() when it recognizes a partial key press gesture.
onKeyPressGesture() when it recognizes a complete key press gesture.
onKeyReleaseGesture() when it recognizes a key release gesture of a previous key press gesture.

Parameters

event	The event from which to detect the key gesture.
gesture	The structure with the gesture data.

Returns: If the key event matches the key gesture, returns true. If the key does not match the gesture, or only partially matches it, returns false.

Since: kanzi 3.9.0

◆ onPartialKeyPressGesture()

virtual void kanzi::InputManipulator::onPartialKeyPressGesture ( KeyGestureInfo & gesture )

protectedvirtual

The detectKeyGesture() method calls this method when it detects a partial key press gesture.

The default implementation moves the input manipulator into StatePossible.

Parameters

gesture The key gesture for which Kanzi detects the partial key press gesture.

Since: kanzi 3.9.0

Reimplemented in kanzi::TextInputManipulator.

◆ onKeyPressGesture()

virtual void kanzi::InputManipulator::onKeyPressGesture ( KeyGestureInfo & gesture )

protectedvirtual

The detectKeyGesture() method calls this method when it detects a key press gesture.

You should override this method to move the input manipulator to StateBegin.

Parameters

gesture The key gesture for which Kanzi detects the key press gesture.

Since: kanzi 3.9.0

Reimplemented in kanzi::TextInputManipulator, kanzi::NavigationManipulator, kanzi::KeyManipulator, and kanzi::FocusNavigationManipulator.

◆ onKeyReleaseGesture()

virtual void kanzi::InputManipulator::onKeyReleaseGesture ( KeyGestureInfo & gesture )

protectedvirtual

The detectKeyGesture() method calls this method when it detects a key release gesture.

You should override this method to reset the input manipulator state to StateReady.

Parameters

gesture The key gesture for which Kanzi detects the key release gesture.

Since: kanzi 3.9.0

Reimplemented in kanzi::TextInputManipulator, kanzi::NavigationManipulator, kanzi::KeyManipulator, and kanzi::FocusNavigationManipulator.

◆ getInputManager()

InputManager* kanzi::InputManipulator::getInputManager ( ) const

protected

Get the attached input manager of an input manipulator.

Used internally.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::InputManipulator::makeEditorInfo ( )

inlinestaticprotected

◆ addHitTestArguments()

void kanzi::InputManipulator::addHitTestArguments	(	MessageArguments &	message,
		const TouchPoint &	touchPoint
	)

protected

Add hit test information arguments to the message from the touch point.

Derive local point and manipulator node from touch point.

Parameters

message	Target message.
touchPoint	Current touch point.

◆ findNearestParent2D()

Node2D* kanzi::InputManipulator::findNearestParent2D ( )

protected

Find the 2D manipulator node for this input manipulator.

Returns: 2D manipulator node or nullptr.

◆ markTouchPointConsumed()

void kanzi::InputManipulator::markTouchPointConsumed ( const TouchPoint & touchPoint )

protected

Marks the passed touch point handled.

When touch point is marked handled, Kanzi marks the touch event that contains that touch point handled during processing of the touch event.

Parameters

touchPoint Touch point to mark as handled.

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

kanzi/core.ui/input/input_manipulator.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Gesture recognition

Member Typedef Documentation

◆ TouchPointsContainer

◆ TouchPointsConstIterator

◆ TouchEventRoutingMode

Member Enumeration Documentation

◆ ManipulatorType

◆ State

◆ EventRoutingMode

Constructor & Destructor Documentation

◆ ~InputManipulator()

◆ InputManipulator()

Member Function Documentation

◆ setTouchEventRoutingMode()

◆ getTouchEventRoutingMode()

◆ getType()

◆ reset()

◆ cancel()

◆ isActive()

◆ isResettable()

◆ isCancelable()

◆ getState()

◆ setState()

◆ getAttachedNode()

◆ requireToFail()

◆ getFailManipulator()

◆ getDependantManipulator()

◆ isAttached()

◆ setReferenceNode()

◆ setEventRoutingMode()

◆ getEventRoutingMode()

◆ attach()

◆ detach()

◆ onAttach()

◆ onDetach()

◆ onReset()

◆ onCancel()

◆ isResettableOverride()

◆ isCancelableOverride()

◆ onFail()

◆ notifyTouchInside()

◆ notifyTouchOutside()

◆ notifyKeyInput()

◆ detectKeyGesture()

◆ onPartialKeyPressGesture()

◆ onKeyPressGesture()

◆ onKeyReleaseGesture()

◆ getInputManager()

◆ makeEditorInfo()

◆ addHitTestArguments()

◆ findNearestParent2D()

◆ markTouchPointConsumed()