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;
84 
87 {
88  None = 0,
89  Platform = 1,
90  Sensor = 2,
91  Core = 4,
92  Air = 8,
93  Plus = 16,
94  Lighting = 32
95 };
97 typedef enum DeviceType DeviceType;
98 
101 {
102  EnableMessageType,
103  DisableMessageType,
104  OperationModesMessageType,
105  ResolutionMessageType,
106  TouchActiveAreaMessageType,
107  TouchMessageType,
108  DetectedObjectSizeRestrictionMessageType,
109  NumberOfTrackedObjectsMessageType,
110  FingerFrequencyMessageType,
111  IdleFrequencyMessageType,
112  ReverseTouchActiveAreaMessageType,
113  McuUniqueIdentifierMessageType,
114  OffsetMessageType,
115  HidDisplaySizeMessageType,
116  FlipXYMessageType,
117  ReflectiveEdgeFilterMessageType,
118  MergeTouchesMessageType,
119  TouchModeMessageType,
120  FloatingProtectionMessageType,
121  HighestValidMessageType = FloatingProtectionMessageType
122 };
125 
126 
129 {
130  Request,
131  Response,
132  Notification,
133  HighestValidMessageGroup = Notification
134 };
137 
138 
141 {
144 };
147 
150 {
159 };
162 
165 {
171 };
173 typedef enum TouchEvent TouchEvent;
174 
177 {
180 };
183 
186 {
189 };
191 typedef enum TouchModes TouchModes;
192 
201 {
202 #endif // !defined(ZFORCETYPES_H) && !defined(CON_CARTESIAN) && !defined (CON_TAA) && !defined (CON_REVTAA)
203 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_CARTESIANCOORDINATES)
204  uint32_t X;
205  bool HasX;
206  uint32_t Y;
207  bool HasY;
208  uint32_t Z;
209  bool HasZ;
210 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_CARTESIANCOORDINATES)
211 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
212 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
213 };
214 
224 {
225 #endif
226 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_TOUCHACTIVEAREA)
227  uint32_t LowerBoundaryX;
228  uint32_t UpperBoundaryX;
229  bool HasX;
230  uint32_t LowerBoundaryY;
231  uint32_t UpperBoundaryY;
232  bool HasY;
233 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_TOUCHACTIVEAREA)
234 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
235 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
236 };
237 
247 {
248 #endif
249 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_REVERSETOUCHACTIVEAREA)
250  bool XIsReversed;
251  bool YIsReversed;
252 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_REVERSETOUCHACTIVEAREA)
253 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
254 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
255 };
256 
257 #define ZFORCETYPES_H
258 #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:149
The Touch object is moving.
Definition: zForceTypes.h:167
struct OperationModesMessage OperationModesMessage
Definition: zForceTypes.h:51
No Mode set.
Definition: zForceTypes.h:151
bool HasY
True if the coordinate system has a Y axis.
Definition: zForceTypes.h:232
Touch Mode is set to Normal.
Definition: zForceTypes.h:187
bool HasZ
Is set to true if the coordinate system has a Z axis.
Definition: zForceTypes.h:209
uint32_t UpperBoundaryY
End of the Touch Active Area Y axis.
Definition: zForceTypes.h:231
Ghost touch detected.
Definition: zForceTypes.h:170
TouchModes
Enum describing what touch mode a device can be in.
Definition: zForceTypes.h:185
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:229
Special value used for error checking.
Definition: zForceTypes.h:158
uint32_t LowerBoundaryX
Start of the Touch Active Area X axis.
Definition: zForceTypes.h:227
struct TouchActiveAreaMessage TouchActiveAreaMessage
Definition: zForceTypes.h:55
Signals Mode.
Definition: zForceTypes.h:153
struct OffsetMessage OffsetMessage
Definition: zForceTypes.h:71
This structure represents a FlipXY Message.
Definition: FlipXYMessage.h:20
Definition: zForceTypes.h:156
struct ReflectiveEdgeFilterMessage ReflectiveEdgeFilterMessage
Definition: zForceTypes.h:77
Object is in Portrait orientation.
Definition: zForceTypes.h:178
bool HasY
Is set to true if the coordinate system has a Y axis.
Definition: zForceTypes.h:207
Detection Mode for Hid Devices.
Definition: zForceTypes.h:155
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:246
The main Message struct.
Definition: Message.h:20
Struct containing the DataFrame information.
Definition: DataFrame.h:26
Detection Mode (Touch).
Definition: zForceTypes.h:152
TouchOrientation
Enum describing what orientation touches are generated in.
Definition: zForceTypes.h:176
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:128
uint32_t Y
Y axis value.
Definition: zForceTypes.h:206
uint32_t Z
Z axis value.
Definition: zForceTypes.h:208
TouchEvent
Enum describing what state a touch can be in.
Definition: zForceTypes.h:164
Invalid Touch event reported by Device.
Definition: zForceTypes.h:169
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:154
struct TouchModeMessage TouchModeMessage
Definition: zForceTypes.h:81
Object is in Landscape orientation.
Definition: zForceTypes.h:179
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:100
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:250
struct PlusDevice PlusDevice
Definition: zForceTypes.h:29
bool HasX
Is set to true if the coordinate system has a X axis.
Definition: zForceTypes.h:205
Main struct.
Definition: zForce.h:28
Struct representing a coordinate.
Definition: zForceTypes.h:200
Touch Mode is set to Click on Touch.
Definition: zForceTypes.h:188
Get information from device.
Definition: zForceTypes.h:142
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:86
uint32_t LowerBoundaryY
Start of the Touch Active Area Y axis.
Definition: zForceTypes.h:230
New Touch object detected.
Definition: zForceTypes.h:166
uint32_t X
X axis value.
Definition: zForceTypes.h:204
uint32_t UpperBoundaryX
End of the Touch Active Area X axis.
Definition: zForceTypes.h:228
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:140
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:223
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:143
Struct representing an AirDevice.
Definition: AirDevice.h:24
The Touch object is no longer detected.
Definition: zForceTypes.h:168
This structure represents a floating protection message.
Definition: FloatingProtectionMessage.h:21
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:251