Neonode zForce(TM) SDK
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 
29 {
33 
49  bool ( * GetEnable)(SensorDevice * self);
71  bool ( * SetEnable)(SensorDevice * self,
72  bool continuousMode,
73  uint32_t numberOfMessages);
74 
89  bool ( * GetDisable)(SensorDevice * self);
106  bool ( * SetDisable)(SensorDevice * self);
107 
122  bool ( * GetOperationModes)(SensorDevice * self);
145  bool ( * SetOperationModes)(SensorDevice * self,
146  OperationModes modeMask,
147  OperationModes modeValues);
148 
163  bool ( * GetResolution)(SensorDevice * self);
187  bool ( * SetResolution)(SensorDevice * self,
188  uint32_t x, bool xIsValid,
189  uint32_t y, bool yIsValid,
190  uint32_t z, bool zIsValid);
191 
206  bool ( * GetTouchActiveArea)(SensorDevice * self);
207 
232  uint32_t lowerBoundaryX,
233  uint32_t upperBoundaryX,
234  bool xIsValid,
235  bool xIsReversed,
236  uint32_t lowerBoundaryY,
237  uint32_t upperBoundaryY,
238  bool yIsValid,
239  bool yIsReversed);
240 
276  uint32_t minimumSize,
277  uint32_t maximumSize,
278  bool minimumSizeIsValid,
279  bool maximumSizeIsValid);
280 
296 
313  uint32_t numberOfTrackedObjects);
314 
315 };
316 
331 DLLINTERNAL SensorDevice * SensorDevice_New (Connection * connection,
332  DeviceType deviceType,
333  uint32_t deviceIndex,
334  size_t size);
335 
336 #endif // DEVICE_SENSORDEVICE_SENSORDEVICE_H
337 
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:121
bool(* GetOperationModes)(SensorDevice *self)
Get the current Operating Modes of the Device.
Definition: SensorDevice.h:122
Device
Base device.
Definition: SensorDevice.h:30
bool(* GetDisable)(SensorDevice *self)
Ask the Device if it is disabled.
Definition: SensorDevice.h:89
bool(* GetDetectedObjectSizeRestriction)(SensorDevice *self)
Get the current Detected Object Size Restriction of the Device.
Definition: SensorDevice.h:255
CartesianCoordinates Resolution
Resolution of the device.
Definition: SensorDevice.h:31
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:275
The main Connection struct.
Definition: Connection.h:56
TouchActiveArea TouchActiveArea
Touch Active Area of the device.
Definition: SensorDevice.h:32
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:187
bool(* SetNumberOfTrackedObjects)(SensorDevice *self, uint32_t numberOfTrackedObjects)
Set the number of tracked objects.
Definition: SensorDevice.h:312
DLLINTERNAL SensorDevice * SensorDevice_New(Connection *connection, DeviceType deviceType, uint32_t deviceIndex, size_t size)
Internal call used to create a new SensorDevice.
bool(* GetNumberOfTrackedObjects)(SensorDevice *self)
Get the number of tracked objects.
Definition: SensorDevice.h:295
bool(* GetEnable)(SensorDevice *self)
Ask the Device if it is enabled.
Definition: SensorDevice.h:49
bool(* SetOperationModes)(SensorDevice *self, OperationModes modeMask, OperationModes modeValues)
Set the current Operating Modes of the Device.
Definition: SensorDevice.h:145
bool(* GetTouchActiveArea)(SensorDevice *self)
Get the current Touch Active Area of the Device.
Definition: SensorDevice.h:206
bool(* SetDisable)(SensorDevice *self)
Disable the device.
Definition: SensorDevice.h:106
Struct representing a coordinate.
Definition: zForceTypes.h:161
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:69
bool(* SetTouchActiveArea)(SensorDevice *self, uint32_t lowerBoundaryX, uint32_t upperBoundaryX, bool xIsValid, bool xIsReversed, uint32_t lowerBoundaryY, uint32_t upperBoundaryY, bool yIsValid, bool yIsReversed)
Set the current Touch Active Area of the Device.
Definition: SensorDevice.h:231
Struct representing a SensorDevice, a meta device.
Definition: SensorDevice.h:28
bool(* GetResolution)(SensorDevice *self)
Get the current Resolution of the Device.
Definition: SensorDevice.h:163
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:179
bool(* SetEnable)(SensorDevice *self, bool continuousMode, uint32_t numberOfMessages)
Enable the device.
Definition: SensorDevice.h:71