Neonode zForce(TM) SDK

- Main Page
- Modules
- Classes
- Files

- File List
- File Members

SensorDevice.h
Go to the documentation of this file.
1
13 #ifndef DEVICE_SENSORDEVICE_SENSORDEVICE_H
14 #define DEVICE_SENSORDEVICE_SENSORDEVICE_H
15
16 #ifndef ZFORCECOMMON_H
17 #error Please include "zForceCommon.h" before this file.
18 #endif // ZFORCECOMMON_H
19
28 struct SensorDevice
29 {
30 Device;
31 CartesianCoordinates Resolution;
32 TouchActiveArea TouchActiveArea;
33 ReverseTouchActiveArea ReverseTouchActiveArea;
34
50 bool ( * GetEnable)(SensorDevice * self);
72 bool ( * SetEnable)(SensorDevice * self,
73 bool continuousMode,
74 uint32_t numberOfMessages);
75
90 bool ( * GetDisable)(SensorDevice * self);
107 bool ( * SetDisable)(SensorDevice * self);
108
123 bool ( * GetOperationModes)(SensorDevice * self);
146 bool ( * SetOperationModes)(SensorDevice * self,
147 OperationModes modeMask,
148 OperationModes modeValues);
149
164 bool ( * GetResolution)(SensorDevice * self);
188 bool ( * SetResolution)(SensorDevice * self,
189 uint32_t x, bool xIsValid,
190 uint32_t y, bool yIsValid,
191 uint32_t z, bool zIsValid);
192
207 bool ( * GetReverseTouchActiveArea)(SensorDevice * self);
208
226 bool ( * SetReverseTouchActiveArea)(SensorDevice * self,
227 bool xIsReversed,
228 bool yIsReversed);
229
244 bool ( * GetTouchActiveArea)(SensorDevice * self);
245
267 bool ( * SetTouchActiveArea)(SensorDevice * self,
268 uint32_t lowerBoundaryX,
269 uint32_t upperBoundaryX,
270 bool xIsValid,
271 uint32_t lowerBoundaryY,
272 uint32_t upperBoundaryY,
273 bool yIsValid);
274
289 bool ( * GetDetectedObjectSizeRestriction)(SensorDevice * self);
309 bool ( * SetDetectedObjectSizeRestriction)(SensorDevice * self,
310 uint32_t minimumSize,
311 uint32_t maximumSize,
312 bool minimumSizeIsValid,
313 bool maximumSizeIsValid);
314
329 bool ( * GetNumberOfTrackedObjects) (SensorDevice * self);
330
346 bool ( * SetNumberOfTrackedObjects) (SensorDevice * self,
347 uint32_t numberOfTrackedObjects);
348
349 };
350
365 DLLINTERNAL SensorDevice * SensorDevice_New (Connection * connection,
366 DeviceType deviceType,
367 uint32_t deviceIndex,
368 size_t size);
369
370 #endif // DEVICE_SENSORDEVICE_SENSORDEVICE_H
371
OperationModes
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:127
SensorDevice::GetOperationModes
bool(* GetOperationModes)(SensorDevice *self)
Get the current Operating Modes of the Device.
Definition: SensorDevice.h:123
SensorDevice::Device
Device
Base device.
Definition: SensorDevice.h:30
SensorDevice::GetDisable
bool(* GetDisable)(SensorDevice *self)
Ask the Device if it is disabled.
Definition: SensorDevice.h:90
SensorDevice::GetDetectedObjectSizeRestriction
bool(* GetDetectedObjectSizeRestriction)(SensorDevice *self)
Get the current Detected Object Size Restriction of the Device.
Definition: SensorDevice.h:289
SensorDevice::Resolution
CartesianCoordinates Resolution
Resolution of the device.
Definition: SensorDevice.h:31
SensorDevice::SetDetectedObjectSizeRestriction
bool(* SetDetectedObjectSizeRestriction)(SensorDevice *self, uint32_t minimumSize, uint32_t maximumSize, bool minimumSizeIsValid, bool maximumSizeIsValid)
Set the current Detected Object Size Restriction of the Device.
Definition: SensorDevice.h:309
Connection
The main Connection struct.
Definition: Connection.h:56
SensorDevice::TouchActiveArea
TouchActiveArea TouchActiveArea
Touch Active Area of the device.
Definition: SensorDevice.h:32
SensorDevice::SetReverseTouchActiveArea
bool(* SetReverseTouchActiveArea)(SensorDevice *self, bool xIsReversed, bool yIsReversed)
Reverse the Touch Active Area of the Device.
Definition: SensorDevice.h:226
SensorDevice::SetResolution
bool(* SetResolution)(SensorDevice *self, uint32_t x, bool xIsValid, uint32_t y, bool yIsValid, uint32_t z, bool zIsValid)
Set the current Resolution of the Device.
Definition: SensorDevice.h:188
SensorDevice::SetNumberOfTrackedObjects
bool(* SetNumberOfTrackedObjects)(SensorDevice *self, uint32_t numberOfTrackedObjects)
Set the number of tracked objects.
Definition: SensorDevice.h:346
SensorDevice_New
DLLINTERNAL SensorDevice * SensorDevice_New(Connection *connection, DeviceType deviceType, uint32_t deviceIndex, size_t size)
Internal call used to create a new SensorDevice.
SensorDevice::GetNumberOfTrackedObjects
bool(* GetNumberOfTrackedObjects)(SensorDevice *self)
Get the number of tracked objects.
Definition: SensorDevice.h:329
SensorDevice::GetEnable
bool(* GetEnable)(SensorDevice *self)
Ask the Device if it is enabled.
Definition: SensorDevice.h:50
SensorDevice::SetOperationModes
bool(* SetOperationModes)(SensorDevice *self, OperationModes modeMask, OperationModes modeValues)
Set the current Operating Modes of the Device.
Definition: SensorDevice.h:146
ReverseTouchActiveArea
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:203
SensorDevice::GetTouchActiveArea
bool(* GetTouchActiveArea)(SensorDevice *self)
Get the current Touch Active Area of the Device.
Definition: SensorDevice.h:244
SensorDevice::SetTouchActiveArea
bool(* SetTouchActiveArea)(SensorDevice *self, uint32_t lowerBoundaryX, uint32_t upperBoundaryX, bool xIsValid, uint32_t lowerBoundaryY, uint32_t upperBoundaryY, bool yIsValid)
Set the current Touch Active Area of the Device.
Definition: SensorDevice.h:267
SensorDevice::SetDisable
bool(* SetDisable)(SensorDevice *self)
Disable the device.
Definition: SensorDevice.h:107
CartesianCoordinates
Struct representing a coordinate.
Definition: zForceTypes.h:167
DeviceType
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:73
SensorDevice
Struct representing a SensorDevice, a meta device.
Definition: SensorDevice.h:28
SensorDevice::ReverseTouchActiveArea
ReverseTouchActiveArea ReverseTouchActiveArea
Reverse The Touch Active Area of the device.
Definition: SensorDevice.h:33
SensorDevice::GetResolution
bool(* GetResolution)(SensorDevice *self)
Get the current Resolution of the Device.
Definition: SensorDevice.h:164
TouchActiveArea
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:185
SensorDevice::GetReverseTouchActiveArea
bool(* GetReverseTouchActiveArea)(SensorDevice *self)
Gets the current reverse setting for the Touch Active Area.
Definition: SensorDevice.h:207
SensorDevice::SetEnable
bool(* SetEnable)(SensorDevice *self, bool continuousMode, uint32_t numberOfMessages)
Enable the device.
Definition: SensorDevice.h:72