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, bool continuousMode, uint32_t numberOfMessages);
73
88 bool ( * GetDisable)(SensorDevice * self);
89
106 bool ( * SetDisable)(SensorDevice * self);
107
122 bool ( * GetOperationModes)(SensorDevice * self);
145 bool ( * SetOperationModes)(SensorDevice * self, OperationModes modeMask, OperationModes modeValues);
146
161 bool ( * GetResolution)(SensorDevice * self);
185 bool ( * SetResolution)(SensorDevice * self, uint32_t x, bool xIsValid,
186 uint32_t y, bool yIsValid,
187 uint32_t z, bool zIsValid);
188
203 bool ( * GetReverseTouchActiveArea)(SensorDevice * self);
204
222 bool ( * SetReverseTouchActiveArea)(SensorDevice * self, bool xIsReversed, bool yIsReversed);
223
238 bool ( * GetTouchActiveArea)(SensorDevice * self);
239
261 bool ( * SetTouchActiveArea)(SensorDevice * self, uint32_t lowerBoundaryX, uint32_t upperBoundaryX, bool xIsValid,
262 uint32_t lowerBoundaryY, uint32_t upperBoundaryY, bool yIsValid);
263
278 bool ( * GetDetectedObjectSizeRestriction)(SensorDevice * self);
298 bool ( * SetDetectedObjectSizeRestriction)(SensorDevice * self,
299 uint32_t minimumSize,
300 uint32_t maximumSize,
301 bool minimumSizeIsValid,
302 bool maximumSizeIsValid);
303
318 bool ( * GetNumberOfTrackedObjects) (SensorDevice * self);
319
335 bool ( * SetNumberOfTrackedObjects) (SensorDevice * self,
336 uint32_t numberOfTrackedObjects);
337
352 bool ( * GetOffset) (SensorDevice * self);
353
372 bool ( * SetOffset) (SensorDevice * self, uint32_t offsetX, bool offsetXIsValid,
373 uint32_t offsetY, bool offsetYIsValid);
374
389 bool ( * GetHidDisplaySize) (SensorDevice * self);
390
409 bool ( * SetHidDisplaySize) (SensorDevice * self, uint32_t sizeX, bool sizeXIsValid,
410 uint32_t sizeY, bool sizeYIsValid);
411
412 };
413
428 DLLINTERNAL SensorDevice * SensorDevice_New (Connection * connection, DeviceType deviceType, uint32_t deviceIndex,
429 size_t size);
430
431 #endif // DEVICE_SENSORDEVICE_SENSORDEVICE_H
432
OperationModes
OperationModes
Enum describing the OperationModes that a sensor can operate in.
Definition: zForceTypes.h:133
SensorDevice::GetOffset
bool(* GetOffset)(SensorDevice *self)
Get the X and Y offsets.
Definition: SensorDevice.h:352
SensorDevice::GetOperationModes
bool(* GetOperationModes)(SensorDevice *self)
Get the current Operating Modes of the Device.
Definition: SensorDevice.h:122
SensorDevice::Device
Device
Base device.
Definition: SensorDevice.h:30
SensorDevice::SetOffset
bool(* SetOffset)(SensorDevice *self, uint32_t offsetX, bool offsetXIsValid, uint32_t offsetY, bool offsetYIsValid)
Set the X and Y offsets.
Definition: SensorDevice.h:372
SensorDevice::GetDisable
bool(* GetDisable)(SensorDevice *self)
Ask the Device if it is disabled.
Definition: SensorDevice.h:88
SensorDevice::GetDetectedObjectSizeRestriction
bool(* GetDetectedObjectSizeRestriction)(SensorDevice *self)
Get the current Detected Object Size Restriction of the Device.
Definition: SensorDevice.h:278
SensorDevice::Resolution
CartesianCoordinates Resolution
Resolution of the device.
Definition: SensorDevice.h:31
SensorDevice::SetHidDisplaySize
bool(* SetHidDisplaySize)(SensorDevice *self, uint32_t sizeX, bool sizeXIsValid, uint32_t sizeY, bool sizeYIsValid)
Set the Hid Display Size.
Definition: SensorDevice.h:409
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:298
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:222
SensorDevice::GetHidDisplaySize
bool(* GetHidDisplaySize)(SensorDevice *self)
Get the Hid Display Size.
Definition: SensorDevice.h:389
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:185
SensorDevice::SetNumberOfTrackedObjects
bool(* SetNumberOfTrackedObjects)(SensorDevice *self, uint32_t numberOfTrackedObjects)
Set the number of tracked objects.
Definition: SensorDevice.h:335
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:318
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:145
ReverseTouchActiveArea
This structure represents whether the Touch Active Area coordinates are reversed or not...
Definition: zForceTypes.h:209
SensorDevice::GetTouchActiveArea
bool(* GetTouchActiveArea)(SensorDevice *self)
Get the current Touch Active Area of the Device.
Definition: SensorDevice.h:238
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:261
SensorDevice::SetDisable
bool(* SetDisable)(SensorDevice *self)
Disable the device.
Definition: SensorDevice.h:106
CartesianCoordinates
Struct representing a coordinate.
Definition: zForceTypes.h:173
DeviceType
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:77
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:161
TouchActiveArea
This structure represents the Touch Active Area of a sensor.
Definition: zForceTypes.h:191
SensorDevice::GetReverseTouchActiveArea
bool(* GetReverseTouchActiveArea)(SensorDevice *self)
Gets the current reverse setting for the Touch Active Area.
Definition: SensorDevice.h:203
SensorDevice::SetEnable
bool(* SetEnable)(SensorDevice *self, bool continuousMode, uint32_t numberOfMessages)
Enable the device.
Definition: SensorDevice.h:72