gramods
Classes | Public Types | Public Member Functions | List of all members
gramods::gmTrack::ButtonsTracker Class Referenceabstract

The base of ButtonsTrackers, reporting button states. More...

#include <ButtonsTracker.hh>

Inheritance diagram for gramods::gmTrack::ButtonsTracker:
Inheritance graph
[legend]
Collaboration diagram for gramods::gmTrack::ButtonsTracker:
Collaboration graph
[legend]

Classes

struct  ButtonsSample
 A sample containing the state of any number of buttons. More...
 

Public Types

typedef std::chrono::steady_clock clock
 

Public Member Functions

virtual std::string getDefaultKey () override
 Returns the default key, in Configuration, for the Object. More...
 
virtual bool getButtons (ButtonsSample &b)=0
 Replaces the contents of p with button data. More...
 
- Public Member Functions inherited from gramods::gmCore::Object
 Object ()
 Initializes internal data. More...
 
virtual ~Object ()
 Cleaning up internal data. More...
 
virtual void initialize ()
 Called to initialize the Object. More...
 
virtual void accept (Visitor *visitor)
 Calls the visitors apply method with this as argument. More...
 
virtual void traverse (Visitor *visitor)
 Calls the child Object's accept method, if such exist. More...
 
bool isInitialized ()
 Returns true if the Object is initialized. More...
 

Detailed Description

The base of ButtonsTrackers, reporting button states.

Member Function Documentation

◆ getButtons()

virtual bool gramods::gmTrack::ButtonsTracker::getButtons ( ButtonsSample b)
pure virtual

Replaces the contents of p with button data.

Returns true if data could be read, false otherwise. Use sample time to check if data are fresh.

Implemented in gramods::gmTrack::VrpnButtonsTracker, gramods::gmTrack::ButtonsMapper, gramods::gmTrack::TimeSampleButtonsTracker, and gramods::gmTrack::OpenVRButtonsTracker.

◆ getDefaultKey()

virtual std::string gramods::gmTrack::ButtonsTracker::getDefaultKey ( )
inlineoverridevirtual

Returns the default key, in Configuration, for the Object.

Reimplemented from gramods::gmCore::Object.


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