![]() |
Fove SDK v1.4.0
|
Main API for using headsets. More...
#include <FoveAPI.h>
Public Member Functions | |
Headset ()=default | |
Creates an empty headset. | |
Headset (Fove_Headset &headset) | |
Creates a headset from an existing C API object. | |
Headset (Headset &&other) | |
Move constructs a headset. | |
~Headset () | |
Destroys the headset, releasing any resources. | |
Result | activateLicense (const std::string &licenseKey) |
Wraps fove_Headset_activateLincese() | |
Result | checkSoftwareVersions () |
Wraps fove_Headset_checkSoftwareVersions() | |
Result< Compositor > | createCompositor () |
Creates a new compositor object. | |
Result | createProfile (const std::string &name) |
Wraps fove_Headset_createProfile() | |
Result | deactivateLicense (const std::string &licenseKey) |
Wraps fove_Headset_deactivateLincese() | |
Result | deleteProfile (const std::string &profileName) |
Wraps fove_Headset_deleteProfile() | |
Result | destroy () |
Destroys the headset, releasing resources. | |
Result< Fove_FrameTimestamp > | fetchEyesImage () |
Wraps fove_Headset_fetchEyesImage() | |
Result< Fove_FrameTimestamp > | fetchEyeTrackingData () |
Wraps fove_Headset_fetchEyeTrackingData() | |
Result< Fove_FrameTimestamp > | fetchPoseData () |
Wraps fove_Headset_fetchPoseData() | |
Result< Fove_FrameTimestamp > | fetchPositionImage () |
Wraps fove_Headset_fetchPositionImage() | |
Result< float > | getCombinedGazeDepth () |
Wraps fove_Headset_getCombinedGazeDepth() | |
Result< Fove_Ray > | getCombinedGazeRay () |
Wraps fove_Headset_getCombinedGazeRay() | |
Result< float > | getEyeballRadius (Eye eye) |
Wraps fove_Headset_getEyeballRadius() | |
Result< int > | getEyeBlinkCount (Eye eye) |
Wraps fove_Headset_getEyeBlinkCount() | |
Result< EyeShape > | getEyeShape (Eye eye) |
Wraps fove_Headset_getEyeShape() | |
Result< Fove_BitmapImage > | getEyesImage () |
Wraps fove_Headset_getEyesImage() | |
Result< Fove_FrameTimestamp > | getEyesImageTimestamp () |
Wraps fove_Headset_getEyesImageTimestamp() | |
Result< EyeState > | getEyeState (Eye eye) |
Wraps fove_Headset_getEyeState() | |
Result< Stereo< Matrix44 > > | getEyeToHeadMatrices () |
Wraps fove_Headset_getEyeToHeadMatrices() | |
Result< float > | getEyeTorsion (Eye eye) |
Wraps fove_Headset_getEyeTorsion() | |
Result< Fove_CalibrationState > | getEyeTrackingCalibrationState () |
Wraps fove_Headset_getEyeTrackingCalibrationState() | |
template<typename Callback > | |
Result | getEyeTrackingCalibrationStateDetails (Callback &&callback) |
Wraps fove_Headset_getEyeTrackingCalibrationStateDetails() | |
Result< Fove_FrameTimestamp > | getEyeTrackingDataTimestamp () |
Wraps fove_Headset_getEyeTrackingDataTimestamp() | |
Result< int > | getGazedObjectId () |
Wraps fove_Headset_getGazedObjectId() | |
Result< Vec2 > | getGazeScreenPosition (Eye eye) |
Wraps fove_Headset_getGazeScreenPosition() | |
Result< Vec2 > | getGazeScreenPositionCombined () |
Wraps fove_Headset_getGazeScreenPosition() | |
Result< Vec3 > | getGazeVector (Eye eye) |
Wraps fove_Headset_getGazeVector() | |
Result< Vec3 > | getGazeVectorRaw (Eye eye) |
Wraps fove_Headset_getGazeVectorRaw() | |
Result< float > | getIrisRadius (Eye eye) |
Wraps fove_Headset_getIrisRadius() | |
Result< Pose > | getPose () |
Wraps fove_Headset_getPose() | |
Result< Fove_FrameTimestamp > | getPoseDataTimestamp () |
Wraps fove_Headset_getPoseDataTimestamp() | |
Result< Fove_BitmapImage > | getPositionImage () |
Wraps fove_Headset_getPositionImage() | |
Result< Fove_FrameTimestamp > | getPositionImageTimestamp () |
Wraps fove_Headset_getPositionImageTimestamp() | |
Result< Stereo< Matrix44 > > | getProjectionMatricesLH (const float zNear, const float zFar) |
Wraps fove_Headset_getProjectionMatricesLH() | |
Result< Stereo< Matrix44 > > | getProjectionMatricesRH (const float zNear, const float zFar) |
Wraps fove_Headset_getProjectionMatricesRH() | |
Result< float > | getPupilRadius (Eye eye) |
Wraps fove_Headset_getPupilRadius() | |
Result< PupilShape > | getPupilShape (Eye eye) |
Wraps fove_Headset_getPupilShape() | |
Result< Stereo< ProjectionParams > > | getRawProjectionValues () |
Wraps fove_Headset_getRawProjectionValues() | |
Result< float > | getRenderIOD () |
Wraps fove_Headset_getIOD() | |
Result< float > | getUserIOD () |
Wraps fove_Headset_getUserIOD() | |
Result< float > | getUserIPD () |
Wraps fove_Headset_getUserIPD() | |
Result< bool > | hasAccessToFeature (const std::string &inFeatureName) |
Wraps fove_Headset_hasAccessToFeature() | |
Result< bool > | hasHmdAdjustmentGuiTimeout () |
Wraps fove_Headset_hasHmdAdjustmentGuiTimeout() | |
Result< bool > | isEyeBlinking (Eye eye) |
Wraps fove_Headset_isEyeBlinking() | |
Result< bool > | isEyeTrackingCalibrated () |
Wraps fove_Headset_isEyeTrackingCalibrated() | |
Result< bool > | isEyeTrackingCalibratedForGlasses () |
Wraps fove_Headset_isEyeTrackingCalibratedForGlasses() | |
Result< bool > | isEyeTrackingCalibrating () |
Wraps fove_Headset_isEyeTrackingCalibrating() | |
Result< bool > | isEyeTrackingEnabled () |
Wraps fove_Headset_isEyeTrackingEnabled() | |
Result< bool > | isEyeTrackingReady () |
Wraps fove_Headset_isEyeTrackingReady() | |
Result< bool > | isHardwareConnected () |
Wraps fove_Headset_isHardwareConnected() | |
Result< bool > | isHmdAdjustmentGuiVisible () |
Wraps fove_Headset_isHmdAdjustmentGuiVisible() | |
Result< bool > | isMotionReady () |
Wraps fove_Headset_isMotionReady() | |
Result< bool > | isPositionReady () |
Wraps fove_Headset_isPositionReady() | |
Result< bool > | isUserPresent () |
Wraps fove_Headset_isUserPresent() | |
Result< bool > | isUserShiftingAttention () |
Wraps fove_Headset_isUserShiftingAttention() | |
Result< std::vector< std::string > > | listProfiles () |
Wraps fove_Headset_listProfiles() | |
template<typename Callback > | |
Result | listProfiles (Callback &&callback) |
Wraps fove_Headset_listProfiles() | |
Headset & | operator= (Headset &&other) |
Destroys the existing headset if any, then moves the one referenced by other , if any, into this object. | |
Result< std::string > | queryCurrentProfile () |
Wraps fove_Headset_queryCurrentProfile() | |
template<typename Callback > | |
Result | queryCurrentProfile (Callback &&callback) |
Wraps fove_Headset_queryCurrentProfile() | |
Result< HeadsetHardwareInfo > | queryHeadsetHardwareInfo () |
Wraps fove_Headset_queryHardwareInfo() | |
Result< std::vector< LicenseInfo > > | queryLicenses () |
Wraps fove_Headset_queryLicenses() | |
Result< std::string > | queryProfileDataPath (const std::string &profileName) |
Wraps fove_Headset_queryProfileDataPath() | |
template<typename Callback > | |
Result | queryProfileDataPath (const std::string &profileName, Callback &&callback) |
Wraps fove_Headset_queryProfileDataPath() | |
Result< Versions > | querySoftwareVersions () |
Wraps fove_Headset_querySoftwareVersions() | |
Result | registerCameraObject (const Fove_CameraObject &camera) |
Wraps fove_Headset_registerCameraObject() | |
Result | registerCapabilities (const ClientCapabilities caps) |
Wraps fove_Headset_registerCapabilities() | |
Result | registerGazableObject (const Fove_GazableObject &object) |
Wraps fove_Headset_registerGazableObject() | |
Result | registerPassiveCapabilities (const ClientCapabilities caps) |
Wraps fove_Headset_registerPassiveCapabilities() | |
Result | removeCameraObject (const int cameraId) |
Wraps fove_Headset_removeCameraObject() | |
Result | removeGazableObject (const int objectId) |
Wraps fove_Headset_removeGazableObject() | |
Result | renameProfile (const std::string &oldName, const std::string &newName) |
Wraps fove_Headset_renameProfile() | |
Result | setCurrentProfile (const std::string &profileName) |
Wraps fove_Headset_setCurrentProfile() | |
Result | startEyeTrackingCalibration (const Fove_CalibrationOptions &options={}) |
Wraps fove_Headset_startEyeTrackingCalibration() | |
Result | startHmdAdjustmentProcess (bool lazy=true) |
Wraps fove_Headset_startHmdAdjustmentProcess() | |
Result | stopEyeTrackingCalibration () |
Wraps fove_Headset_stopEyeTrackingCalibration() | |
Result | tareOrientationSensor () |
Wraps fove_Headset_tareOrientationSensor() | |
Result | tarePositionSensors () |
Wraps fove_Headset_tarePositionSensors() | |
template<typename Callback > | |
Result | tickEyeTrackingCalibration (const float dt, bool isVisible, Callback &&callback) |
Wraps fove_Headset_tickEyeTrackingCalibration() | |
Result | tickHmdAdjustmentProcess (float deltaTime, bool isVisible, Fove_HmdAdjustmentData &outData) |
Wraps fove_Headset_tickHmdAdjustmentProcess() | |
Result | unregisterCapabilities (const ClientCapabilities caps) |
Wraps fove_Headset_unregisterCapabilities() | |
Result | unregisterPassiveCapabilities (const ClientCapabilities caps) |
Wraps fove_Headset_unregisterPassiveCapabilities() | |
Result | updateCameraObject (const int cameraId, const Fove_ObjectPose &pose) |
Wraps fove_Headset_updateCameraObject() | |
Result | updateGazableObject (const int objectId, const Fove_ObjectPose &objectPose) |
Wraps fove_Headset_updateGazableObject() | |
Result | waitForProcessedEyeFrame () |
Wraps fove_Headset_waitForProcessedEyeFrame() | |
![]() | |
Fove_Headset * | getCObject () 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. | |
Static Public Member Functions | |
static Result< Headset > | create (const ClientCapabilities capabilities) |
Creates a new headset object with the given capabilities. | |
Main API for using headsets.
This class is a wrapper around the C API's Fove_Headset, and is the main class of the FOVE API.
|
default |
Creates an empty headset.
Please use Headset::create() to create a valid headset.
Fove::Headset::Headset | ( | Fove_Headset & | headset | ) |
Creates a headset from an existing C API object.
This is not normally invoked directly, rather Headset::create(), which wraps this, is typically used.
Fove::Headset::Headset | ( | Headset && | other | ) |
Move constructs a headset.
other | May be empty or non-empty. By return, it will be empty. |
Fove::Headset::~Headset | ( | ) |
Destroys the headset, releasing any resources.
Since an error cannot be returned, any error from fove_Headset_destroy will be logged.
Result Fove::Headset::destroy | ( | ) |
Destroys the headset, releasing resources.
After this call, this object will be in an empty state and future calls will fail. This is handled by the destructor, usually the user doesn't need to call this.