kzu_input_manipulator.h File Reference

Input manipulator. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Enumerations
enum	KzuInputManipulatorState {   KZU_INPUT_MANIPULATOR_STATE_READY, KZU_INPUT_MANIPULATOR_STATE_POSSIBLE, KZU_INPUT_MANIPULATOR_STATE_BEGIN, KZU_INPUT_MANIPULATOR_STATE_CHANGE,   KZU_INPUT_MANIPULATOR_STATE_END, KZU_INPUT_MANIPULATOR_STATE_FAIL, KZU_INPUT_MANIPULATOR_STATE_DELAYED, KZU_INPUT_MANIPULATOR_STATE_CANCELED }
	Input manipulator state. More...

Functions
kzsError	kzuInputManipulatorAttach (struct KzuInputManipulator *inputManipulator, struct KzuObjectNode *objectNode)
	Attach an input manipulator to an object node. More...
kzsError	kzuInputManipulatorDetach (struct KzuInputManipulator *inputManipulator)
	Detach an input manipulator. More...
kzsError	kzuInputManipulatorDelete (struct KzuInputManipulator *inputManipulator)
	Delete an input manipulator. More...
struct KzuObjectNode *	kzuInputManipulatorGetObjectNode (const struct KzuInputManipulator *inputManipulator)
	Get the object node an input manipulator is attached to. More...
enum KzuInputManipulatorState	kzuInputManipulatorGetState (const struct KzuInputManipulator *inputManipulator)
	Get the state of a manipulator. More...
kzsError	kzuInputManipulatorSetState (struct KzuInputManipulator *inputManipulator, enum KzuInputManipulatorState state)
	Set the state of a manipulator. More...
void	kzuInputManipulatorRequireToFail (struct KzuInputManipulator *inputManipulator, struct KzuInputManipulator *manipulatorToFail)
	Sets the manipulator that is required to fail before this manipulator can succeed. More...
struct KzuInputManipulator *	kzuInputManipulatorGetFailManipulator (const struct KzuInputManipulator *inputManipulator)
	Gets the fail manipulator. More...
struct KzuInputManipulator *	kzuInputManipulatorGetDependManipulator (const struct KzuInputManipulator *inputManipulator)
	Gets the depend manipulator. More...
kzsError	kzuInputManipulatorTouchInside (struct KzuInputManipulator *inputManipulator, struct KzuMessage *message)
	Notify manipulator of touches happening inside the subtree of the manipulator. More...
kzsError	kzuInputManipulatorTouchOutside (struct KzuInputManipulator *inputManipulator, struct KzuMessage *message)
	Notify manipulator of touches happening outside the subtree of the manipulator. More...
kzsError	kzuInputManipulatorCancel (struct KzuInputManipulator *inputManipulator)
	Notify manipulator of touch canceling. More...
kzsError	kzuInputManipulatorReset (struct KzuInputManipulator *inputManipulator)
	Reset manipulator. More...
kzBool	kzuInputManipulatorIsHandled (const struct KzuInputManipulator *inputManipulator)
	Get the change flag of a manipulator. More...
void	kzuInputManipulatorSetHandled (struct KzuInputManipulator *inputManipulator, kzBool handled)
	Set the change flag of a manipulator. More...
kzsError	kzuInputManipulatorSetInputManager (struct KzuInputManipulator *inputManipulator, struct KzuInputManager *inputManager)
	Attach or detach an input manager to a manipulator during recognition. More...
struct KzuInputManager *	kzuInputManipulatorGetInputManager (const struct KzuInputManipulator *inputManipulator)
	Get the attached input manager of a manipulator. More...
kzsError	kzuInputManipulatorSendMessage (struct KzuMessage *message, struct KzuObjectNode *objectNode)
	Send message utility, providing predictable state manager transitions due to message queue processing. More...

Detailed Description

Input manipulator.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuInputManipulatorState

Input manipulator state.

Enumerator
KZU_INPUT_MANIPULATOR_STATE_READY	The manipulator is in initial state.
KZU_INPUT_MANIPULATOR_STATE_POSSIBLE	The manipulator has started processing, but no gesture is recognized yet. The system can fail the manipulator automatically.
KZU_INPUT_MANIPULATOR_STATE_BEGIN	The manipulator has recognized a continuous gesture.
KZU_INPUT_MANIPULATOR_STATE_CHANGE	The manipulator has recognized changes in a continuous gesture.
KZU_INPUT_MANIPULATOR_STATE_END	The manipulator has finished recognizing a gesture.
KZU_INPUT_MANIPULATOR_STATE_FAIL	The manipulator has failed recognizing a gesture.
KZU_INPUT_MANIPULATOR_STATE_DELAYED	Not used at this time.
KZU_INPUT_MANIPULATOR_STATE_CANCELED	Not used at this time.

Function Documentation

kzsError kzuInputManipulatorAttach	(	struct KzuInputManipulator *	inputManipulator,
		struct KzuObjectNode *	objectNode
	)

Attach an input manipulator to an object node.

Called automatically when manipulator is added to an object node.

kzsError kzuInputManipulatorDetach

(

struct KzuInputManipulator *

inputManipulator)

Detach an input manipulator.

Called automatically when manipulator is removed from an object node.

kzsError kzuInputManipulatorDelete

(

struct KzuInputManipulator *

inputManipulator)

Delete an input manipulator.

struct KzuObjectNode* kzuInputManipulatorGetObjectNode

(

const struct KzuInputManipulator *

inputManipulator)

Get the object node an input manipulator is attached to.

enum KzuInputManipulatorState kzuInputManipulatorGetState

(

const struct KzuInputManipulator *

inputManipulator)

Get the state of a manipulator.

kzsError kzuInputManipulatorSetState	(	struct KzuInputManipulator *	inputManipulator,
		enum KzuInputManipulatorState	state
	)

Set the state of a manipulator.

void kzuInputManipulatorRequireToFail	(	struct KzuInputManipulator *	inputManipulator,
		struct KzuInputManipulator *	manipulatorToFail
	)

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

struct KzuInputManipulator* kzuInputManipulatorGetFailManipulator

(

const struct KzuInputManipulator *

inputManipulator)

Gets the fail manipulator.

struct KzuInputManipulator* kzuInputManipulatorGetDependManipulator

(

const struct KzuInputManipulator *

inputManipulator)

Gets the depend manipulator.

kzsError kzuInputManipulatorTouchInside	(	struct KzuInputManipulator *	inputManipulator,
		struct KzuMessage *	message
	)

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

kzsError kzuInputManipulatorTouchOutside	(	struct KzuInputManipulator *	inputManipulator,
		struct KzuMessage *	message
	)

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

kzsError kzuInputManipulatorCancel

(

struct KzuInputManipulator *

inputManipulator)

Notify manipulator of touch canceling.

kzsError kzuInputManipulatorReset

(

struct KzuInputManipulator *

inputManipulator)

Reset manipulator.

kzBool kzuInputManipulatorIsHandled

(

const struct KzuInputManipulator *

inputManipulator)

Get the change flag of a manipulator.

Used internally.

void kzuInputManipulatorSetHandled	(	struct KzuInputManipulator *	inputManipulator,
		kzBool	handled
	)

Set the change flag of a manipulator.

Used internally.

kzsError kzuInputManipulatorSetInputManager	(	struct KzuInputManipulator *	inputManipulator,
		struct KzuInputManager *	inputManager
	)

Attach or detach an input manager to a manipulator during recognition.

Used internally.

struct KzuInputManager* kzuInputManipulatorGetInputManager

(

const struct KzuInputManipulator *

inputManipulator)

Get the attached input manager of a manipulator.

Used internally.

kzsError kzuInputManipulatorSendMessage	(	struct KzuMessage *	message,
		struct KzuObjectNode *	objectNode
	)

Send message utility, providing predictable state manager transitions due to message queue processing.