gfTypes.h

Go to the documentation of this file.

/*
 * Copyright 2017, OYMotion Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 */
#pragma once


#include <iostream>
#include <string>
#include <memory>

#if defined(WIN32)
#include "tchar.h"
#endif

namespace gf {

    typedef char                GF_CHAR;
    typedef char*               GF_PCHAR;
    typedef const char*         GF_CPCHAR;
    typedef unsigned int        GF_UINT;
    typedef int                 GF_INT;
    typedef float               GF_FLOAT;

    typedef unsigned char       GF_UINT8;
    typedef unsigned char*      GF_PUINT8;
    typedef unsigned short      GF_UINT16;
    typedef unsigned short*     GF_PUINT16;
    typedef unsigned int        GF_UINT32;
    typedef unsigned long long  GF_UINT64;

    typedef size_t              GF_SIZE;
    typedef GF_INT              GF_STATUS;
    typedef void*               GF_HANDLE;

#if defined(UNICODE) || defined(_UNICODE)

    using tstring = std::wstring;
    typedef wchar_t tchar;
#if ! defined(WIN32) || ! defined(_T)
#define _T(x) L ## x
#endif

#else // UNICODE

    using tstring = std::string;
    typedef char tchar;
#if ! defined(WIN32) || ! defined(_T)
#define _T(x) x
#endif

#endif // UNICODE

    template <typename T>
    using gfwPtr = std::weak_ptr < T >;
    template <typename T>
    using gfsPtr = std::shared_ptr < T >;

    class Device;
    using WPDEVICE = gfwPtr<Device>;
    using SPDEVICE = gfsPtr<Device>;

    enum class WorkMode {
        Freerun,
        Polling,
    };

    enum class GF_RET_CODE : GF_UINT32 {
        GF_SUCCESS = 0,
        GF_ERROR,
        GF_ERROR_BAD_PARAM,
        GF_ERROR_BAD_STATE,
        GF_ERROR_NOT_SUPPORT,
        GF_ERROR_SCAN_BUSY,
        GF_ERROR_NO_RESOURCE,
        GF_ERROR_TIMEOUT,
        GF_ERROR_DEVICE_BUSY,
        GF_ERROR_NOT_READY,
    };

    enum class Gesture : GF_UINT8 {
        Relax = 0x00,
        Fist = 0x01,
        SpreadFingers = 0x02,
        WaveIn = 0x03,
        WaveOut = 0x04,
        Pinch = 0x05,
        Shoot = 0x06,
        UserDefine1 = 0x07,
        UserDefine2 = 0x08,
        UserDefine3 = 0x09,
        UserDefine4 = 0x0A,
        UserDefine5 = 0x0B,
        UserDefine6 = 0x0C,
        UserDefine7 = 0x0D,
        UserDefine8 = 0x0E,
        UserDefine9 = 0x0F,
        Undefined = 0xFF
    };

    enum class DeviceStatus : GF_UINT8 {
        None = 0,
        ReCenter = 1,
        UsbPlugged = 2,
        UsbPulled = 3,
        Motionless = 4,
    };

    enum class HubState {
        Idle,
        Scanning,
        Connecting,
        Disconnected,
        Unknown
    };

    enum class DeviceConnectionStatus {
        Disconnected,
        Disconnecting,
        Connecting,
        Connected
    };

    enum class DeviceDataType : GF_UINT32 {
        DDT_INVALID = 0,
        DDT_ACCELERATE,
        DDT_GYROSCOPE,
        DDT_MAGNETOMETER,
        DDT_EULERANGLE,
        DDT_QUATERNION,
        DDT_ROTATIONMATRIX,
        DDT_GESTURE,
        DDT_EMGRAW,
        DDT_HIDMOUSE,
        DDT_HIDJOYSTICK,
        DDT_DEVICESTATUS,
        DDT_MAX
    };

    enum class ProfileCharType : GF_UINT8 {
        PROF_SIMPLE_DATA = 0,   //simple profile: data char
        PROF_DATA_CMD,   //data profile: cmd char
        PROF_DATA_NTF,   //data profile：nty char
        PROF_OAD_IDENTIFY, //OAD profile：identify char
        PROF_OAD_BLOCK,  //OAD profile：block char
        PROF_OAD_FAST    //OAD profile：fast char
    };

} // namespace gf