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;
80 
83 {
84  None = 0,
85  Platform = 1,
86  Sensor = 2,
87  Core = 4,
88  Air = 8,
89  Plus = 16,
90  Lighting = 32
91 };
93 typedef enum DeviceType DeviceType;
94 
97 {
98  EnableMessageType,
99  DisableMessageType,
100  OperationModesMessageType,
101  ResolutionMessageType,
102  TouchActiveAreaMessageType,
103  TouchMessageType,
104  DetectedObjectSizeRestrictionMessageType,
105  NumberOfTrackedObjectsMessageType,
106  FingerFrequencyMessageType,
107  IdleFrequencyMessageType,
108  ReverseTouchActiveAreaMessageType,
109  McuUniqueIdentifierMessageType,
110  OffsetMessageType,
111  HidDisplaySizeMessageType,
112  FlipXYMessageType,
113  ReflectiveEdgeFilterMessageType,
114  MergeTouchesMessageType,
115  HighestValidMessageType = MergeTouchesMessageType
116 };
119 
120 
123 {
124  Request,
125  Response,
126  Notification,
127  HighestValidMessageGroup = Notification
128 };
131 
132 
135 {
138 };
141 
144 {
153 };
156 
157 
160 {
166 };
168 typedef enum TouchEvent TouchEvent;
169 
172 {
175 };
178 
187 {
188 #endif // !defined(ZFORCETYPES_H) && !defined(CON_CARTESIAN) && !defined (CON_TAA) && !defined (CON_REVTAA)
189 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_CARTESIANCOORDINATES)
190  uint32_t X;
191  bool HasX;
192  uint32_t Y;
193  bool HasY;
194  uint32_t Z;
195  bool HasZ;
196 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_CARTESIANCOORDINATES)
197 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
198 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
199 };
200 
210 {
211 #endif
212 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_TOUCHACTIVEAREA)
213  uint32_t LowerBoundaryX;
214  uint32_t UpperBoundaryX;
215  bool HasX;
216  uint32_t LowerBoundaryY;
217  uint32_t UpperBoundaryY;
218  bool HasY;
219 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_TOUCHACTIVEAREA)
220 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
221 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
222 };
223 
233 {
234 #endif
235 #if !defined(ZFORCETYPES_H) || defined(CONTAINS_REVERSETOUCHACTIVEAREA)
236  bool XIsReversed;
237  bool YIsReversed;
238 #endif // !defined(ZFORCETYPES_H) || defined(CONTAINS_REVERSETOUCHACTIVEAREA)
239 #if !defined(ZFORCETYPES_H) && !defined(CONTAINS_CARTESIANCOORDINATES) && !defined(CONTAINS_TOUCHACTIVEAREA) \
240 && !defined(CONTAINS_REVERSETOUCHACTIVEAREA)
241 };
242 
243 #define ZFORCETYPES_H
244 #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:143
The Touch object is moving.
Definition: zForceTypes.h:162
struct OperationModesMessage OperationModesMessage
Definition: zForceTypes.h:51
No Mode set.
Definition: zForceTypes.h:145
bool HasY
True if the coordinate system has a Y axis.
Definition: zForceTypes.h:218
bool HasZ
Is set to true if the coordinate system has a Z axis.
Definition: zForceTypes.h:195
uint32_t UpperBoundaryY
End of the Touch Active Area Y axis.
Definition: zForceTypes.h:217
Ghost touch detected.
Definition: zForceTypes.h:165
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:215
Special value used for error checking.
Definition: zForceTypes.h:152
uint32_t LowerBoundaryX
Start of the Touch Active Area X axis.
Definition: zForceTypes.h:213
struct TouchActiveAreaMessage TouchActiveAreaMessage
Definition: zForceTypes.h:55
Signals Mode.
Definition: zForceTypes.h:147
struct OffsetMessage OffsetMessage
Definition: zForceTypes.h:71
This structure represents a FlipXY Message.
Definition: FlipXYMessage.h:20
Definition: zForceTypes.h:150
struct ReflectiveEdgeFilterMessage ReflectiveEdgeFilterMessage
Definition: zForceTypes.h:77
Object is in Portrait orientation.
Definition: zForceTypes.h:173
bool HasY
Is set to true if the coordinate system has a Y axis.
Definition: zForceTypes.h:193
Detection Mode for Hid Devices.
Definition: zForceTypes.h:149
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:232
The main Message struct.
Definition: Message.h:20
Struct containing the DataFrame information.
Definition: DataFrame.h:26
Detection Mode (Touch).
Definition: zForceTypes.h:146
TouchOrientation
Enum describing what orientation touches are generated in.
Definition: zForceTypes.h:171
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:122
uint32_t Y
Y axis value.
Definition: zForceTypes.h:192
uint32_t Z
Z axis value.
Definition: zForceTypes.h:194
TouchEvent
Enum describing what state a touch can be in.
Definition: zForceTypes.h:159
Invalid Touch event reported by Device.
Definition: zForceTypes.h:164
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:148
Object is in Landscape orientation.
Definition: zForceTypes.h:174
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:96
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:236
struct PlusDevice PlusDevice
Definition: zForceTypes.h:29
bool HasX
Is set to true if the coordinate system has a X axis.
Definition: zForceTypes.h:191
Main struct.
Definition: zForce.h:28
Struct representing a coordinate.
Definition: zForceTypes.h:186
Get information from device.
Definition: zForceTypes.h:136
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:82
uint32_t LowerBoundaryY
Start of the Touch Active Area Y axis.
Definition: zForceTypes.h:216
New Touch object detected.
Definition: zForceTypes.h:161
uint32_t X
X axis value.
Definition: zForceTypes.h:190
uint32_t UpperBoundaryX
End of the Touch Active Area X axis.
Definition: zForceTypes.h:214
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:134
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:209
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:137
Struct representing an AirDevice.
Definition: AirDevice.h:24
The Touch object is no longer detected.
Definition: zForceTypes.h:163
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:237