Simulated Reality SDK 7500c78d v1.30.2.51085 2024-04-26T11:23:03Z
Stable
Public Member Functions | Static Public Member Functions | List of all members
SR::HeadPoseTracker Class Referenceabstract

Sense class which provides head pose tracking functionality to the SR system. More...

#include <headposetracker.h>

Inheritance diagram for SR::HeadPoseTracker:
[legend]
Collaboration diagram for SR::HeadPoseTracker:
[legend]

Public Member Functions

virtual std::shared_ptr< HeadPoseStreamopenHeadPoseStream (HeadPoseListener *listener)=0
 Creates a HeadPoseStream for listener to be connected to. More...
 
virtual void streamClosed (HeadPoseStream *stream)=0
 Closes a specific HeadPoseStream. More...
 
- Public Member Functions inherited from SR::Sense
void setCalibration (Transformation calibration)
 Sets a Transformation object to represent the sense's calibration with respect to the display. More...
 
Transformation getCalibration ()
 Gets callibration. More...
 
virtual ~Sense ()
 Ensures the proper destruction of the sense implementation. More...
 
virtual std::string getName ()=0
 Return the name of the sense. More...
 
virtual std::string getDescription ()=0
 Return a description of the sense. More...
 
virtual void start ()=0
 Start continuous updates, default behaviour is defined in the updater() function. More...
 
virtual void stop ()=0
 Stop continuous updates. More...
 

Static Public Member Functions

static HeadPoseTrackercreate (SRContext &context)
 Creates a functional HeadPoseTracker instance. More...
 

Additional Inherited Members

- Protected Attributes inherited from SR::Sense
Transformation calibration
 

Detailed Description

Sense class which provides head pose tracking functionality to the SR system.

Member Function Documentation

◆ create()

static HeadPoseTracker * SR::HeadPoseTracker::create ( SRContext context)
static

Creates a functional HeadPoseTracker instance.

Parameters
contextis the environment in which created senses are kept track of
Returns
HeadPoseTracker* which can provide streams of head pose data

The HeadPoseTracker class is abstract and requires a device specific implementation to be used in applications. This function constructs an HeadPoseTracker suitable for use in your application on the current device.

◆ openHeadPoseStream()

virtual std::shared_ptr< HeadPoseStream > SR::HeadPoseTracker::openHeadPoseStream ( HeadPoseListener listener)
pure virtual

Creates a HeadPoseStream for listener to be connected to.

Parameters
listenerwill receive head pose updates from now on
Returns
std::shared_ptr<HeadPoseStream> to be used to close the stream correctly when it is no longer required

◆ streamClosed()

virtual void SR::HeadPoseTracker::streamClosed ( HeadPoseStream stream)
pure virtual

Closes a specific HeadPoseStream.

Parameters
streamwill no longer supply headpose updates

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