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::GestureAnalyser Class Referenceabstract

Sense class which provides gesture analysis functionality to the SR system. More...

#include <gestureanalyser.h>

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

Public Member Functions

virtual std::shared_ptr< GestureStreamopenGestureStream (GestureListener *listener)=0
 Creates a GestureStream for listener to be connected to. More...
 
virtual void streamClosed (GestureStream *stream)=0
 Closes a specific GestureStream. 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 GestureAnalysercreate (SRContext &context)
 Creates a functional GestureAnalyser instance. More...
 

Additional Inherited Members

- Protected Attributes inherited from SR::Sense
Transformation calibration
 

Detailed Description

Sense class which provides gesture analysis functionality to the SR system.

Member Function Documentation

◆ create()

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

Creates a functional GestureAnalyser instance.

Parameters
contextis the environment in which created senses are kept track of
Returns
GestureAnalyser* which can provide streams of gesture data

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

◆ openGestureStream()

virtual std::shared_ptr< GestureStream > SR::GestureAnalyser::openGestureStream ( GestureListener listener)
pure virtual

Creates a GestureStream for listener to be connected to.

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

◆ streamClosed()

virtual void SR::GestureAnalyser::streamClosed ( GestureStream stream)
pure virtual

Closes a specific GestureStream.

Parameters
streamwill no longer supply gesture updates

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