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 enum DeviceType DeviceType;
73 enum DeviceType
74 {
75 None = 0,
76 Platform = 1,
77 Sensor = 2,
78 Core = 4,
79 Air = 8,
80 Plus = 16,
81 Lighting = 32
82 };
83
85 typedef enum MessageType MessageType;
87 enum MessageType
88 {
89 EnableMessageType,
90 DisableMessageType,
91 OperationModesMessageType,
92 ResolutionMessageType,
93 TouchActiveAreaMessageType,
94 TouchMessageType,
95 DetectedObjectSizeRestrictionMessageType,
96 NumberOfTrackedObjectsMessageType,
97 FingerFrequencyMessageType,
98 IdleFrequencyMessageType,
99 ReverseTouchActiveAreaMessageType,
100 McuUniqueIdentifierMessageType,
101 HighestValidMessageType = McuUniqueIdentifierMessageType
102 };
103
105 typedef enum MessageGroup MessageGroup;
107 enum MessageGroup
108 {
109 Request,
110 Response,
111 Notification,
112 HighestValidMessageGroup = Notification
113 };
114
116 typedef enum MessageAction MessageAction;
118 enum MessageAction
119 {
120 GetAction,
121 SetAction
122 };
123
125 typedef enum OperationModes OperationModes;
127 enum OperationModes
128 {
129 NoOperationMode = 0,
130 DetectionMode = 1,
131 SignalsMode = 2,
132 LedLevelsMode = 4,
133 DetectionHidMode = 8,
134 GesturesMode = 16,
135 HighestValidOperationMode = (GesturesMode * 2) - 1
137 };
138
140 typedef enum TouchEvent TouchEvent;
142 enum TouchEvent
143 {
144 DownEvent,
145 MoveEvent,
146 UpEvent,
147 InvalidEvent,
148 GhostEvent
149 };
150
152 typedef enum TouchOrientation TouchOrientation;
154 enum TouchOrientation
155 {
156 PortraitOrientation,
157 LandscapeOrientation
158 };
159
161 typedef struct CartesianCoordinates CartesianCoordinates;
167 struct CartesianCoordinates
168 {
169 uint32_t X;
170 bool HasX;
171 uint32_t Y;
172 bool HasY;
173 uint32_t Z;
174 bool HasZ;
175 };
176
178 typedef struct TouchActiveArea TouchActiveArea;
185 struct TouchActiveArea
186 {
187 uint32_t LowerBoundaryX;
188 uint32_t UpperBoundaryX;
189 bool HasX;
190 uint32_t LowerBoundaryY;
191 uint32_t UpperBoundaryY;
192 bool HasY;
193 };
194
196 typedef struct ReverseTouchActiveArea ReverseTouchActiveArea;
203 struct ReverseTouchActiveArea
204 {
205 bool XIsReversed;
206 bool YIsReversed;
207 };
208
209 #endif // ZFORCETYPES_H
OperationModes
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:127
MoveEvent
The Touch object is moving.
Definition: zForceTypes.h:145
NoOperationMode
No Mode set.
Definition: zForceTypes.h:129
TouchActiveArea::HasY
bool HasY
True if the coordinate system has a Y axis.
Definition: zForceTypes.h:192
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:174
TouchActiveArea::UpperBoundaryY
uint32_t UpperBoundaryY
End of the Touch Active Area Y axis.
Definition: zForceTypes.h:191
GhostEvent
Ghost touch detected.
Definition: zForceTypes.h:148
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
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:189
HighestValidOperationMode
Special value used for error checking.
Definition: zForceTypes.h:136
TouchActiveArea::LowerBoundaryX
uint32_t LowerBoundaryX
Start of the Touch Active Area X axis.
Definition: zForceTypes.h:187
SignalsMode
Signals Mode.
Definition: zForceTypes.h:131
GesturesMode
Definition: zForceTypes.h:134
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:156
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:172
DetectionHidMode
Detection Mode for Hid Devices.
Definition: zForceTypes.h:133
ReverseTouchActiveArea
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:203
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:130
TouchOrientation
TouchOrientation
Enum describing what orientation touches are generated in.
Definition: zForceTypes.h:154
MessageGroup
MessageGroup
Enum describing the different groups a message can belong to.
Definition: zForceTypes.h:107
CartesianCoordinates::Y
uint32_t Y
Y axis value.
Definition: zForceTypes.h:171
CartesianCoordinates::Z
uint32_t Z
Z axis value.
Definition: zForceTypes.h:173
TouchEvent
TouchEvent
Enum describing what state a touch can be in.
Definition: zForceTypes.h:142
InvalidEvent
Invalid Touch event reported by Device.
Definition: zForceTypes.h:147
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:132
LandscapeOrientation
Object is in Landscape orientation.
Definition: zForceTypes.h:157
MessageType
MessageType
Enum describing the different message types that exists.
Definition: zForceTypes.h:87
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:205
CartesianCoordinates::HasX
bool HasX
Is set to true if the coordinate system has a X axis.
Definition: zForceTypes.h:170
zForce
Main struct.
Definition: zForce.h:29
CartesianCoordinates
Struct representing a coordinate.
Definition: zForceTypes.h:167
GetAction
Get information from device.
Definition: zForceTypes.h:120
DeviceType
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:73
TouchActiveArea::LowerBoundaryY
uint32_t LowerBoundaryY
Start of the Touch Active Area Y axis.
Definition: zForceTypes.h:190
DownEvent
New Touch object detected.
Definition: zForceTypes.h:144
CartesianCoordinates::X
uint32_t X
X axis value.
Definition: zForceTypes.h:169
TouchActiveArea::UpperBoundaryX
uint32_t UpperBoundaryX
End of the Touch Active Area X axis.
Definition: zForceTypes.h:188
Device
Brief Device base class.
Definition: Device.h:24
SensorDevice
Struct representing a SensorDevice, a meta device.
Definition: SensorDevice.h:28
ProtocolEntry
struct ProtocolEntry ProtocolEntry
Definition: zForceTypes.h:34
MessageAction
MessageAction
Enum describing the action of a message.
Definition: zForceTypes.h:118
TouchActiveArea
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:185
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:121
AirDevice
Struct representing an AirDevice.
Definition: AirDevice.h:25
UpEvent
The Touch object is no longer detected.
Definition: zForceTypes.h:146
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:206