YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::OVRHeadset Class Reference

Device that manages the Oculus Rift Headset. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-device-ovrheadset/src/devices/ovrheadset/OVRHeadset.h>

+ Inheritance diagram for yarp::dev::OVRHeadset:

Public Member Functions

 OVRHeadset ()
 
virtual ~OVRHeadset ()
 
virtual bool open (yarp::os::Searchable &cfg)
 Open the DeviceDriver.
 
virtual bool close ()
 Close the DeviceDriver.
 
virtual bool threadInit ()
 Initialization method.
 
virtual void threadRelease ()
 Release method.
 
virtual void run ()
 Loop function.
 
virtual bool startService ()
 Initiate the service, whatever it is.
 
virtual bool updateService ()
 Give the service the chance to run for a while.
 
virtual bool stopService ()
 Shut down the service, whatever it is.
 
bool getAxisCount (unsigned int &axis_count) override
 
bool getButtonCount (unsigned int &button_count) override
 
bool getTrackballCount (unsigned int &Trackball_count) override
 
bool getHatCount (unsigned int &Hat_count) override
 
bool getTouchSurfaceCount (unsigned int &touch_count) override
 
bool getStickCount (unsigned int &stick_count) override
 
bool getStickDoF (unsigned int stick_id, unsigned int &DoF) override
 
bool getButton (unsigned int button_id, float &value) override
 
bool getTrackball (unsigned int trackball_id, yarp::sig::Vector &value) override
 
bool getHat (unsigned int hat_id, unsigned char &value) override
 
bool getAxis (unsigned int axis_id, double &value) override
 
bool getStick (unsigned int stick_id, yarp::sig::Vector &value, JoypadCtrl_coordinateMode coordinate_mode) override
 
bool getTouch (unsigned int touch_id, yarp::sig::Vector &value) override
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriver & operator= (const DeviceDriver &other)=delete
 
DeviceDriver & operator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDriver * getImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from yarp::os::PeriodicThread
 PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
 Constructor.
 
 PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
 Constructor.
 
virtual ~PeriodicThread ()
 
bool start ()
 Call this to start the thread.
 
void step ()
 Call this to "step" the thread rather than starting it.
 
void stop ()
 Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).
 
void askToStop ()
 Stop the thread.
 
bool isRunning () const
 Returns true when the thread is started, false otherwise.
 
bool isSuspended () const
 Returns true when the thread is suspended, false otherwise.
 
bool setPeriod (double period)
 Set the (new) period of the thread.
 
double getPeriod () const
 Return the current period of the thread.
 
void suspend ()
 Suspend the thread, the thread keeps running by doLoop is never executed.
 
void resume ()
 Resume the thread if previously suspended.
 
void resetStat ()
 Reset thread statistics.
 
double getEstimatedPeriod () const
 Return estimated period since last reset.
 
void getEstimatedPeriod (double &av, double &std) const
 Return estimated period since last reset.
 
unsigned int getIterations () const
 Return the number of iterations performed since last reset.
 
double getEstimatedUsed () const
 Return the estimated duration of the run() function since last reset.
 
void getEstimatedUsed (double &av, double &std) const
 Return estimated duration of the run() function since last reset.
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that.
 
int getPriority () const
 Query the current priority of the thread, if the OS supports that.
 
int getPolicy () const
 Query the current scheduling policy of the thread, if the OS supports that.
 
- Public Member Functions inherited from yarp::dev::IService
virtual ~IService ()
 
- Public Member Functions inherited from yarp::dev::IJoypadController
virtual ~IJoypadController ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxisCount (size_t &axis_count)=0
 Get number of axes.
 
virtual yarp::dev::ReturnValue getButtonCount (size_t &button_count)=0
 Get number of buttons.
 
virtual yarp::dev::ReturnValue getTrackballCount (size_t &Trackball_count)=0
 Get number of trackballs.
 
virtual yarp::dev::ReturnValue getHatCount (size_t &Hat_count)=0
 Get number of hats.
 
virtual yarp::dev::ReturnValue getTouchSurfaceCount (size_t &touch_count)=0
 Get the number of touch surface.
 
virtual yarp::dev::ReturnValue getStickCount (size_t &stick_count)=0
 Get the number of the sticks.
 
virtual yarp::dev::ReturnValue getButton (size_t button_id, double &value)=0
 Get the value of a button.
 
virtual yarp::dev::ReturnValue getTrackball (size_t trackball_id, yarp::dev::TrackballData &value)=0
 Get the axes change of a Trackball.
 
virtual yarp::dev::ReturnValue getHat (size_t hat_id, unsigned char &value)=0
 Get the value of an Hat.
 
virtual yarp::dev::ReturnValue getAxis (size_t axis_id, double &value)=0
 Get the value of an axis if present, return false otherwise.
 
virtual yarp::dev::ReturnValue getAllAxes (std::vector< double > &values)
 Get the values of all available joystick axes.
 
virtual yarp::dev::ReturnValue getStick (size_t stick_id, yarp::dev::StickData &value, JoypadCtrl_coordinateMode coordinate_mode)=0
 Get the value of a stick if present, return false otherwise.
 
virtual yarp::dev::ReturnValue getTouch (size_t touch_id, std::vector< yarp::dev::TouchData > &value)=0
 Get the value of a touch if present, return false otherwise.
 

Additional Inherited Members

- Public Types inherited from yarp::dev::IJoypadController
enum class  JoypadCtrl_coordinateMode {
  JypCtrlcoord_POLAR = 0 ,
  JypCtrlcoord_CARTESIAN = 1
}
 
- Protected Member Functions inherited from yarp::os::PeriodicThread
virtual void beforeStart ()
 Called just before a new thread starts.
 
virtual void afterStart (bool success)
 Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start().
 

Detailed Description

Device that manages the Oculus Rift Headset.

Description of input parameters

Parameters accepted in the config argument of the open method:

Parameter name Type Units Default Value Required Description Notes
tfLocal string yes local port name receiving and posting tf
tfRemote string yes name of the transformServer port
tf_left_hand_frame string Yes name of the left hand frame
tf_right_hand_frame string yes name of the right hand frame
tf_root_frame string yes name of the root frame
stick_as_axis bool yes if axes shoud be published as sticks
gui_elements int yes number of the gui element to visualize
hands_relative bool false no if the hand pose should be w.r.t. head

Gui Groups parameters | Parameter name | Type | Units | Default Value | Required | Description | Notes | | width | double | pixel | | yes | width of the widget | | | height | double | pixel | | yes | height of the widget | | | x | double | pixel | | yes | x position of the widget | | | y | double | pixel | | yes | y position of the widget | | | z | double | pixel | | yes | z position of the widget | | | alpha | double | | | yes | alpha value of the widget | |

Definition at line 79 of file OVRHeadset.h.

Constructor & Destructor Documentation

◆ OVRHeadset()

yarp::dev::OVRHeadset::OVRHeadset ( )
explicit

Definition at line 263 of file OVRHeadset.cpp.

◆ ~OVRHeadset()

yarp::dev::OVRHeadset::~OVRHeadset ( )
virtual

Definition at line 269 of file OVRHeadset.cpp.

Member Function Documentation

◆ close()

bool yarp::dev::OVRHeadset::close ( )
virtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 828 of file OVRHeadset.cpp.

◆ getAxis()

bool yarp::dev::OVRHeadset::getAxis ( unsigned int  axis_id,
double &  value 
)
override

Definition at line 1616 of file OVRHeadset.cpp.

◆ getAxisCount()

bool yarp::dev::OVRHeadset::getAxisCount ( unsigned int &  axis_count)
override

Definition at line 1534 of file OVRHeadset.cpp.

◆ getButton()

bool yarp::dev::OVRHeadset::getButton ( unsigned int  button_id,
float &  value 
)
override

Definition at line 1582 of file OVRHeadset.cpp.

◆ getButtonCount()

bool yarp::dev::OVRHeadset::getButtonCount ( unsigned int &  button_count)
override

Definition at line 1541 of file OVRHeadset.cpp.

◆ getHat()

bool yarp::dev::OVRHeadset::getHat ( unsigned int  hat_id,
unsigned char &  value 
)
override

Definition at line 1600 of file OVRHeadset.cpp.

◆ getHatCount()

bool yarp::dev::OVRHeadset::getHatCount ( unsigned int &  Hat_count)
override

Definition at line 1555 of file OVRHeadset.cpp.

◆ getStick()

bool yarp::dev::OVRHeadset::getStick ( unsigned int  stick_id,
yarp::sig::Vector &  value,
JoypadCtrl_coordinateMode  coordinate_mode 
)
override

Definition at line 1629 of file OVRHeadset.cpp.

◆ getStickCount()

bool yarp::dev::OVRHeadset::getStickCount ( unsigned int &  stick_count)
override

Definition at line 1569 of file OVRHeadset.cpp.

◆ getStickDoF()

bool yarp::dev::OVRHeadset::getStickDoF ( unsigned int  stick_id,
unsigned int &  DoF 
)
override

Definition at line 1576 of file OVRHeadset.cpp.

◆ getTouch()

bool yarp::dev::OVRHeadset::getTouch ( unsigned int  touch_id,
yarp::sig::Vector &  value 
)
override

Definition at line 1656 of file OVRHeadset.cpp.

◆ getTouchSurfaceCount()

bool yarp::dev::OVRHeadset::getTouchSurfaceCount ( unsigned int &  touch_count)
override

Definition at line 1562 of file OVRHeadset.cpp.

◆ getTrackball()

bool yarp::dev::OVRHeadset::getTrackball ( unsigned int  trackball_id,
yarp::sig::Vector &  value 
)
override

Definition at line 1595 of file OVRHeadset.cpp.

◆ getTrackballCount()

bool yarp::dev::OVRHeadset::getTrackballCount ( unsigned int &  Trackball_count)
override

Definition at line 1548 of file OVRHeadset.cpp.

◆ open()

bool yarp::dev::OVRHeadset::open ( yarp::os::Searchable &  config)
virtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 375 of file OVRHeadset.cpp.

◆ run()

void yarp::dev::OVRHeadset::run ( )
virtual

Loop function.

This is the thread itself. The thread calls the run() function every <period> ms. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the run() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Implements yarp::os::PeriodicThread.

Definition at line 897 of file OVRHeadset.cpp.

◆ startService()

bool yarp::dev::OVRHeadset::startService ( )
virtual

Initiate the service, whatever it is.

The service should then run by itself, without any further interaction with its creator until stopService() is called.

Returns
true if the service started and needs no help running. If false is returned, the service expects updateService() to be called repeatedly until that function too returns false. This is useful for devices that don't want to manage their own service threads.

Reimplemented from yarp::dev::IService.

Definition at line 835 of file OVRHeadset.cpp.

◆ stopService()

bool yarp::dev::OVRHeadset::stopService ( )
virtual

Shut down the service, whatever it is.

Returns
true iff the service shut down ok.

Reimplemented from yarp::dev::IService.

Definition at line 876 of file OVRHeadset.cpp.

◆ threadInit()

bool yarp::dev::OVRHeadset::threadInit ( )
virtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented from yarp::os::PeriodicThread.

Definition at line 612 of file OVRHeadset.cpp.

◆ threadRelease()

void yarp::dev::OVRHeadset::threadRelease ( )
virtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::PeriodicThread.

Definition at line 737 of file OVRHeadset.cpp.

◆ updateService()

bool yarp::dev::OVRHeadset::updateService ( )
virtual

Give the service the chance to run for a while.

This is an alternative to calling startService(). It is more appropriate in a single-threaded environment.

Returns
true iff the service is willing to run some more. A return value of false means that the service would like to stop.

Reimplemented from yarp::dev::IService.

Definition at line 841 of file OVRHeadset.cpp.


The documentation for this class was generated from the following files: