Neonode zForce(TM) SDK

- Main Page
- Modules
- Classes
- Files

- File List
- File Members

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;
21 typedef struct PlatformDevice PlatformDevice;
23 typedef struct SensorDevice SensorDevice;
25 typedef struct CoreDevice CoreDevice;
27 typedef struct AirDevice AirDevice;
29 typedef struct PlusDevice PlusDevice;
31 typedef struct LightingDevice LightingDevice;
33 typedef struct Protocol Protocol;
35 typedef struct ProtocolEntry ProtocolEntry;
37 typedef struct Transport Transport;
39 typedef struct TransportEntry TransportEntry;
41 typedef struct DataFrame DataFrame;
43 typedef struct StreamingDataFrame StreamingDataFrame;
45 typedef struct Message Message;
47 typedef struct EnableMessage EnableMessage;
49 typedef struct DisableMessage DisableMessage;
51 typedef struct OperationModesMessage OperationModesMessage;
53 typedef struct ResolutionMessage ResolutionMessage;
55 typedef struct TouchActiveAreaMessage TouchActiveAreaMessage;
57 typedef struct TouchMessage TouchMessage;
59 typedef struct NumberOfTrackedObjectsMessage NumberOfTrackedObjectsMessage;
61 typedef struct FingerFrequencyMessage FingerFrequencyMessage;
63 typedef struct IdleFrequencyMessage IdleFrequencyMessage;
65 typedef struct DetectedObjectSizeRestrictionMessage DetectedObjectSizeRestrictionMessage;
67 typedef struct ReverseTouchActiveAreaMessage ReverseTouchActiveAreaMessage;
69 typedef struct McuUniqueIdentifierMessage McuUniqueIdentifierMessage;
71 typedef struct OffsetMessage OffsetMessage;
73 typedef struct HidDisplaySizeMessage HidDisplaySizeMessage;
75 typedef struct FlipXYMessage FlipXYMessage;
77 typedef struct ReflectiveEdgeFilterMessage ReflectiveEdgeFilterMessage;
79 typedef struct MergeTouchesMessage MergeTouchesMessage;
81 typedef struct TouchModeMessage TouchModeMessage;
83 typedef struct FloatingProtectionMessage FloatingProtectionMessage;
84
86 enum DeviceType
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
100 enum MessageType
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 };
124 typedef enum MessageType MessageType;
125
126
128 enum MessageGroup
129 {
130 Request,
131 Response,
132 Notification,
133 HighestValidMessageGroup = Notification
134 };
136 typedef enum MessageGroup MessageGroup;
137
138
140 enum MessageAction
141 {
142 GetAction,
143 SetAction
144 };
146 typedef enum MessageAction MessageAction;
147
149 enum OperationModes
150 {
151 NoOperationMode = 0,
152 DetectionMode = 1,
153 SignalsMode = 2,
154 LedLevelsMode = 4,
155 DetectionHidMode = 8,
156 GesturesMode = 16,
157 HighestValidOperationMode = (GesturesMode * 2) - 1
159 };
161 typedef enum OperationModes OperationModes;
162
164 enum TouchEvent
165 {
166 DownEvent,
167 MoveEvent,
168 UpEvent,
169 InvalidEvent,
170 GhostEvent
171 };
173 typedef enum TouchEvent TouchEvent;
174
176 enum TouchOrientation
177 {
178 PortraitOrientation,
179 LandscapeOrientation
180 };
182 typedef enum TouchOrientation TouchOrientation;
183
185 enum TouchModes
186 {
187 NormalTouchMode,
188 ClickOnTouchTouchMode
189 };
191 typedef enum TouchModes TouchModes;
192
194 typedef struct CartesianCoordinates CartesianCoordinates;
200 struct CartesianCoordinates
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
216 typedef struct TouchActiveArea TouchActiveArea;
223 struct TouchActiveArea
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
239 typedef struct ReverseTouchActiveArea ReverseTouchActiveArea;
246 struct ReverseTouchActiveArea
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
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:149
MoveEvent
The Touch object is moving.
Definition: zForceTypes.h:167
OperationModesMessage
struct OperationModesMessage OperationModesMessage
Definition: zForceTypes.h:51
NoOperationMode
No Mode set.
Definition: zForceTypes.h:151
TouchActiveArea::HasY
bool HasY
True if the coordinate system has a Y axis.
Definition: zForceTypes.h:232
NormalTouchMode
Touch Mode is set to Normal.
Definition: zForceTypes.h:187
CartesianCoordinates::HasZ
bool HasZ
Is set to true if the coordinate system has a Z axis.
Definition: zForceTypes.h:209
TouchActiveArea::UpperBoundaryY
uint32_t UpperBoundaryY
End of the Touch Active Area Y axis.
Definition: zForceTypes.h:231
GhostEvent
Ghost touch detected.
Definition: zForceTypes.h:170
TouchModes
TouchModes
Enum describing what touch mode a device can be in.
Definition: zForceTypes.h:185
CoreDevice
Struct representing a CoreDevice.
Definition: CoreDevice.h:24
Connection
The main Connection struct.
Definition: Connection.h:64
ResolutionMessage
struct ResolutionMessage ResolutionMessage
Definition: zForceTypes.h:53
DisableMessage
This structure represents a disable message.
Definition: DisableMessage.h:21
StreamingDataFrame
Struct containing the StreamingDataFrame information.
Definition: StreamingDataFrame.h:26
HidDisplaySizeMessage
This structure represents a Hid Display Size Message.
Definition: HidDisplaySizeMessage.h:20
SensorDevice
struct SensorDevice SensorDevice
Definition: zForceTypes.h:23
ReverseTouchActiveAreaMessage
struct ReverseTouchActiveAreaMessage ReverseTouchActiveAreaMessage
Definition: zForceTypes.h:67
Transport
Transport struct. This structure represents the base class of all Transport definitions.
Definition: Transport.h:46
FingerFrequencyMessage
This structure represents a finger frequency message.
Definition: FingerFrequencyMessage.h:20
TouchActiveArea::HasX
bool HasX
True if the coordinate system has a X axis.
Definition: zForceTypes.h:229
HighestValidOperationMode
Special value used for error checking.
Definition: zForceTypes.h:158
TouchActiveArea::LowerBoundaryX
uint32_t LowerBoundaryX
Start of the Touch Active Area X axis.
Definition: zForceTypes.h:227
TouchActiveAreaMessage
struct TouchActiveAreaMessage TouchActiveAreaMessage
Definition: zForceTypes.h:55
SignalsMode
Signals Mode.
Definition: zForceTypes.h:153
OffsetMessage
struct OffsetMessage OffsetMessage
Definition: zForceTypes.h:71
FlipXYMessage
This structure represents a FlipXY Message.
Definition: FlipXYMessage.h:20
GesturesMode
Definition: zForceTypes.h:156
ReflectiveEdgeFilterMessage
struct ReflectiveEdgeFilterMessage ReflectiveEdgeFilterMessage
Definition: zForceTypes.h:77
PortraitOrientation
Object is in Portrait orientation.
Definition: zForceTypes.h:178
CartesianCoordinates::HasY
bool HasY
Is set to true if the coordinate system has a Y axis.
Definition: zForceTypes.h:207
DetectionHidMode
Detection Mode for Hid Devices.
Definition: zForceTypes.h:155
ReverseTouchActiveArea
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:246
Message
The main Message struct.
Definition: Message.h:20
DataFrame
Struct containing the DataFrame information.
Definition: DataFrame.h:26
DetectionMode
Detection Mode (Touch).
Definition: zForceTypes.h:152
TouchOrientation
TouchOrientation
Enum describing what orientation touches are generated in.
Definition: zForceTypes.h:176
MessageGroup
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:128
CartesianCoordinates::Y
uint32_t Y
Y axis value.
Definition: zForceTypes.h:206
CartesianCoordinates::Z
uint32_t Z
Z axis value.
Definition: zForceTypes.h:208
TouchEvent
TouchEvent
Enum describing what state a touch can be in.
Definition: zForceTypes.h:164
InvalidEvent
Invalid Touch event reported by Device.
Definition: zForceTypes.h:169
TransportEntry
struct TransportEntry TransportEntry
Definition: Transport.h:35
DetectedObjectSizeRestrictionMessage
This structure represents a detected object size restriction message.
Definition: DetectedObjectSizeRestrictionMessage.h:23
Protocol
This structure represents the base class of all protocol definitions.
Definition: Protocol.h:30
LightingDevice
struct LightingDevice LightingDevice
Definition: zForceTypes.h:31
LedLevelsMode
Led Levels Mode.
Definition: zForceTypes.h:154
TouchModeMessage
struct TouchModeMessage TouchModeMessage
Definition: zForceTypes.h:81
LandscapeOrientation
Object is in Landscape orientation.
Definition: zForceTypes.h:179
MessageType
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:100
IdleFrequencyMessage
This structure represents an idle frequency message.
Definition: IdleFrequencyMessage.h:20
TouchMessage
struct TouchMessage TouchMessage
Definition: zForceTypes.h:57
ReverseTouchActiveArea::XIsReversed
bool XIsReversed
True if the X axis is reversed.
Definition: zForceTypes.h:250
PlusDevice
struct PlusDevice PlusDevice
Definition: zForceTypes.h:29
CartesianCoordinates::HasX
bool HasX
Is set to true if the coordinate system has a X axis.
Definition: zForceTypes.h:205
zForce
Main struct.
Definition: zForce.h:28
CartesianCoordinates
Struct representing a coordinate.
Definition: zForceTypes.h:200
ClickOnTouchTouchMode
Touch Mode is set to Click on Touch.
Definition: zForceTypes.h:188
GetAction
Get information from device.
Definition: zForceTypes.h:142
DeviceType
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:86
TouchActiveArea::LowerBoundaryY
uint32_t LowerBoundaryY
Start of the Touch Active Area Y axis.
Definition: zForceTypes.h:230
DownEvent
New Touch object detected.
Definition: zForceTypes.h:166
CartesianCoordinates::X
uint32_t X
X axis value.
Definition: zForceTypes.h:204
TouchActiveArea::UpperBoundaryX
uint32_t UpperBoundaryX
End of the Touch Active Area X axis.
Definition: zForceTypes.h:228
Device
Brief Device base class.
Definition: Device.h:23
ProtocolEntry
struct ProtocolEntry ProtocolEntry
Definition: zForceTypes.h:35
MergeTouchesMessage
This structure represents a merge touches message.
Definition: MergeTouchesMessage.h:22
MessageAction
MessageAction
Enum describing the action of a message.
Definition: zForceTypes.h:140
TouchActiveArea
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:223
EnableMessage
This structure represents an enable message.
Definition: EnableMessage.h:22
McuUniqueIdentifierMessage
This structure represents a mcu unique identifier message.
Definition: McuUniqueIdentifierMessage.h:24
SetAction
Set information on device.
Definition: zForceTypes.h:143
AirDevice
Struct representing an AirDevice.
Definition: AirDevice.h:24
UpEvent
The Touch object is no longer detected.
Definition: zForceTypes.h:168
FloatingProtectionMessage
This structure represents a floating protection message.
Definition: FloatingProtectionMessage.h:21
PlatformDevice
struct PlatformDevice PlatformDevice
Definition: zForceTypes.h:21
NumberOfTrackedObjectsMessage
struct NumberOfTrackedObjectsMessage NumberOfTrackedObjectsMessage
Definition: zForceTypes.h:59
ReverseTouchActiveArea::YIsReversed
bool YIsReversed
True if the Y axis is reversed.
Definition: zForceTypes.h:251