Kanzi Graphics Engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
kzu_input_manager.h File Reference

Input manager. More...

Data Structures

struct  KzuInputTouchPoint
 Touch point description. More...
 

Macros

#define KZU_INPUT_MANAGER_MAX_TOUCH_POINTS
 Maximum supported number of touch points. More...
 
#define KZU_INPUT_TOUCH_INVALID_ID
 Invalid touch point identifier. More...
 

Enumerations

enum  KzuInputTouchPointState { KZU_INPUT_TOUCH_POINT_STATE_DOWN, KZU_INPUT_TOUCH_POINT_STATE_STATIONARY, KZU_INPUT_TOUCH_POINT_STATE_MOVE, KZU_INPUT_TOUCH_POINT_STATE_UP }
 Touch point state. More...
 

Functions

kzsError kzuInputManagerCreate (const struct KzcMemoryManager *memoryManager, struct KzuInputManager **out_inputManager)
 Create an input manager. More...
 
kzsError kzuInputManagerDelete (struct KzuInputManager *inputManager)
 Delete an input manager. More...
 
kzsError kzuInputManagerProcessInputEvent (struct KzuInputManager *inputManager, const struct KzsEvent *inputEvent, struct KzuMessageDispatcher *messageDispatcher, const struct KzuLayer *layer)
 Process a low level input event. More...
 
kzsError kzuInputManagerCaptureTouch (struct KzuInputManager *inputManager, struct KzuObjectNode *objectNode)
 Captures raw touch events to specified object node. More...
 
struct KzuObjectNodekzuInputManagerGetTouchCaptureObject (const struct KzuInputManager *inputManager)
 Returns the raw touch event capturer node. More...
 
kzsError kzuInputManagerRemoveManipulator (const struct KzuInputManager *inputManager, struct KzuInputManipulator *inputManipulator)
 Remove input manipulator dependencies from input manager. More...
 
kzsError kzuInputManagerNotifyManipulatorStateChange (const struct KzuInputManager *inputManager, struct KzuInputManipulator *inputManipulator)
 Notification of manipulator state change. More...
 
kzsError kzuInputManagerSetFocus (struct KzuInputManager *inputManager, struct KzuObjectNode *objectNode)
 Attempts to set focus to an object. More...
 
struct KzuObjectNodekzuInputManagerGetFocus (const struct KzuInputManager *inputManager)
 Gets the focus object. More...
 

Detailed Description

Input manager.

Copyright 2008-2019 by Rightware. All rights reserved.

Macro Definition Documentation

#define KZU_INPUT_MANAGER_MAX_TOUCH_POINTS

Maximum supported number of touch points.

#define KZU_INPUT_TOUCH_INVALID_ID

Invalid touch point identifier.

Enumeration Type Documentation

Touch point state.

Enumerator
KZU_INPUT_TOUCH_POINT_STATE_DOWN 
KZU_INPUT_TOUCH_POINT_STATE_STATIONARY 

The point has been created by touching the screen.

KZU_INPUT_TOUCH_POINT_STATE_MOVE 

The point has not moved since last report.

KZU_INPUT_TOUCH_POINT_STATE_UP 

The point has moved since last report.

Function Documentation

kzsError kzuInputManagerCreate ( const struct KzcMemoryManager memoryManager,
struct KzuInputManager **  out_inputManager 
)

Create an input manager.

kzsError kzuInputManagerDelete ( struct KzuInputManager *  inputManager)

Delete an input manager.

kzsError kzuInputManagerProcessInputEvent ( struct KzuInputManager *  inputManager,
const struct KzsEvent *  inputEvent,
struct KzuMessageDispatcher messageDispatcher,
const struct KzuLayer layer 
)

Process a low level input event.

kzsError kzuInputManagerCaptureTouch ( struct KzuInputManager *  inputManager,
struct KzuObjectNode objectNode 
)

Captures raw touch events to specified object node.

Pass KZ_NULL to release capture. Raw touch capture has no effect on manipulators.

struct KzuObjectNode* kzuInputManagerGetTouchCaptureObject ( const struct KzuInputManager *  inputManager)

Returns the raw touch event capturer node.

Returns KZ_NULL if no capturer has been set.

kzsError kzuInputManagerRemoveManipulator ( const struct KzuInputManager *  inputManager,
struct KzuInputManipulator inputManipulator 
)

Remove input manipulator dependencies from input manager.

kzsError kzuInputManagerNotifyManipulatorStateChange ( const struct KzuInputManager *  inputManager,
struct KzuInputManipulator inputManipulator 
)

Notification of manipulator state change.

kzsError kzuInputManagerSetFocus ( struct KzuInputManager *  inputManager,
struct KzuObjectNode objectNode 
)

Attempts to set focus to an object.

struct KzuObjectNode* kzuInputManagerGetFocus ( const struct KzuInputManager *  inputManager)

Gets the focus object.