Neonode zForce(TM) SDK
zForceTypes.h
Go to the documentation of this file.
1 
8 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
9 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
10 
11 #ifdef COMPILING_ZFORCE_SDK
12 typedef struct zForceHandler zForceHandler;
13 #endif // COMPILING_ZFORCE_SDK
14 typedef struct zForce zForce;
17 typedef struct Connection Connection;
19 typedef struct Device Device;
23 typedef struct SensorDevice SensorDevice;
25 typedef struct CoreDevice CoreDevice;
27 typedef struct AirDevice AirDevice;
29 typedef struct PlusDevice PlusDevice;
33 typedef struct Protocol Protocol;
37 typedef struct Transport Transport;
41 typedef struct DataFrame DataFrame;
45 typedef struct Message Message;
57 typedef struct TouchMessage TouchMessage;
82 
85 {
86  None = 0,
87  Platform = 1,
88  Sensor = 2,
89  Core = 4,
90  Air = 8,
91  Plus = 16,
92  Lighting = 32
93 };
95 typedef enum DeviceType DeviceType;
96 
99 {
100  EnableMessageType,
101  DisableMessageType,
102  OperationModesMessageType,
103  ResolutionMessageType,
104  TouchActiveAreaMessageType,
105  TouchMessageType,
106  DetectedObjectSizeRestrictionMessageType,
107  NumberOfTrackedObjectsMessageType,
108  FingerFrequencyMessageType,
109  IdleFrequencyMessageType,
110  ReverseTouchActiveAreaMessageType,
111  McuUniqueIdentifierMessageType,
112  OffsetMessageType,
113  HidDisplaySizeMessageType,
114  FlipXYMessageType,
115  ReflectiveEdgeFilterMessageType,
116  MergeTouchesMessageType,
117  TouchModeMessageType,
118  HighestValidMessageType = TouchModeMessageType
119 };
122 
123 
126 {
127  Request,
128  Response,
129  Notification,
130  HighestValidMessageGroup = Notification
131 };
134 
135 
138 {
141 };
144 
147 {
156 };
159 
162 {
168 };
170 typedef enum TouchEvent TouchEvent;
171 
174 {
177 };
180 
183 {
186 };
188 typedef enum TouchModes TouchModes;
189 
198 {
199 #endif // !defined(ZFORCETYPES_H) && !defined(CON_CARTESIAN) && !defined (CON_TAA) && !defined (CON_REVTAA)
200 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_CARTESIANCOORDINATES)
201  uint32_t X;
202  bool HasX;
203  uint32_t Y;
204  bool HasY;
205  uint32_t Z;
206  bool HasZ;
207 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_CARTESIANCOORDINATES)
208 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
209 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
210 };
211 
221 {
222 #endif
223 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_TOUCHACTIVEAREA)
224  uint32_t LowerBoundaryX;
225  uint32_t UpperBoundaryX;
226  bool HasX;
227  uint32_t LowerBoundaryY;
228  uint32_t UpperBoundaryY;
229  bool HasY;
230 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_TOUCHACTIVEAREA)
231 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
232 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
233 };
234 
244 {
245 #endif
246 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_REVERSETOUCHACTIVEAREA)
247  bool XIsReversed;
248  bool YIsReversed;
249 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_REVERSETOUCHACTIVEAREA)
250 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
251 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
252 };
253 
254 #define ZFORCETYPES_H
255 #endif // !defined(ZFORCETYPES_H) && !defined(CON_CARTESIAN) && !defined (CON_TAA) && !defined (CON_REVTAA)
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:146
The Touch object is moving.
Definition: zForceTypes.h:164
struct OperationModesMessage OperationModesMessage
Definition: zForceTypes.h:51
No Mode set.
Definition: zForceTypes.h:148
bool HasY
True if the coordinate system has a Y axis.
Definition: zForceTypes.h:229
Touch Mode is set to Normal.
Definition: zForceTypes.h:184
bool HasZ
Is set to true if the coordinate system has a Z axis.
Definition: zForceTypes.h:206
uint32_t UpperBoundaryY
End of the Touch Active Area Y axis.
Definition: zForceTypes.h:228
Ghost touch detected.
Definition: zForceTypes.h:167
TouchModes
Enum describing what touch mode a device can be in.
Definition: zForceTypes.h:182
Struct representing a CoreDevice.
Definition: CoreDevice.h:24
The main Connection struct.
Definition: Connection.h:64
struct ResolutionMessage ResolutionMessage
Definition: zForceTypes.h:53
This structure represents a disable message.
Definition: DisableMessage.h:21
Struct containing the StreamingDataFrame information.
Definition: StreamingDataFrame.h:26
This structure represents a Hid Display Size Message.
Definition: HidDisplaySizeMessage.h:20
struct SensorDevice SensorDevice
Definition: zForceTypes.h:23
struct ReverseTouchActiveAreaMessage ReverseTouchActiveAreaMessage
Definition: zForceTypes.h:67
Transport struct. This structure represents the base class of all Transport definitions.
Definition: Transport.h:46
This structure represents a finger frequency message.
Definition: FingerFrequencyMessage.h:20
bool HasX
True if the coordinate system has a X axis.
Definition: zForceTypes.h:226
Special value used for error checking.
Definition: zForceTypes.h:155
uint32_t LowerBoundaryX
Start of the Touch Active Area X axis.
Definition: zForceTypes.h:224
struct TouchActiveAreaMessage TouchActiveAreaMessage
Definition: zForceTypes.h:55
Signals Mode.
Definition: zForceTypes.h:150
struct OffsetMessage OffsetMessage
Definition: zForceTypes.h:71
This structure represents a FlipXY Message.
Definition: FlipXYMessage.h:20
Definition: zForceTypes.h:153
struct ReflectiveEdgeFilterMessage ReflectiveEdgeFilterMessage
Definition: zForceTypes.h:77
Object is in Portrait orientation.
Definition: zForceTypes.h:175
bool HasY
Is set to true if the coordinate system has a Y axis.
Definition: zForceTypes.h:204
Detection Mode for Hid Devices.
Definition: zForceTypes.h:152
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:243
The main Message struct.
Definition: Message.h:20
Struct containing the DataFrame information.
Definition: DataFrame.h:26
Detection Mode (Touch).
Definition: zForceTypes.h:149
TouchOrientation
Enum describing what orientation touches are generated in.
Definition: zForceTypes.h:173
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:125
uint32_t Y
Y axis value.
Definition: zForceTypes.h:203
uint32_t Z
Z axis value.
Definition: zForceTypes.h:205
TouchEvent
Enum describing what state a touch can be in.
Definition: zForceTypes.h:161
Invalid Touch event reported by Device.
Definition: zForceTypes.h:166
struct TransportEntry TransportEntry
Definition: Transport.h:35
This structure represents a detected object size restriction message.
Definition: DetectedObjectSizeRestrictionMessage.h:23
This structure represents the base class of all protocol definitions.
Definition: Protocol.h:30
struct LightingDevice LightingDevice
Definition: zForceTypes.h:31
Led Levels Mode.
Definition: zForceTypes.h:151
struct TouchModeMessage TouchModeMessage
Definition: zForceTypes.h:81
Object is in Landscape orientation.
Definition: zForceTypes.h:176
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:98
This structure represents an idle frequency message.
Definition: IdleFrequencyMessage.h:20
struct TouchMessage TouchMessage
Definition: zForceTypes.h:57
bool XIsReversed
True if the X axis is reversed.
Definition: zForceTypes.h:247
struct PlusDevice PlusDevice
Definition: zForceTypes.h:29
bool HasX
Is set to true if the coordinate system has a X axis.
Definition: zForceTypes.h:202
Main struct.
Definition: zForce.h:28
Struct representing a coordinate.
Definition: zForceTypes.h:197
Touch Mode is set to Click on Touch.
Definition: zForceTypes.h:185
Get information from device.
Definition: zForceTypes.h:139
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:84
uint32_t LowerBoundaryY
Start of the Touch Active Area Y axis.
Definition: zForceTypes.h:227
New Touch object detected.
Definition: zForceTypes.h:163
uint32_t X
X axis value.
Definition: zForceTypes.h:201
uint32_t UpperBoundaryX
End of the Touch Active Area X axis.
Definition: zForceTypes.h:225
Brief Device base class.
Definition: Device.h:23
struct ProtocolEntry ProtocolEntry
Definition: zForceTypes.h:35
This structure represents a merge touches message.
Definition: MergeTouchesMessage.h:22
MessageAction
Enum describing the action of a message.
Definition: zForceTypes.h:137
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:220
This structure represents an enable message.
Definition: EnableMessage.h:22
This structure represents a mcu unique identifier message.
Definition: McuUniqueIdentifierMessage.h:24
Set information on device.
Definition: zForceTypes.h:140
Struct representing an AirDevice.
Definition: AirDevice.h:24
The Touch object is no longer detected.
Definition: zForceTypes.h:165
struct PlatformDevice PlatformDevice
Definition: zForceTypes.h:21
struct NumberOfTrackedObjectsMessage NumberOfTrackedObjectsMessage
Definition: zForceTypes.h:59
bool YIsReversed
True if the Y axis is reversed.
Definition: zForceTypes.h:248