path: root/gfx/vr/service/osvr/Util/ClientReportTypesC.h

/** @file
    @brief Header

    Must be c-safe!

    @date 2014

    @author
    Sensics, Inc.
    <http://sensics.com/osvr>
*/

/*
// Copyright 2014 Sensics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/

#ifndef INCLUDED_ClientReportTypesC_h_GUID_E79DAB07_78B7_4795_1EB9_CA6EEB274AEE
#define INCLUDED_ClientReportTypesC_h_GUID_E79DAB07_78B7_4795_1EB9_CA6EEB274AEE

/* Internal Includes */
#include <osvr/Util/APIBaseC.h>
#include <osvr/Util/Pose3C.h>
#include <osvr/Util/StdInt.h>

#include <osvr/Util/Vec2C.h>
#include <osvr/Util/Vec3C.h>
#include <osvr/Util/ChannelCountC.h>
#include <osvr/Util/BoolC.h>

/* Library/third-party includes */
/* none */

/* Standard includes */
/* none */

OSVR_EXTERN_C_BEGIN

/** @addtogroup ClientKit
    @{
*/

/** @name State types
@{
*/
/** @brief Type of position state */
typedef OSVR_Vec3 OSVR_PositionState;

/** @brief Type of orientation state */
typedef OSVR_Quaternion OSVR_OrientationState;

/** @brief Type of pose state */
typedef OSVR_Pose3 OSVR_PoseState;

/** @brief Type of linear velocity state */
typedef OSVR_Vec3 OSVR_LinearVelocityState;

/** @brief The quaternion represents the incremental rotation taking place over
    a period of dt seconds. Use of dt (which does not necessarily
    have to be 1, as other velocity/acceleration representations imply) and an
    incremental quaternion allows device reports to be scaled to avoid aliasing
*/
typedef struct OSVR_IncrementalQuaternion {
  OSVR_Quaternion incrementalRotation;
  double dt;
} OSVR_IncrementalQuaternion;

/** @brief Type of angular velocity state: an incremental quaternion, providing
    the incremental rotation taking place due to velocity over a period of dt
    seconds.
*/
typedef OSVR_IncrementalQuaternion OSVR_AngularVelocityState;

/** @brief Struct for combined velocity state */
typedef struct OSVR_VelocityState {
  OSVR_LinearVelocityState linearVelocity;
  /** @brief Whether the data source reports valid data for
      #OSVR_VelocityState::linearVelocity */
  OSVR_CBool linearVelocityValid;

  OSVR_AngularVelocityState angularVelocity;
  /** @brief Whether the data source reports valid data for
  #OSVR_VelocityState::angularVelocity */
  OSVR_CBool angularVelocityValid;
} OSVR_VelocityState;

/** @brief Type of linear acceleration state */
typedef OSVR_Vec3 OSVR_LinearAccelerationState;

/** @brief Type of angular acceleration state
 */
typedef OSVR_IncrementalQuaternion OSVR_AngularAccelerationState;

/** @brief Struct for combined acceleration state */
typedef struct OSVR_AccelerationState {
  OSVR_LinearAccelerationState linearAcceleration;
  /** @brief Whether the data source reports valid data for
  #OSVR_AccelerationState::linearAcceleration */
  OSVR_CBool linearAccelerationValid;

  OSVR_AngularAccelerationState angularAcceleration;
  /** @brief Whether the data source reports valid data for
  #OSVR_AccelerationState::angularAcceleration */
  OSVR_CBool angularAccelerationValid;
} OSVR_AccelerationState;

/** @brief Type of button state */
typedef uint8_t OSVR_ButtonState;

/** @brief OSVR_ButtonState value indicating "button down" */
#define OSVR_BUTTON_PRESSED (1)

/** @brief OSVR_ButtonState value indicating "button up" */
#define OSVR_BUTTON_NOT_PRESSED (0)

/** @brief Type of analog channel state */
typedef double OSVR_AnalogState;

/** @} */

/** @name Report types
    @{
*/
/** @brief Report type for a position callback on a tracker interface */
typedef struct OSVR_PositionReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The position vector */
  OSVR_PositionState xyz;
} OSVR_PositionReport;

/** @brief Report type for an orientation callback on a tracker interface */
typedef struct OSVR_OrientationReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The rotation unit quaternion */
  OSVR_OrientationState rotation;
} OSVR_OrientationReport;

/** @brief Report type for a pose (position and orientation) callback on a
    tracker interface
*/
typedef struct OSVR_PoseReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The pose structure, containing a position vector and a rotation
      quaternion
  */
  OSVR_PoseState pose;
} OSVR_PoseReport;

/** @brief Report type for a velocity (linear and angular) callback on a
    tracker interface
*/
typedef struct OSVR_VelocityReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The data state - note that not all fields are neccesarily valid,
      use the `Valid` members to check the status of the other fields.
  */
  OSVR_VelocityState state;
} OSVR_VelocityReport;

/** @brief Report type for a linear velocity callback on a tracker interface
 */
typedef struct OSVR_LinearVelocityReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The state itself */
  OSVR_LinearVelocityState state;
} OSVR_LinearVelocityReport;

/** @brief Report type for an angular velocity callback on a tracker interface
 */
typedef struct OSVR_AngularVelocityReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The state itself */
  OSVR_AngularVelocityState state;
} OSVR_AngularVelocityReport;

/** @brief Report type for an acceleration (linear and angular) callback on a
    tracker interface
*/
typedef struct OSVR_AccelerationReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The data state - note that not all fields are neccesarily valid,
      use the `Valid` members to check the status of the other fields.
  */
  OSVR_AccelerationState state;
} OSVR_AccelerationReport;

/** @brief Report type for a linear acceleration callback on a tracker interface
 */
typedef struct OSVR_LinearAccelerationReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The state itself */
  OSVR_LinearAccelerationState state;
} OSVR_LinearAccelerationReport;

/** @brief Report type for an angular acceleration callback on a tracker
    interface
*/
typedef struct OSVR_AngularAccelerationReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The state itself */
  OSVR_AngularAccelerationState state;
} OSVR_AngularAccelerationReport;

/** @brief Report type for a callback on a button interface */
typedef struct OSVR_ButtonReport {
  /** @brief Identifies the sensor that the report comes from */
  int32_t sensor;
  /** @brief The button state: 1 is pressed, 0 is not pressed. */
  OSVR_ButtonState state;
} OSVR_ButtonReport;

/** @brief Report type for a callback on an analog interface */
typedef struct OSVR_AnalogReport {
  /** @brief Identifies the sensor/channel that the report comes from */
  int32_t sensor;
  /** @brief The analog state. */
  OSVR_AnalogState state;
} OSVR_AnalogReport;

/** @brief Type of location within a 2D region/surface, in normalized
    coordinates (in range [0, 1] in standard OSVR coordinate system)
*/
typedef OSVR_Vec2 OSVR_Location2DState;

/** @brief Report type for 2D location */
typedef struct OSVR_Location2DReport {
  OSVR_ChannelCount sensor;
  OSVR_Location2DState location;
} OSVR_Location2DReport;

/** @brief Type of unit directional vector in 3D with no particular origin */
typedef OSVR_Vec3 OSVR_DirectionState;

/** @brief Report type for 3D Direction vector */
typedef struct OSVR_DirectionReport {
  OSVR_ChannelCount sensor;
  OSVR_DirectionState direction;
} OSVR_DirectionReport;

/** @brief Type of eye gaze direction in 3D which contains 3D vector (position)
    containing gaze base point of the user's respective eye in 3D device
    coordinates.
*/
typedef OSVR_PositionState OSVR_EyeGazeBasePoint3DState;

/** @brief Type of eye gaze position in 2D which contains users's gaze/point of
    regard in normalized display coordinates (in range [0, 1] in standard OSVR
    coordinate system)
*/
typedef OSVR_Location2DState OSVR_EyeGazePosition2DState;

// typedef OSVR_DirectionState OSVR_EyeGazeBasePoint3DState;

/** @brief Type of 3D vector (direction vector) containing the normalized gaze
    direction of user's respective eye */
typedef OSVR_DirectionState OSVR_EyeGazeDirectionState;

/** @brief State for 3D gaze report */
typedef struct OSVR_EyeTracker3DState {
  OSVR_CBool directionValid;
  OSVR_DirectionState direction;
  OSVR_CBool basePointValid;
  OSVR_PositionState basePoint;
} OSVR_EyeTracker3DState;

/** @brief Report type for 3D gaze report */
typedef struct OSVR_EyeTracker3DReport {
  OSVR_ChannelCount sensor;
  OSVR_EyeTracker3DState state;
} OSVR_EyeTracker3DReport;

/** @brief State for 2D location report */
typedef OSVR_Location2DState OSVR_EyeTracker2DState;

/** @brief Report type for 2D location report */
typedef struct OSVR_EyeTracker2DReport {
  OSVR_ChannelCount sensor;
  OSVR_EyeTracker2DState state;
} OSVR_EyeTracker2DReport;

/** @brief State for a blink event */
typedef OSVR_ButtonState OSVR_EyeTrackerBlinkState;

/** @brief OSVR_EyeTrackerBlinkState value indicating an eyes blink had occurred
 */
#define OSVR_EYE_BLINK (1)

/** @brief OSVR_EyeTrackerBlinkState value indicating eyes are not blinking */
#define OSVR_EYE_NO_BLINK (0)

/** @brief Report type for a blink event */
typedef struct OSVR_EyeTrackerBlinkReport {
  OSVR_ChannelCount sensor;
  OSVR_EyeTrackerBlinkState state;
} OSVR_EyeTrackerBlinkReport;

/** @brief Report type for an Imaging callback (forward declaration) */
struct OSVR_ImagingReport;

/** @brief Type of Navigation Velocity state */
typedef OSVR_Vec2 OSVR_NaviVelocityState;

/** @brief Type of Navigation Position state */
typedef OSVR_Vec2 OSVR_NaviPositionState;

/** @brief Report type for an navigation velocity callback on a tracker
 * interface */
typedef struct OSVR_NaviVelocityReport {
  OSVR_ChannelCount sensor;
  /** @brief The 2D vector in world coordinate system, in meters/second */
  OSVR_NaviVelocityState state;
} OSVR_NaviVelocityReport;

/** @brief Report type for an navigation position callback on a tracker
 * interface */
typedef struct OSVR_NaviPositionReport {
  OSVR_ChannelCount sensor;
  /** @brief The 2D vector in world coordinate system, in meters, relative to
   * starting position */
  OSVR_NaviPositionState state;
} OSVR_NaviPositionReport;

/** @} */

/** @} */
OSVR_EXTERN_C_END

#endif