OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Locomotion interface (base C API)

Sending locomotion reports from a device in your plugin. More...

Typedefs

typedef struct
OSVR_LocomotionDeviceInterfaceObject
OSVR_LocomotionDeviceInterface
 Opaque type used in conjunction with a device token to send data on Locomotion Interface.
 

Functions

OSVR_ReturnCode osvrDeviceLocomotionConfigure (OSVR_DeviceInitOptions opts, OSVR_LocomotionDeviceInterface *iface)
 Specify that your device will implement the Locomotion interface. More...
 
OSVR_ReturnCode osvrDeviceLocomotionReportNaviVelocity (OSVR_LocomotionDeviceInterface iface, OSVR_NaviVelocityState naviVelocity, OSVR_ChannelCount sensor, OSVR_TimeValue const *timestamp)
 Report velocity data for a specific sensor. More...
 
OSVR_ReturnCode osvrDeviceLocomotionReportNaviPosition (OSVR_LocomotionDeviceInterface iface, OSVR_NaviPositionState naviPosition, OSVR_ChannelCount sensor, OSVR_TimeValue const *timestamp)
 Report position data for a specific sensor. More...
 

Detailed Description

Sending locomotion reports from a device in your plugin.

Function Documentation

OSVR_ReturnCode osvrDeviceLocomotionConfigure ( OSVR_DeviceInitOptions  opts,
OSVR_LocomotionDeviceInterface iface 
)

#include <osvr/PluginKit/LocomotionInterfaceC.h>

Specify that your device will implement the Locomotion interface.

Parameters
optsThe device init options object.
[out]ifaceAn interface object you should retain with the same lifetime as the device token in order to send messages conforming to an Locomotion interface.
numSensorsThe number of sensors you will be reporting Locomotion data : You can report for 1 sensor per device.

Definition at line 48 of file LocomotionInterfaceC.cpp.

OSVR_ReturnCode osvrDeviceLocomotionReportNaviVelocity ( OSVR_LocomotionDeviceInterface  iface,
OSVR_NaviVelocityState  naviVelocity,
OSVR_ChannelCount  sensor,
OSVR_TimeValue const *  timestamp 
)

#include <osvr/PluginKit/LocomotionInterfaceC.h>

Report velocity data for a specific sensor.

Parameters
devDevice token
ifaceLocomotion Interface
naviVelocitynavigation velocity
sensorSensor number
timestampTimestamp correlating to navigation velocity

Definition at line 63 of file LocomotionInterfaceC.cpp.

OSVR_ReturnCode osvrDeviceLocomotionReportNaviPosition ( OSVR_LocomotionDeviceInterface  iface,
OSVR_NaviPositionState  naviPosition,
OSVR_ChannelCount  sensor,
OSVR_TimeValue const *  timestamp 
)

#include <osvr/PluginKit/LocomotionInterfaceC.h>

Report position data for a specific sensor.

Parameters
devDevice token
ifaceLocomotion Interface
naviPositionnavigation position
sensorSensor number
timestampTimestamp correlating to navigation position

Definition at line 78 of file LocomotionInterfaceC.cpp.