Fove SDK  v1.3.1
Public Member Functions | Static Public Attributes | List of all members
fove.headset.Headset Class Reference
Inheritance diagram for fove.headset.Headset:
Inheritance graph
[legend]
Collaboration diagram for fove.headset.Headset:
Collaboration graph
[legend]

Public Member Functions

None __init__ (self, capi.ClientCapabilities capabilities)
 
Headset __enter__ (self)
 
bool __exit__ (self, Optional[Type[BaseException]] _e_type, Optional[Type[BaseException]] _e_val, Optional[TracebackType] _traceback)
 
Result[None] activateLicense (self, str licenseKey)
 
Result[None] checkSoftwareVersions (self)
 
Compositor createCompositor (self)
 
Result[None] createProfile (self, str profileName)
 
Result[None] deactivateLicense (self, str licenseData)
 
Result[capi.FrameTimestamp] fetchEyesImage (self)
 
Result[capi.FrameTimestamp] fetchEyeTrackingData (self)
 
Result[capi.FrameTimestamp] fetchPoseData (self)
 
Result[float] getCombinedGazeDepth (self)
 
Result[capi.Ray] getCombinedGazeRay (self)
 
Result[float] getEyeballRadius (self, capi.Eye eye)
 
Result[capi.EyeShape] getEyeShape (self, capi.Eye eye)
 
Result[capi.BitmapImage] getEyesImage (self)
 
Result[capi.FrameTimestamp] getEyesImageTimestamp (self)
 
Result[capi.EyeState] getEyeState (self, capi.Eye eye)
 
Result[Tuple[capi.Matrix44, capi.Matrix44]] getEyeToHeadMatrices (self)
 
Result[float] getEyeTorsion (self, capi.Eye eye)
 
Result[capi.CalibrationState] getEyeTrackingCalibrationState (self)
 
Result[capi.FrameTimestamp] getEyeTrackingDataTimestamp (self)
 
Result[int] getGazedObjectId (self)
 
Result[capi.Vec2] getGazeScreenPosition (self, capi.Eye eye)
 
Result[capi.Vec2] getGazeScreenPositionCombined (self)
 
Result[capi.Vec3] getGazeVector (self, capi.Eye eye)
 
Result[float] getIrisRadius (self, capi.Eye eye)
 
Result[capi.Pose] getPose (self)
 
Result[capi.BitmapImage] getPositionImage (self)
 
Result[Tuple[capi.Matrix44, capi.Matrix44]] getProjectionMatricesLH (self, float zNear, float zFar)
 
Result[Tuple[capi.Matrix44, capi.Matrix44]] getProjectionMatricesRH (self, float zNear, float zFar)
 
Result[float] getPupilRadius (self, capi.Eye eye)
 
Result[capi.PupilShape] getPupilShape (self, capi.Eye eye)
 
Result[Tuple[capi.ProjectionParams, capi.ProjectionParams]] getRawProjectionValues (self)
 
Result[float] getRenderIOD (self)
 
Result[float] getUserIOD (self)
 
Result[float] getUserIPD (self)
 
Result[bool] hasAccessToFeature (self, str featureName)
 
Result[bool] hasHmdAdjustmentGuiTimeout (self)
 
Result[bool] isEyeTrackingCalibrated (self)
 
Result[bool] isEyeTrackingCalibratedForGlasses (self)
 
Result[bool] isEyeTrackingCalibrating (self)
 
Result[bool] isEyeTrackingEnabled (self)
 
Result[bool] isEyeTrackingReady (self)
 
Result[bool] isHardwareConnected (self)
 
Result[bool] isHmdAdjustmentGuiVisible (self)
 
Result[bool] isMotionReady (self)
 
Result[bool] isPositionReady (self)
 
Result[bool] isUserPresent (self)
 
Result[bool] isUserShiftingAttention (self)
 
Result[List[str]] listProfiles (self)
 
Result[str] queryCurrentProfile (self)
 
Result[capi.HeadsetHardwareInfo] queryHardwareInfo (self)
 
Result[List[capi.LicenseInfo]] queryLicenses (self)
 
Result[str] queryProfileDataPath (self, str profileName)
 
Result[capi.Versions] querySoftwareVersions (self)
 
Result[None] registerCameraObject (self, capi.CameraObject cameraObject)
 
Result[None] registerCapabilities (self, capi.ClientCapabilities caps)
 
Result[None] registerGazableObject (self, capi.GazableObject gazableObject)
 
Result[None] removeCameraObject (self, int cameraId)
 
Result[None] removeGazableObject (self, int objectId)
 
Result[None] renameProfile (self, str oldName, str newName)
 
Result[None] setCurrentProfile (self, str profileName)
 
Result[None] startEyeTrackingCalibration (self, Optional[capi.CalibrationOptions] options)
 
Result[None] stopEyeTrackingCalibration (self)
 
Result[None] tareOrientationSensor (self)
 
Result[None] tarePositionSensors (self)
 
Result[capi.CalibrationData] tickEyeTrackingCalibration (self, float deltaTime, bool isVisible)
 
Result[None] unregisterCapabilities (self, capi.ClientCapabilities caps)
 
Result[None] updateCameraObject (self, int cameraId, capi.ObjectPose pose)
 
Result[None] updateGazableObject (self, int objectId, capi.ObjectPose pose)
 
Result[None] waitForProcessedEyeFrame (self)
 

Static Public Attributes

 Caps = capi.ClientCapabilities
 
tuple ET_CAPS
 
tuple POS_CAPS
 

Member Data Documentation

◆ ET_CAPS

tuple fove.headset.Headset.ET_CAPS
static
Initial value:
= (
Caps.None_
+ Caps.EyeTracking
+ Caps.GazeDepth
+ Caps.UserPresence
+ Caps.UserAttentionShift
+ Caps.UserIOD
+ Caps.UserIPD
+ Caps.EyeTorsion
+ Caps.EyeShape
+ Caps.PupilShape
+ Caps.EyesImage
+ Caps.EyeballRadius
+ Caps.IrisRadius
+ Caps.PupilRadius
+ Caps.GazedObjectDetection
)

◆ POS_CAPS

tuple fove.headset.Headset.POS_CAPS
static
Initial value:
= (
Caps.None_
+ Caps.OrientationTracking
+ Caps.PositionTracking
+ Caps.PositionImage
)