kanzi::InputManipulator Class Reference

Base class for the input manipulator. More...

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

Inheritance diagram for kanzi::InputManipulator:

Classes
class	InputMessageArguments
	Message arguments for input manipulator messages. More...
struct	TouchInfo
	Structure to hold a state of current touch points. More...

Public Types
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 possible touch event routing modes. More...
typedef vector< KzuInputTouchPoint * >	TouchPointsContainer
typedef TouchPointsContainer::const_iterator	TouchPointsConstIterator
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
	InputManipulator (Domain *domain)
	Constructor. More...
virtual	~InputManipulator ()
void	attach (Node &node)
	Attach the input manipulator to the node. Called automatically when manipulator is added to the node. More...
void	detach ()
	Detach the input manipulator. Called automatically when manipulator is removed from the node. More...
void	reset ()
	Reset manipulator. More...
void	cancel ()
	Notify manipulator of touch canceling. More...
virtual void	notifyTouchInside (const TouchInfo &touchInfo)
	Notify manipulator of touches happening inside the subtree of the manipulator. More...
virtual void	notifyTouchOutside (const TouchInfo &touchInfo)
	Notify manipulator of touches happening outside the subtree of the manipulator. More...
State	getState () const
	Get the state of the manipulator. More...
void	setState (State state)
	Set the state of the manipulator. More...
Node *	getAttachedNode () const
	Get the node the input manipulator is attached to. More...
void	requireToFail (InputManipulatorWeakPtr manipulatorToFail)
	Sets the manipulator that is required to fail before this manipulator can succeed. More...
InputManipulatorWeakPtr	getFailManipulator () const
	Gets the fail manipulator. More...
InputManipulator *	getDependManipulator () const
	Gets the depend manipulator. More...
bool	isHandled () const
	Get the change flag of the manipulator. Used internally. More...
void	setHandled (bool handled)
	Set the change flag of the manipulator. Used internally. More...
void	setInputManager (KzuInputManager *inputManager)
	Attach or detach the input manager to the manipulator during recognition. Used internally. More...
KzuInputManager *	getInputManager () const
	Get the attached input manager of the manipulator. Used internally. More...
bool	isAttached () const
	Tells if the input manipulator is attached (has a valid node reference). 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 used by input manager. More...
TouchEventRoutingMode	getTouchEventRoutingMode ()
	Return the current touch event routing mode. More...
void	addHitTestArguments (MessageArguments &message, const KzuInputTouchPoint &touchPoint)
	Add hit test information arguments to the message from the touch point. 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...
AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	unapplyObjectStyle (AppliedStyleEntry *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...

Protected Member Functions
virtual void	onAttach ()
	Attach function for input manipulators. More...
virtual void	onDetach ()
	Detach function for input manipulators. More...
virtual void	onReset ()
	Reset function for input manipulators. More...
virtual void	onCancel ()
	Cancel function for input manipulators. More...
virtual void	onFail ()
	Fail function for input manipulators. 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)
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::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 &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)

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Friends
class	PanManipulator

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< AppliedStyleEntry * >	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

Base class for the input manipulator.

You can use the input manipulators to recognize gestures such as click or pinch from incoming touch events.

See also

ClickManipulator, DragAndDropManipulator, LongPressManipulator, MultiClickManipulator, PanManipulator, PinchManipulator

Member Typedef Documentation

typedef vector<KzuInputTouchPoint*> kanzi::InputManipulator::TouchPointsContainer

typedef TouchPointsContainer::const_iterator kanzi::InputManipulator::TouchPointsConstIterator

Member Enumeration Documentation

enum kanzi::InputManipulator::State

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

Enumerator
StateReady	The manipulator is in initial state.
StatePossible	The manipulator has started processing, but no gesture is recognized yet. The system can fail the manipulator automatically.
StateBegin	The manipulator has recognized a continuous gesture.
StateChange	The manipulator has recognized changes in a continuous gesture.
StateEnd	The manipulator has finished recognizing a gesture.
StateFail	The manipulator has failed recognizing a gesture.
StateDelayed	Not used at this time.
StateCanceled	Not used at this time.

enum kanzi::InputManipulator::TouchEventRoutingMode

Enumeration for possible touch event routing modes.

Enumerator
RoutingBubbling	Touch events are provided when bubbling (from the hit test node to root)
RoutingTunneling	Touch events are provided when tunneling (from root to hit test node)

Constructor & Destructor Documentation

kanzi::InputManipulator::InputManipulator ( Domain *  domain )

explicit

Constructor.

virtual kanzi::InputManipulator::~InputManipulator ( )

virtual

Member Function Documentation

void kanzi::InputManipulator::attach

(

Node &

node

)

Attach the input manipulator to the node. Called automatically when manipulator is added to the node.

void kanzi::InputManipulator::detach

(

)

Detach the input manipulator. Called automatically when manipulator is removed from the node.

void kanzi::InputManipulator::reset

(

)

Reset manipulator.

void kanzi::InputManipulator::cancel

(

)

Notify manipulator of touch canceling.

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

virtual

Notify manipulator of touches happening inside the subtree of the manipulator.

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

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

virtual

Notify manipulator of touches happening outside the subtree of the manipulator.

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

State kanzi::InputManipulator::getState

(

)

const

Get the state of the manipulator.

void kanzi::InputManipulator::setState

(

State

state

)

Set the state of the manipulator.

Node* kanzi::InputManipulator::getAttachedNode

(

)

const

Get the node the input manipulator is attached to.

void kanzi::InputManipulator::requireToFail

(

InputManipulatorWeakPtr

manipulatorToFail

)

Sets the manipulator that is required to fail before this manipulator can succeed.

InputManipulatorWeakPtr kanzi::InputManipulator::getFailManipulator

(

)

const

Gets the fail manipulator.

InputManipulator* kanzi::InputManipulator::getDependManipulator

(

)

const

Gets the depend manipulator.

bool kanzi::InputManipulator::isHandled

(

)

const

Get the change flag of the manipulator. Used internally.

void kanzi::InputManipulator::setHandled

(

bool

handled

)

Set the change flag of the manipulator. Used internally.

void kanzi::InputManipulator::setInputManager

(

KzuInputManager *

inputManager

)

Attach or detach the input manager to the manipulator during recognition. Used internally.

KzuInputManager* kanzi::InputManipulator::getInputManager

(

)

const

Get the attached input manager of the manipulator. Used internally.

bool kanzi::InputManipulator::isAttached ( ) const

inline

Tells if the input manipulator is attached (has a valid node reference).

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

inline

Override the attached node as the hit test reference node.

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

inline

Sets the touch event routing mode used by input manager.

Default is Bubbling. Set to tunneling when you want an underlying gesture to be recognized before the gestures in children. For example you could have a layer with two finger pan input manipulator with tunneling and scroll view as a child of that node. In this case, two finger pan would get change to be recognized before the default pan in the scroll view.

TouchEventRoutingMode kanzi::InputManipulator::getTouchEventRoutingMode ( )

inline

Return the current touch event routing mode.

virtual void kanzi::InputManipulator::onAttach ( )

protectedvirtual

Attach function for input manipulators.

virtual void kanzi::InputManipulator::onDetach ( )

protectedvirtual

Detach function for input manipulators.

virtual void kanzi::InputManipulator::onReset ( )

protectedvirtual

Reset function for input manipulators.

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

virtual void kanzi::InputManipulator::onCancel ( )

protectedvirtual

Cancel function for input manipulators.

virtual void kanzi::InputManipulator::onFail ( )

protectedvirtual

Fail function for input manipulators.

Reimplemented in kanzi::ClickManipulator.

static PropertyTypeEditorInfoSharedPtr kanzi::InputManipulator::makeEditorInfo ( )

inlinestaticprotected

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

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.

Friends And Related Function Documentation

friend class PanManipulator

friend

---

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

• kanzi/core.ui/input/input_manipulator.hpp