zForceTypes.h

Go to the documentation of this file.

#ifndef ZFORCETYPES_H
#define ZFORCETYPES_H

#ifdef COMPILING_ZFORCE_SDK
typedef struct zForceHandler zForceHandler;
#endif
typedef struct zForce zForce;
typedef struct Connection Connection;
typedef struct Device Device;
typedef struct PlatformDevice PlatformDevice;
typedef struct SensorDevice SensorDevice;
typedef struct CoreDevice CoreDevice;
typedef struct AirDevice AirDevice;
typedef struct PlusDevice PlusDevice;
typedef struct LightingDevice LightingDevice;
typedef struct Protocol Protocol;
typedef struct ProtocolEntry ProtocolEntry;
typedef struct Transport Transport;
typedef struct TransportEntry TransportEntry;
typedef struct DataFrame DataFrame;
typedef struct StreamingDataFrame StreamingDataFrame;
typedef struct Message Message;
typedef struct EnableMessage EnableMessage;
typedef struct DisableMessage DisableMessage;
typedef struct OperationModesMessage OperationModesMessage;
typedef struct ResolutionMessage ResolutionMessage;
typedef struct TouchActiveAreaMessage TouchActiveAreaMessage;
typedef struct TouchMessage TouchMessage;
typedef struct NumberOfTrackedObjectsMessage NumberOfTrackedObjectsMessage;
typedef struct FingerFrequencyMessage FingerFrequencyMessage;
typedef struct IdleFrequencyMessage IdleFrequencyMessage;
typedef struct DetectedObjectSizeRestrictionMessage
                                      DetectedObjectSizeRestrictionMessage;
typedef struct ReverseTouchActiveAreaMessage ReverseTouchActiveAreaMessage;
typedef struct McuUniqueIdentifierMessage McuUniqueIdentifierMessage;
typedef struct OffsetMessage OffsetMessage;
typedef struct HidDisplaySizeMessage HidDisplaySizeMessage;
typedef enum DeviceType DeviceType;
enum DeviceType
{
    None = 0,
    Platform = 1,
    Sensor = 2,
    Core = 4,
    Air = 8,
    Plus = 16,
    Lighting = 32
};

typedef enum MessageType MessageType;
enum MessageType
{
    EnableMessageType,
    DisableMessageType,
    OperationModesMessageType,
    ResolutionMessageType,
    TouchActiveAreaMessageType,
    TouchMessageType,
    DetectedObjectSizeRestrictionMessageType,
    NumberOfTrackedObjectsMessageType,
    FingerFrequencyMessageType,
    IdleFrequencyMessageType,
    ReverseTouchActiveAreaMessageType,
    McuUniqueIdentifierMessageType,
    OffsetMessageType,
    HidDisplaySizeMessageType,
    HighestValidMessageType = HidDisplaySizeMessageType
};

typedef enum MessageGroup MessageGroup;
enum MessageGroup
{
    Request,
    Response,
    Notification,
    HighestValidMessageGroup = Notification
};

typedef enum MessageAction MessageAction;
enum MessageAction
{
    GetAction,   
    SetAction    
};

typedef enum OperationModes OperationModes;
enum OperationModes
{
    NoOperationMode = 0,  
    DetectionMode = 1,    
    SignalsMode = 2,      
    LedLevelsMode = 4,    
    DetectionHidMode = 8, 
    GesturesMode = 16,    
    HighestValidOperationMode = (GesturesMode * 2) - 1
};

typedef enum TouchEvent TouchEvent;
enum TouchEvent
{
    DownEvent,    
    MoveEvent,    
    UpEvent,      
    InvalidEvent, 
    GhostEvent    
};

typedef enum TouchOrientation TouchOrientation;
enum TouchOrientation
{
    PortraitOrientation, 
    LandscapeOrientation 
};

typedef struct CartesianCoordinates CartesianCoordinates;
struct CartesianCoordinates
{
    uint32_t X;    
    bool     HasX; 
    uint32_t Y;    
    bool     HasY; 
    uint32_t Z;    
    bool     HasZ; 
};

typedef struct TouchActiveArea TouchActiveArea;
struct TouchActiveArea
{
    uint32_t LowerBoundaryX; 
    uint32_t UpperBoundaryX; 
    bool     HasX;           
    uint32_t LowerBoundaryY; 
    uint32_t UpperBoundaryY; 
    bool     HasY;           
};

typedef struct ReverseTouchActiveArea ReverseTouchActiveArea;
struct ReverseTouchActiveArea
{
    bool XIsReversed;   
    bool YIsReversed;   
};

#endif // ZFORCETYPES_H