Neonode zForce(TM) SDK

- Main Page
- Modules
- Classes
- Files

- File List
- File Members

zForceTypes.h
Go to the documentation of this file.
1
7 #ifndef ZFORCETYPES_H
8 #define ZFORCETYPES_H
9
10 #ifdef COMPILING_ZFORCE_SDK
11 typedef struct zForceHandler zForceHandler;
12 #endif
13 typedef struct zForce zForce;
16 typedef struct Connection Connection;
18 typedef struct Device Device;
20 typedef struct PlatformDevice PlatformDevice;
22 typedef struct SensorDevice SensorDevice;
24 typedef struct CoreDevice CoreDevice;
26 typedef struct AirDevice AirDevice;
28 typedef struct PlusDevice PlusDevice;
30 typedef struct LightingDevice LightingDevice;
32 typedef struct Protocol Protocol;
34 typedef struct ProtocolEntry ProtocolEntry;
36 typedef struct Transport Transport;
38 typedef struct TransportEntry TransportEntry;
40 typedef struct DataFrame DataFrame;
42 typedef struct StreamingDataFrame StreamingDataFrame;
44 typedef struct Message Message;
46 typedef struct EnableMessage EnableMessage;
48 typedef struct DisableMessage DisableMessage;
50 typedef struct OperationModesMessage OperationModesMessage;
52 typedef struct ResolutionMessage ResolutionMessage;
54 typedef struct TouchActiveAreaMessage TouchActiveAreaMessage;
56 typedef struct TouchMessage TouchMessage;
58 typedef struct NumberOfTrackedObjectsMessage NumberOfTrackedObjectsMessage;
60 typedef struct FingerFrequencyMessage FingerFrequencyMessage;
62 typedef struct IdleFrequencyMessage IdleFrequencyMessage;
64 typedef struct DetectedObjectSizeRestrictionMessage
65 DetectedObjectSizeRestrictionMessage;
67 typedef struct ReverseTouchActiveAreaMessage ReverseTouchActiveAreaMessage;
69 typedef struct McuUniqueIdentifierMessage McuUniqueIdentifierMessage;
71 typedef struct OffsetMessage OffsetMessage;
73 typedef struct HidDisplaySizeMessage HidDisplaySizeMessage;
75 typedef enum DeviceType DeviceType;
77 enum DeviceType
78 {
79 None = 0,
80 Platform = 1,
81 Sensor = 2,
82 Core = 4,
83 Air = 8,
84 Plus = 16,
85 Lighting = 32
86 };
87
89 typedef enum MessageType MessageType;
91 enum MessageType
92 {
93 EnableMessageType,
94 DisableMessageType,
95 OperationModesMessageType,
96 ResolutionMessageType,
97 TouchActiveAreaMessageType,
98 TouchMessageType,
99 DetectedObjectSizeRestrictionMessageType,
100 NumberOfTrackedObjectsMessageType,
101 FingerFrequencyMessageType,
102 IdleFrequencyMessageType,
103 ReverseTouchActiveAreaMessageType,
104 McuUniqueIdentifierMessageType,
105 OffsetMessageType,
106 HidDisplaySizeMessageType,
107 HighestValidMessageType = HidDisplaySizeMessageType
108 };
109
111 typedef enum MessageGroup MessageGroup;
113 enum MessageGroup
114 {
115 Request,
116 Response,
117 Notification,
118 HighestValidMessageGroup = Notification
119 };
120
122 typedef enum MessageAction MessageAction;
124 enum MessageAction
125 {
126 GetAction,
127 SetAction
128 };
129
131 typedef enum OperationModes OperationModes;
133 enum OperationModes
134 {
135 NoOperationMode = 0,
136 DetectionMode = 1,
137 SignalsMode = 2,
138 LedLevelsMode = 4,
139 DetectionHidMode = 8,
140 GesturesMode = 16,
141 HighestValidOperationMode = (GesturesMode * 2) - 1
143 };
144
146 typedef enum TouchEvent TouchEvent;
148 enum TouchEvent
149 {
150 DownEvent,
151 MoveEvent,
152 UpEvent,
153 InvalidEvent,
154 GhostEvent
155 };
156
158 typedef enum TouchOrientation TouchOrientation;
160 enum TouchOrientation
161 {
162 PortraitOrientation,
163 LandscapeOrientation
164 };
165
167 typedef struct CartesianCoordinates CartesianCoordinates;
173 struct CartesianCoordinates
174 {
175 uint32_t X;
176 bool HasX;
177 uint32_t Y;
178 bool HasY;
179 uint32_t Z;
180 bool HasZ;
181 };
182
184 typedef struct TouchActiveArea TouchActiveArea;
191 struct TouchActiveArea
192 {
193 uint32_t LowerBoundaryX;
194 uint32_t UpperBoundaryX;
195 bool HasX;
196 uint32_t LowerBoundaryY;
197 uint32_t UpperBoundaryY;
198 bool HasY;
199 };
200
202 typedef struct ReverseTouchActiveArea ReverseTouchActiveArea;
209 struct ReverseTouchActiveArea
210 {
211 bool XIsReversed;
212 bool YIsReversed;
213 };
214
215 #endif // ZFORCETYPES_H
OperationModes
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:133
MoveEvent
The Touch object is moving.
Definition: zForceTypes.h:151
NoOperationMode
No Mode set.
Definition: zForceTypes.h:135
TouchActiveArea::HasY
bool HasY
True if the coordinate system has a Y axis.
Definition: zForceTypes.h:198
ResolutionMessage
This structure represents a resolution message.
Definition: ResolutionMessage.h:21
CartesianCoordinates::HasZ
bool HasZ
Is set to true if the coordinate system has a Z axis.
Definition: zForceTypes.h:180
TouchActiveArea::UpperBoundaryY
uint32_t UpperBoundaryY
End of the Touch Active Area Y axis.
Definition: zForceTypes.h:197
GhostEvent
Ghost touch detected.
Definition: zForceTypes.h:154
PlatformDevice
Struct representing a PlatformDevice.
Definition: PlatformDevice.h:26
CoreDevice
Struct representing a CoreDevice.
Definition: CoreDevice.h:26
Connection
The main Connection struct.
Definition: Connection.h:56
NumberOfTrackedObjectsMessage
This structure represents a number of tracked objects message.
Definition: NumberOfTrackedObjectsMessage.h:22
DisableMessage
This structure represents a disable message.
Definition: DisableMessage.h:22
StreamingDataFrame
Struct containing the StreamingDataFrame information.
Definition: StreamingDataFrame.h:27
HidDisplaySizeMessage
This structure represents a Hid Display Size Message.
Definition: HidDisplaySizeMessage.h:21
Transport
Transport struct. This structure represents the base class of all Transport definitions.
Definition: Transport.h:47
FingerFrequencyMessage
This structure represents a finger frequency message.
Definition: FingerFrequencyMessage.h:21
TouchActiveArea::HasX
bool HasX
True if the coordinate system has a X axis.
Definition: zForceTypes.h:195
HighestValidOperationMode
Special value used for error checking.
Definition: zForceTypes.h:142
TouchActiveArea::LowerBoundaryX
uint32_t LowerBoundaryX
Start of the Touch Active Area X axis.
Definition: zForceTypes.h:193
SignalsMode
Signals Mode.
Definition: zForceTypes.h:137
GesturesMode
Definition: zForceTypes.h:140
OperationModesMessage
This structure represents a operation mode message.
Definition: OperationModesMessage.h:24
PlusDevice
Struct representing a PlusDevice.
Definition: PlusDevice.h:25
PortraitOrientation
Object is in Portrait orientation.
Definition: zForceTypes.h:162
TouchMessage
This structure represents a touch message.
Definition: TouchMessage.h:21
LightingDevice
Struct representing a LightingDevice.
Definition: LightingDevice.h:25
CartesianCoordinates::HasY
bool HasY
Is set to true if the coordinate system has a Y axis.
Definition: zForceTypes.h:178
DetectionHidMode
Detection Mode for Hid Devices.
Definition: zForceTypes.h:139
ReverseTouchActiveArea
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:209
Message
The main Message struct.
Definition: Message.h:21
DataFrame
Struct containing the DataFrame information.
Definition: DataFrame.h:27
DetectionMode
Detection Mode (Touch).
Definition: zForceTypes.h:136
TouchOrientation
TouchOrientation
Enum describing what orientation touches are generated in.
Definition: zForceTypes.h:160
MessageGroup
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:113
CartesianCoordinates::Y
uint32_t Y
Y axis value.
Definition: zForceTypes.h:177
CartesianCoordinates::Z
uint32_t Z
Z axis value.
Definition: zForceTypes.h:179
TouchEvent
TouchEvent
Enum describing what state a touch can be in.
Definition: zForceTypes.h:148
InvalidEvent
Invalid Touch event reported by Device.
Definition: zForceTypes.h:153
TransportEntry
struct TransportEntry TransportEntry
Definition: Transport.h:36
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:31
LedLevelsMode
Led Levels Mode.
Definition: zForceTypes.h:138
LandscapeOrientation
Object is in Landscape orientation.
Definition: zForceTypes.h:163
MessageType
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:91
IdleFrequencyMessage
This structure represents an idle frequency message.
Definition: IdleFrequencyMessage.h:21
ReverseTouchActiveAreaMessage
This structure represents a reverse touch active area message.
Definition: ReverseTouchActiveAreaMessage.h:22
ReverseTouchActiveArea::XIsReversed
bool XIsReversed
True if the X axis is reversed.
Definition: zForceTypes.h:211
CartesianCoordinates::HasX
bool HasX
Is set to true if the coordinate system has a X axis.
Definition: zForceTypes.h:176
zForce
Main struct.
Definition: zForce.h:29
CartesianCoordinates
Struct representing a coordinate.
Definition: zForceTypes.h:173
GetAction
Get information from device.
Definition: zForceTypes.h:126
DeviceType
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:77
TouchActiveArea::LowerBoundaryY
uint32_t LowerBoundaryY
Start of the Touch Active Area Y axis.
Definition: zForceTypes.h:196
DownEvent
New Touch object detected.
Definition: zForceTypes.h:150
CartesianCoordinates::X
uint32_t X
X axis value.
Definition: zForceTypes.h:175
TouchActiveArea::UpperBoundaryX
uint32_t UpperBoundaryX
End of the Touch Active Area X axis.
Definition: zForceTypes.h:194
Device
Brief Device base class.
Definition: Device.h:24
SensorDevice
Struct representing a SensorDevice, a meta device.
Definition: SensorDevice.h:28
OffsetMessage
This structure represents an offset message.
Definition: OffsetMessage.h:21
ProtocolEntry
struct ProtocolEntry ProtocolEntry
Definition: zForceTypes.h:34
MessageAction
MessageAction
Enum describing the action of a message.
Definition: zForceTypes.h:124
TouchActiveArea
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:191
EnableMessage
This structure represents an enable message.
Definition: EnableMessage.h:23
McuUniqueIdentifierMessage
This structure represents a mcu unique identifier message.
Definition: McuUniqueIdentifierMessage.h:24
SetAction
Set information on device.
Definition: zForceTypes.h:127
AirDevice
Struct representing an AirDevice.
Definition: AirDevice.h:25
UpEvent
The Touch object is no longer detected.
Definition: zForceTypes.h:152
TouchActiveAreaMessage
This structure represents a touch active area message.
Definition: TouchActiveAreaMessage.h:22
ReverseTouchActiveArea::YIsReversed
bool YIsReversed
True if the Y axis is reversed.
Definition: zForceTypes.h:212