Fove SDK  v0.16.1
Public Member Functions | List of all members
Fove::ResearchHeadset Class Reference

Research API. More...

#include <FoveAPI.h>

Inheritance diagram for Fove::ResearchHeadset:
Inheritance graph
[legend]
Collaboration diagram for Fove::ResearchHeadset:
Collaboration graph
[legend]

Public Member Functions

 ResearchHeadset ()=default
 Creates an empty research headset. More...
 
 ResearchHeadset (Fove_ResearchHeadset &headset)
 Creates a headset from an existing C API object. More...
 
 ResearchHeadset (ResearchHeadset &&other)
 Move constructs a research headset. More...
 
 ~ResearchHeadset ()=default
 Does nothing, the underlying C API object's lifecycle is tied to the headset is was created from.
 
Result< ResearchGazegetGaze ()
 Wraps fove_ResearchHeadset_getGaze()
 
Result< BitmapImagegetImage (const ImageType type)
 Wraps fove_ResearchHeadset_getImage()
 
ResearchHeadsetoperator= (ResearchHeadset &&other)
 Destroys the existing research headset if any, then moves the one referenced by other, if any, into this object. More...
 
Result registerCapabilities (const ResearchCapabilities caps)
 Wraps fove_ResearchHeadset_registerCapabilities()
 
Result unregisterCapabilities (const ResearchCapabilities caps)
 Wraps fove_ResearchHeadset_unregisterCapabilities()
 
- Public Member Functions inherited from Fove::Object< Fove_ResearchHeadset >
Fove_ResearchHeadsetgetCObject () const
 Returns the underlying C type which the caller can use to invoke the C API directly, or null if not valid.
 
bool isValid () const
 Returns true if this object is non-empty. More...
 

Detailed Description

Research API.

This class is a wrapper around the C API's Fove_ResearchHeadset.

It is not intended for use in general-purpose software, eg. games, but rather for a labratory environment.

Using this class will limit the backwards compatibility of your program.

Constructor & Destructor Documentation

◆ ResearchHeadset() [1/3]

Fove::ResearchHeadset::ResearchHeadset ( )
default

Creates an empty research headset.

Please use Headset::getResearchHeadset() to get a valid research headset.

See also
Headset::getResearchHeadset()

◆ ResearchHeadset() [2/3]

Fove::ResearchHeadset::ResearchHeadset ( Fove_ResearchHeadset headset)

Creates a headset from an existing C API object.

This is not normally invoked directly, rather Headset::getResearchHeadset(), which wraps this, is typically used.

See also
Headset::getResearchHeadset()

◆ ResearchHeadset() [3/3]

Fove::ResearchHeadset::ResearchHeadset ( ResearchHeadset &&  other)

Move constructs a research headset.

Parameters
otherMay be empty or non-empty. By return, it will be empty.

Member Function Documentation

◆ operator=()

ResearchHeadset& Fove::ResearchHeadset::operator= ( ResearchHeadset &&  other)

Destroys the existing research headset if any, then moves the one referenced by other, if any, into this object.

Parameters
otherMay be empty or non-empty. By return, it will be empty.