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;
80
82 enum DeviceType
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
96 enum MessageType
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 };
118 typedef enum MessageType MessageType;
119
120
122 enum MessageGroup
123 {
124 Request,
125 Response,
126 Notification,
127 HighestValidMessageGroup = Notification
128 };
130 typedef enum MessageGroup MessageGroup;
131
132
134 enum MessageAction
135 {
136 GetAction,
137 SetAction
138 };
140 typedef enum MessageAction MessageAction;
141
143 enum OperationModes
144 {
145 NoOperationMode = 0,
146 DetectionMode = 1,
147 SignalsMode = 2,
148 LedLevelsMode = 4,
149 DetectionHidMode = 8,
150 GesturesMode = 16,
151 HighestValidOperationMode = (GesturesMode * 2) - 1
153 };
155 typedef enum OperationModes OperationModes;
156
157
159 enum TouchEvent
160 {
161 DownEvent,
162 MoveEvent,
163 UpEvent,
164 InvalidEvent,
165 GhostEvent
166 };
168 typedef enum TouchEvent TouchEvent;
169
171 enum TouchOrientation
172 {
173 PortraitOrientation,
174 LandscapeOrientation
175 };
177 typedef enum TouchOrientation TouchOrientation;
178
180 typedef struct CartesianCoordinates CartesianCoordinates;
186 struct CartesianCoordinates
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
202 typedef struct TouchActiveArea TouchActiveArea;
209 struct TouchActiveArea
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
225 typedef struct ReverseTouchActiveArea ReverseTouchActiveArea;
232 struct ReverseTouchActiveArea
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
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:143
MoveEvent
The Touch object is moving.
Definition: zForceTypes.h:162
OperationModesMessage
struct OperationModesMessage OperationModesMessage
Definition: zForceTypes.h:51
NoOperationMode
No Mode set.
Definition: zForceTypes.h:145
TouchActiveArea::HasY
bool HasY
True if the coordinate system has a Y axis.
Definition: zForceTypes.h:218
CartesianCoordinates::HasZ
bool HasZ
Is set to true if the coordinate system has a Z axis.
Definition: zForceTypes.h:195
TouchActiveArea::UpperBoundaryY
uint32_t UpperBoundaryY
End of the Touch Active Area Y axis.
Definition: zForceTypes.h:217
GhostEvent
Ghost touch detected.
Definition: zForceTypes.h:165
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:215
HighestValidOperationMode
Special value used for error checking.
Definition: zForceTypes.h:152
TouchActiveArea::LowerBoundaryX
uint32_t LowerBoundaryX
Start of the Touch Active Area X axis.
Definition: zForceTypes.h:213
TouchActiveAreaMessage
struct TouchActiveAreaMessage TouchActiveAreaMessage
Definition: zForceTypes.h:55
SignalsMode
Signals Mode.
Definition: zForceTypes.h:147
OffsetMessage
struct OffsetMessage OffsetMessage
Definition: zForceTypes.h:71
FlipXYMessage
This structure represents a FlipXY Message.
Definition: FlipXYMessage.h:20
GesturesMode
Definition: zForceTypes.h:150
ReflectiveEdgeFilterMessage
struct ReflectiveEdgeFilterMessage ReflectiveEdgeFilterMessage
Definition: zForceTypes.h:77
PortraitOrientation
Object is in Portrait orientation.
Definition: zForceTypes.h:173
CartesianCoordinates::HasY
bool HasY
Is set to true if the coordinate system has a Y axis.
Definition: zForceTypes.h:193
DetectionHidMode
Detection Mode for Hid Devices.
Definition: zForceTypes.h:149
ReverseTouchActiveArea
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:232
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:146
TouchOrientation
TouchOrientation
Enum describing what orientation touches are generated in.
Definition: zForceTypes.h:171
MessageGroup
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:122
CartesianCoordinates::Y
uint32_t Y
Y axis value.
Definition: zForceTypes.h:192
CartesianCoordinates::Z
uint32_t Z
Z axis value.
Definition: zForceTypes.h:194
TouchEvent
TouchEvent
Enum describing what state a touch can be in.
Definition: zForceTypes.h:159
InvalidEvent
Invalid Touch event reported by Device.
Definition: zForceTypes.h:164
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:148
LandscapeOrientation
Object is in Landscape orientation.
Definition: zForceTypes.h:174
MessageType
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:96
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:236
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:191
zForce
Main struct.
Definition: zForce.h:28
CartesianCoordinates
Struct representing a coordinate.
Definition: zForceTypes.h:186
GetAction
Get information from device.
Definition: zForceTypes.h:136
DeviceType
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:82
TouchActiveArea::LowerBoundaryY
uint32_t LowerBoundaryY
Start of the Touch Active Area Y axis.
Definition: zForceTypes.h:216
DownEvent
New Touch object detected.
Definition: zForceTypes.h:161
CartesianCoordinates::X
uint32_t X
X axis value.
Definition: zForceTypes.h:190
TouchActiveArea::UpperBoundaryX
uint32_t UpperBoundaryX
End of the Touch Active Area X axis.
Definition: zForceTypes.h:214
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:134
TouchActiveArea
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:209
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:137
AirDevice
Struct representing an AirDevice.
Definition: AirDevice.h:24
UpEvent
The Touch object is no longer detected.
Definition: zForceTypes.h:163
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:237