[ACR-1585][gesture][Initial version of codes]
[platform/core/api/gesture.git] / include / gesture_common_internal.h
1 /*
2  * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __TIZEN_UIX_GESTURE_COMMON_INTERNAL_H__
18 #define __TIZEN_UIX_GESTURE_COMMON_INTERNAL_H__
19
20 #include <tizen.h>
21 #include <gesture_data_info.h>
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 /**
28  * @file gesture_common_internal.h
29  * @brief This file contains gesture's internal common struct info.
30  */
31
32 /**
33  * @brief       Enumeration for gesture hand type.
34  * @details     If the HAND_GESTURE_NO_SELECTED_HAND is used, the system will consider with right hand
35  *
36  * @since_tizen @if WEARABLE 6.0 @endif
37  */
38 typedef enum {
39         HAND_GESTURE_NO_SELECTED_HAND   = 1,    /**< Gesture with hand, no selected hand */
40         HAND_GESTURE_LEFT_HAND          = 2,    /**< Gesture with left hand */
41         HAND_GESTURE_RIGHT_HAND         = 3,    /**< Gesture with right hand */
42 } hand_gesture_handtype_e;
43
44 /**
45  * @brief       Enumeration for gesture movement.
46  * @details     Determining whether to move the hand in one direction or back 
47  *
48  * @since_tizen @if WEARABLE 6.0 @endif
49  */
50 typedef enum
51 {
52         HAND_GESTURE_WORK_MODE_ONE_WAY  = 1,    /**< move the hand in one direction */
53         HAND_GESTURE_WORK_MODE_ROUND_TRIP       = 2,    /**< move the hand in round trip */
54         HAND_GESTURE_WORK_MODE_MIXED            = 3,    /**< move the hand in mixed */
55         HAND_GESTURE_WORK_MODE_UNDEFINED        = 4,    /**< move the hand in undefined */
56 } hand_gesture_workmode_e;
57
58 /**
59  * @brief       Enumeration for gesture event types.
60  * @details     With regards to type of the gesture, gesture_get_event() returns one of the followings.
61  * @since_tizen @if WEARABLE 6.0 @endif
62  */
63 typedef enum {
64         HAND_GESTURE_EVENT_NONE         = 1,    /**< Detected nothing */
65         HAND_GESTURE_EVENT_DETECTED             = 2,    /**< Detected the gesture */
66         HAND_GESTURE_HAND_MOVE_RIGHT    = 3,    /**< move right detected (only for HAND_GESTURE_LEFT_HAND_MOVE or HAND_GESTURE_RIGHT_HAND_MOVE) */
67         HAND_GESTURE_HAND_MOVE_LEFT     = 4,    /**< move left detected (only for HAND_GESTURE_LEFT_HAND_MOVE or HAND_GESTURE_RIGHT_HAND_MOVE) */
68         HAND_GESTURE_HAND_MOVE_UP       = 5,    /**< move up detected (only for HAND_GESTURE_LEFT_HAND_MOVE or HAND_GESTURE_RIGHT_HAND_MOVE) */
69         HAND_GESTURE_HAND_MOVE_DOWN     = 6,    /**< move down detected (only for HAND_GESTURE_LEFT_HAND_MOVE or HAND_GESTURE_RIGHT_HAND_MOVE) */
70         HAND_GESTURE_HAND_MOVE_PUSH     = 7,    /**< move push detected (only for HAND_GESTURE_LEFT_HAND_MOVE or HAND_GESTURE_RIGHT_HAND_MOVE) */
71 } hand_gesture_event_e;
72
73
74 #ifdef __cplusplus
75 }
76 #endif
77
78 #endif /* __TIZEN_UIX_GESTURE_COMMON_INTERNAL_H__ */