Neonode zForce(TM) SDK
Public Attributes | List of all members
AirDevice Struct Reference

Struct representing an AirDevice. More...

#include <AirDevice.h>

Collaboration diagram for AirDevice:
Collaboration graph
[legend]

Public Attributes

zForcezForce
 Pointer to zForce.
 
ConnectionConnection
 The Connection this Device is part of.
 
DeviceType DeviceType
 Which type of Device this is.
 
uint32_t DeviceIndex
 
Device ** StorageDevices
 Future: List of Storage Devices. Will change type during implementation.
 
uint32_t NumberOfStorageDevices
 Number of Storage Devices.
 
void * PrivateProtocolData
 Private Protocol Data.
 
void(* Destructor )(Device *self)
 Destructor. More...
 
CartesianCoordinates Resolution
 Resolution of the device.
 
TouchActiveArea TouchActiveArea
 Touch Active Area of the device.
 
ReverseTouchActiveArea ReverseTouchActiveArea
 Reverse The Touch Active Area of the device.
 
bool(* GetEnable )(SensorDevice *self)
 Ask the Device if it is enabled. More...
 
bool(* SetEnable )(SensorDevice *self, bool continuousMode, uint32_t numberOfMessages)
 Enable the device. More...
 
bool(* GetDisable )(SensorDevice *self)
 Ask the Device if it is disabled. More...
 
bool(* SetDisable )(SensorDevice *self)
 Disable the device. More...
 
bool(* GetOperationModes )(SensorDevice *self)
 Get the current Operating Modes of the Device. More...
 
bool(* SetOperationModes )(SensorDevice *self, OperationModes modeMask, OperationModes modeValues)
 Set the current Operating Modes of the Device. More...
 
bool(* GetResolution )(SensorDevice *self)
 Get the current Resolution of the Device. More...
 
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. More...
 
bool(* GetReverseTouchActiveArea )(SensorDevice *self)
 Gets the current reverse setting for the Touch Active Area. More...
 
bool(* SetReverseTouchActiveArea )(SensorDevice *self, bool xIsReversed, bool yIsReversed)
 Reverse the Touch Active Area of the Device. More...
 
bool(* GetFlipXY )(SensorDevice *self)
 Gets the current FlipXY setting. More...
 
bool(* SetFlipXY )(SensorDevice *self, bool axesAreFlipped)
 Sets the FlipXY setting. More...
 
bool(* GetReflectiveEdgeFilter )(SensorDevice *self)
 Gets the current ReflectiveEdgeFilter setting. More...
 
bool(* SetReflectiveEdgeFilter )(SensorDevice *self, bool isFilterOn)
 Sets the ReflectiveEdgeFilter setting. More...
 
bool(* GetMergeTouches )(SensorDevice *self)
 Gets the current MergeTouches setting. More...
 
bool(* SetMergeTouches )(SensorDevice *self, bool areTouchesMerged)
 Sets the MergeTouches setting. More...
 
bool(* GetTouchActiveArea )(SensorDevice *self)
 Get the current Touch Active Area of the Device. More...
 
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. More...
 
bool(* GetDetectedObjectSizeRestriction )(SensorDevice *self)
 Get the current Detected Object Size Restriction of the Device. More...
 
bool(* SetDetectedObjectSizeRestriction )(SensorDevice *self, uint32_t minimumSize, uint32_t maximumSize, bool minimumSizeIsValid, bool maximumSizeIsValid)
 Set the current Detected Object Size Restriction of the Device. More...
 
bool(* GetNumberOfTrackedObjects )(SensorDevice *self)
 Get the number of tracked objects. More...
 
bool(* SetNumberOfTrackedObjects )(SensorDevice *self, uint32_t numberOfTrackedObjects)
 Set the number of tracked objects. More...
 
bool(* GetOffset )(SensorDevice *self)
 Get the X and Y offsets. More...
 
bool(* SetOffset )(SensorDevice *self, uint32_t offsetX, bool offsetXIsValid, uint32_t offsetY, bool offsetYIsValid)
 Set the X and Y offsets. More...
 
bool(* GetHidDisplaySize )(SensorDevice *self)
 Get the Hid Display Size. More...
 
bool(* SetHidDisplaySize )(SensorDevice *self, uint32_t sizeX, bool sizeXIsValid, uint32_t sizeY, bool sizeYIsValid)
 Set the Hid Display Size. More...
 
bool(* GetTouchMode )(SensorDevice *self)
 Get the Touch Mode. More...
 
bool(* SetTouchMode )(SensorDevice *self, TouchModes touchMode, bool touchModeIsValid, uint32_t clickOnTouchTime, bool clickOnTouchTimeIsValid, uint32_t clickOnTouchRadius, bool clickOnTouchRadiusIsValid)
 Set the Touch Mode. More...
 
bool(* GetFloatingProtection )(SensorDevice *self)
 Get the state of Floating Protection. More...
 
bool(* SetFloatingProtection )(SensorDevice *self, bool enabled, bool enabledIsValid, uint32_t time, bool timeIsValid)
 Set Floating Protection. More...
 

Detailed Description

Struct representing an AirDevice.

Struct representing an AirDevice. AirDevice is a specific implementation of a SensorDevice for zForce Air(TM).

Member Data Documentation

void( * AirDevice::Destructor) (Device *self)

Destructor.

Destructs the Device and all base structs.

Parameters
selfPointer to the struct itself.
Returns
No return value.
uint32_t AirDevice::DeviceIndex

Which Device Index this device has.

bool( * AirDevice::GetDetectedObjectSizeRestriction) (SensorDevice *self)

Get the current Detected Object Size Restriction of the Device.

Gets the current Detected Object Size Restriction.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetDisable) (SensorDevice *self)

Ask the Device if it is disabled.

Ask the device if it is disabled.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetEnable) (SensorDevice *self)

Ask the Device if it is enabled.

Ask the Device if it is enabled. Also reports if the device is in continuous mode and number of messages left to receive.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetFlipXY) (SensorDevice *self)

Gets the current FlipXY setting.

Gets the current FlipXY setting.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetFloatingProtection) (SensorDevice *self)

Get the state of Floating Protection.

Get the state of Floating Protection.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetHidDisplaySize) (SensorDevice *self)

Get the Hid Display Size.

Get the Hid Display Size.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetMergeTouches) (SensorDevice *self)

Gets the current MergeTouches setting.

Gets the current MergeTouches setting.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetNumberOfTrackedObjects) (SensorDevice *self)

Get the number of tracked objects.

Get the number of tracked objects.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetOffset) (SensorDevice *self)

Get the X and Y offsets.

Get the X and Y offsets.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetOperationModes) (SensorDevice *self)

Get the current Operating Modes of the Device.

Gets the current Operating Modes of the Device as two bitmasks.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetReflectiveEdgeFilter) (SensorDevice *self)

Gets the current ReflectiveEdgeFilter setting.

Gets the current ReflectiveEdgeFilter setting.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetResolution) (SensorDevice *self)

Get the current Resolution of the Device.

Gets the current Resolution of the Device.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetReverseTouchActiveArea) (SensorDevice *self)

Gets the current reverse setting for the Touch Active Area.

Gets the current reverse setting for the Touch Active Area.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetTouchActiveArea) (SensorDevice *self)

Get the current Touch Active Area of the Device.

Gets the current Touch Active Area of the Device.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::GetTouchMode) (SensorDevice *self)

Get the Touch Mode.

Get the Touch Mode.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetDetectedObjectSizeRestriction) (SensorDevice *self, uint32_t minimumSize, uint32_t maximumSize, bool minimumSizeIsValid, bool maximumSizeIsValid)

Set the current Detected Object Size Restriction of the Device.

Sets the current Detected Object Size Restriction of the device.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
minimumSizeThe minimum object size to detect by device.
maximumSizeThe maximum object size to detect by device.
minimumSizeIsValidSet to True to alter minimumSize detection.
maximumSizeIsValidSet to True to alter maximumSize detection.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetDisable) (SensorDevice *self)

Disable the device.

Disable the device. Messages will stop arriving as soon as the Device processes the request, but Messages already in progress will still arrive as normal.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetEnable) (SensorDevice *self, bool continuousMode, uint32_t numberOfMessages)

Enable the device.

Enable the device and set it to either continuous mode or a specified number of messages. Not all protocols handle non-continuous mode.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
continuousModeSet to true for continuous mode.
numberOfMessagesWhen in non-continuous mode, specifies how many Messages to receive before the Device disables itself. May not be 0 when continuousMode == false.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetFlipXY) (SensorDevice *self, bool axesAreFlipped)

Sets the FlipXY setting.

Enables/Disables flipping the X-axis and Y-axis.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
axesAreflippedTrue to flip the axes.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetFloatingProtection) (SensorDevice *self, bool enabled, bool enabledIsValid, uint32_t time, bool timeIsValid)

Set Floating Protection.

Set Floating Protection.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
enabledFloating Protection is enabled.
enabledIsValidEnable is valid, i.e. you want to Enable/Disable Floating Protection.
timeFloating Protection Time in ms.
timeIsValidFloating Protection Time is valid, i.e. you want to set Floating Protection Time.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetHidDisplaySize) (SensorDevice *self, uint32_t sizeX, bool sizeXIsValid, uint32_t sizeY, bool sizeYIsValid)

Set the Hid Display Size.

Set the Hid Display Size.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
sizeXX Size.
sizeXIsValidX Size is valid, i.e. you want to set Size X.
sizeYY Size.
sizeYIsValidY Size is valid, i.e. you want to set Size Y.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetMergeTouches) (SensorDevice *self, bool areTouchesMerged)

Sets the MergeTouches setting.

Enables/Disables the MergeTouches setting in the sensor.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
areTouchesMergedis true if the touches are merged, otherwise false.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetNumberOfTrackedObjects) (SensorDevice *self, uint32_t numberOfTrackedObjects)

Set the number of tracked objects.

Set the number of tracked objects.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
numberOfTrackedObjectsTracked object count.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetOffset) (SensorDevice *self, uint32_t offsetX, bool offsetXIsValid, uint32_t offsetY, bool offsetYIsValid)

Set the X and Y offsets.

Set the X and Y offsets.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
offsetXX Offset.
offsetXIsValidOffset X is valid, i.e. you want to set X Offset.
offsetYY Offset.
offsetYIsValidOffset Y is valid, i.e. you want to set Y Offset.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetOperationModes) (SensorDevice *self, OperationModes modeMask, OperationModes modeValues)

Set the current Operating Modes of the Device.

Sets the current Operating Modes of the Device as two bitmasks. Setting the modeMask bit for a specific Mode to 1 changes it to become the corresponding bit in modeValues but setting the bit to 0 does not change it.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
modeMaskA bit set to 1 means set to the corresponding bit in the modeValue field and 0 means do not change this bit.
modeValueThe value to set the bits to.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetReflectiveEdgeFilter) (SensorDevice *self, bool isFilterOn)

Sets the ReflectiveEdgeFilter setting.

Enables/Disables the ReflectiveEdgeFilter.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
isFilterOnis true if the filter is on, otherwise false.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::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.

Sets the current Resolution of the Device.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
xThe Resolution of the X axis.
xIsValidSet to true to change this value or false to ignore it. Ignored on a Device that does not allow it.
yThe Resolution of the Y axis.
yIsValidSet to true to change this value or false to ignore it. Ignored on a Device that does not allow it.
zThe Resolution of the Z axis.
zIsValidSet to true to change this value or false to ignore it. Ignored on a Device that does not allow it.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetReverseTouchActiveArea) (SensorDevice *self, bool xIsReversed, bool yIsReversed)

Reverse the Touch Active Area of the Device.

Reverse the Touch Active Area of the Device.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
xIsReversedTrue to reverse the X axis.
yIsReversedTrue to reverse the Y axis.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::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.

Sets the current Touch Active Area of the Device.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
lowerBoundaryXThe lower boundary for the X axis to set.
upperBoundaryXThe upper boundary for teh X axis to set.
xIsValidSet to true to change the values or false to ignore.
lowerBoundaryYThe lower boundary for the Y axis to set.
upperBoundaryYThe upper boundary for teh Y axis to set.
yIsValidSet to true to change the values or false to ignore.
Returns
True for success, false for failure. See errno.
bool( * AirDevice::SetTouchMode) (SensorDevice *self, TouchModes touchMode, bool touchModeIsValid, uint32_t clickOnTouchTime, bool clickOnTouchTimeIsValid, uint32_t clickOnTouchRadius, bool clickOnTouchRadiusIsValid)

Set the Touch Mode.

Set the Touch Mode.

On failure, errno is set.

Parameters
selfPointer to the struct itself.
touchModeTouch Mode to set.
touchModeIsValidTouch Mode is valid, i.e. you want to set Touch Mode.
clickOnTouchTimeClick on Touch Time in ms.
clickOnTouchTimeIsValidClick On Touch Time is valid, i.e. you want to set Click On Touch Time.
clickOnTouchRadiusClick on Touch Radius in ms.
clickOnTouchRadiusIsValidClick On Touch Radius is valid, i.e. you want to set Click On Touch Radius.
Returns
True for success, false for failure. See errno.

The documentation for this struct was generated from the following file: