kanzi::MultiClickManipulator Class Reference

Multi-click input manipulator recognizes double click and tap gestures from incoming touch events. More...

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

Inheritance diagram for kanzi::MultiClickManipulator:
kanzi::InputManipulator kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Classes

class  MultiClickMessageArguments
 Message arguments for the multi-click gesture recognized message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 

Public Member Functions

void setTimeout (chrono::milliseconds timeout)
 Set multi-click timeout in milliseconds. The default timeout is 250ms. More...
 
void setExpectedClicks (int clicks)
 Set the amount of clicks required to emit the MultiClickMessage message. More...
 
int getExpectedClicks () const
 Get the amount of clicks required to emit the MultiClickMessage message. More...
 
void setSendIntermediateClickMessages (bool value)
 Set SendIntermediateClickMessagesProperty. More...
 
bool getSendIntermediateClickMessages () const
 Get SendIntermediateClickMessagesProperty. More...
 
- Public Member Functions inherited from kanzi::InputManipulator
virtual ~InputManipulator ()
 Destructor. More...
 
void reset ()
 Reset the manipulator. More...
 
void cancel ()
 Notify manipulator of touch canceling. More...
 
State getState () const
 Get the state of the input manipulator. More...
 
void setState (State state)
 Set the state of the input manipulator. More...
 
NodegetAttachedNode () const
 Gets the node to which the input manipulator is attached. More...
 
void requireToFail (InputManipulatorWeakPtr manipulatorToFail)
 Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. More...
 
InputManipulatorWeakPtr getFailManipulator () const
 Gets the fail manipulator. More...
 
InputManipulatorgetDependManipulator () const
 Gets the dependant input manipulator. More...
 
bool isAttached () const
 Tells whether the input manipulator is attached to a node. More...
 
void setReferenceNode (NodeWeakPtr referenceNode)
 Override the attached node as the hit test reference node. More...
 
void setTouchEventRoutingMode (TouchEventRoutingMode mode)
 Sets the touch event routing mode that you want the input manager to use when distributing the touch points to manipulators. More...
 
TouchEventRoutingMode getTouchEventRoutingMode ()
 Returns the current touch event routing mode. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () 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 MultiClickManipulatorSharedPtr create (Domain *domain, string_view="")
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 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 MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

static MessageType< MultiClickMessageArgumentsMultiClickMessage
 Message type for notifying recognition of multi-click gesture. More...
 
static PropertyType< int > ExpectedClicksProperty
 The property that determines how many clicks are required to trigger the MultiClickMessage message. More...
 
static PropertyType< bool > SendIntermediateClickMessagesProperty
 If the property is set to true, the manipulator will send MultiClickMessage for each click up to ExpectedClicksProperty value. More...
 

Protected Member Functions

 MultiClickManipulator (Domain *domain)
 Constructor. More...
 
virtual void notifyTouchInside (const TouchInfo &touchInfo) KZ_OVERRIDE
 InputManipulator::notifyTouchInside implementation. More...
 
virtual void notifyTouchOutside (const TouchInfo &touchInfo) KZ_OVERRIDE
 InputManipulator::notifyTouchOutside implementation. More...
 
virtual void onReset () KZ_OVERRIDE
 InputManipulator::onReset implementation. More...
 
virtual void onFail () KZ_OVERRIDE
 InputManipulator::onFail implementation. More...
 
void onTimeout (const TimerMessageArguments &arguments)
 
- Protected Member Functions inherited from kanzi::InputManipulator
 InputManipulator (Domain *domain)
 Constructor. More...
 
virtual void onAttach ()
 Attach function for input manipulators. More...
 
virtual void onDetach ()
 Detach function for input manipulators. More...
 
virtual void onCancel ()
 Cancel function for input manipulators. More...
 
void addHitTestArguments (MessageArguments &message, const KzuInputTouchPoint &touchPoint)
 Add hit test information arguments to the message from the touch point. 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::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 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)
 

Additional Inherited Members

- Public Types inherited from kanzi::InputManipulator
enum  State {
  StateReady, StatePossible, StateBegin, StateChange,
  StateEnd, StateFail, StateDelayed, StateCanceled
}
 Enumeration for possible input manipulator states during touch or mouse input sequence. More...
 
enum  TouchEventRoutingMode { RoutingBubbling, RoutingTunneling }
 Enumeration for the available touch event routing modes. More...
 
typedef vector< KzuInputTouchPoint * > TouchPointsContainer
 
typedef TouchPointsContainer::const_iterator TouchPointsConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::InputManipulator
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Multi-click input manipulator recognizes double click and tap gestures from incoming touch events.

It generates the messages required to implement the logic for objects that change the state when users multi-click or multi-tap the object. For example, use the multi-click input manipulator to zoom in and out a map.

See also
ClickManipulator, DragAndDropManipulator, LongPressManipulator, PanManipulator, PinchManipulator

Examples

To receive the multi click event, add message handler for the MultiClickMessage message.

First create a handler method:

void onNodeDoubleClicked(MultiClickManipulator::MultiClickMessageArguments& /*messageArguments*/)
{
// Insert your code to handle the click event here
}

Then add a message handler for your node:

ClickManipulatorSharedPtr doubleClickManipulator = ClickManipulator::create(domain);
node->addInputManipulator(doubleClickManipulator);
doubleClickMessageSubscription = node->addMessageHandler(MultiClickManipulator::MultiClickMessage, bind(&InputManipulatorSnippet::onNodeDoubleClicked, this, placeholders::_1));

Constructor & Destructor Documentation

kanzi::MultiClickManipulator::MultiClickManipulator ( Domain domain)
explicitprotected

Constructor.

Member Function Documentation

static MultiClickManipulatorSharedPtr kanzi::MultiClickManipulator::create ( Domain domain,
string_view  = "" 
)
inlinestatic
void kanzi::MultiClickManipulator::setTimeout ( chrono::milliseconds  timeout)

Set multi-click timeout in milliseconds. The default timeout is 250ms.

void kanzi::MultiClickManipulator::setExpectedClicks ( int  clicks)

Set the amount of clicks required to emit the MultiClickMessage message.

int kanzi::MultiClickManipulator::getExpectedClicks ( ) const

Get the amount of clicks required to emit the MultiClickMessage message.

void kanzi::MultiClickManipulator::setSendIntermediateClickMessages ( bool  value)

Set SendIntermediateClickMessagesProperty.

bool kanzi::MultiClickManipulator::getSendIntermediateClickMessages ( ) const

Get SendIntermediateClickMessagesProperty.

virtual void kanzi::MultiClickManipulator::notifyTouchInside ( const TouchInfo touchInfo)
protectedvirtual

InputManipulator::notifyTouchInside implementation.

Reimplemented from kanzi::InputManipulator.

virtual void kanzi::MultiClickManipulator::notifyTouchOutside ( const TouchInfo touchInfo)
protectedvirtual
virtual void kanzi::MultiClickManipulator::onReset ( )
protectedvirtual

InputManipulator::onReset implementation.

Reimplemented from kanzi::InputManipulator.

virtual void kanzi::MultiClickManipulator::onFail ( )
protectedvirtual

InputManipulator::onFail implementation.

Reimplemented from kanzi::InputManipulator.

void kanzi::MultiClickManipulator::onTimeout ( const TimerMessageArguments arguments)
protected

Member Data Documentation

MessageType<MultiClickMessageArguments> kanzi::MultiClickManipulator::MultiClickMessage
static

Message type for notifying recognition of multi-click gesture.

MultiClickMessage message is generated when the second touch press and release sequence is recognized in the attached node area within the timeout duration. MultiClick fails if some other gesture succeeds before it.

PropertyType<int> kanzi::MultiClickManipulator::ExpectedClicksProperty
static

The property that determines how many clicks are required to trigger the MultiClickMessage message.

PropertyType<bool> kanzi::MultiClickManipulator::SendIntermediateClickMessagesProperty
static

If the property is set to true, the manipulator will send MultiClickMessage for each click up to ExpectedClicksProperty value.

If the property is set to false, Only the final click will trigger the message.


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