C++ Java Unity
C++ Reference
EyewearDevice Class Referenceabstract

Detailed Description

A type of Device which is used when Vuforia runs on dedicated eyewear.

Inheritance diagram for EyewearDevice:
Device NonCopyable

Public Types

enum  ORIENTATION {
  ORIENTATION_UNDEFINED = 0,
  ORIENTATION_PORTRAIT,
  ORIENTATION_LANDSCAPE_LEFT,
  ORIENTATION_LANDSCAPE_RIGHT
}
 Device orientation. More...
 
- Public Types inherited from Device
enum  MODE {
  MODE_AR = 0,
  MODE_VR
}
 

Public Member Functions

virtual bool isSeeThru () const =0
 Get whether this eyewear device has a see-through display. More...
 
virtual bool isDualDisplay () const =0
 Get whether this eyewear device has a display for each eye (i.e. stereo). More...
 
virtual bool setDisplayExtended (bool enable)=0
 Set whether the display surface is extended over both eyes, or duplicated. More...
 
virtual bool isDisplayExtended () const =0
 Get whether the display surface is extended over both eyes. More...
 
virtual bool isDisplayExtendedGLOnly () const =0
 Returns true if the Eyewear device dual display mode is only for OpenGL content. More...
 
virtual ORIENTATION getScreenOrientation () const =0
 Get the screen orientation that should be used when rendering for this device. More...
 
virtual bool setPredictiveTracking (bool enable)=0
 Turn predictive tracking on or off. More...
 
virtual bool isPredictiveTrackingEnabled () const =0
 Get whether predictive tracking is enabled. More...
 
virtual EyewearCalibrationProfileManagergetCalibrationProfileManager ()=0
 Get the calibration profile manager. More...
 
virtual EyewearUserCalibratorgetUserCalibrator ()=0
 Get the calibrator used for creating custom user calibration experiences. More...
 
- Public Member Functions inherited from Device
virtual Type getType () const =0
 Get the Type of this instance (may be a subclass of Device). More...
 
virtual bool isOfType (Type type) const =0
 Get whether this Device instance's type equals or has been derived from the given type. More...
 
virtual bool setMode (MODE m)=0
 Set the rendering mode. More...
 
virtual MODE getMode () const =0
 Get the current rendering mode. More...
 
virtual void setViewerActive (bool active)=0
 Activate or deactivate the selected viewer. More...
 
virtual bool isViewerActive () const =0
 Returns true if a viewer is active, false otherwise. More...
 
virtual ViewerParametersListgetViewerList ()=0
 Get the list of ViewerParameters known to the system. More...
 
virtual bool selectViewer (const ViewerParameters &vp)=0
 Select the viewer to use. More...
 
virtual ViewerParameters getSelectedViewer () const =0
 Get the ViewerParameters for the currently selected viewer. More...
 
virtual void setConfigurationChanged ()=0
 Tell Vuforia that the configuration has changed, so new RenderingPrimitives need to be generated. More...
 
virtual const RenderingPrimitives getRenderingPrimitives ()=0
 Get a copy of the RenderingPrimitives for the current configuration. More...
 

Static Public Member Functions

static Type getClassType ()
 Get the Type for class 'EyewearDevice'. More...
 
- Static Public Member Functions inherited from Device
static DevicegetInstance ()
 Get the singleton instance. More...
 
static Type getClassType ()
 Get the Type for class "Device". More...
 

Member Enumeration Documentation

Device orientation.

Enumerator
ORIENTATION_UNDEFINED 

The device's orientation is undefined.

ORIENTATION_PORTRAIT 

The device orientation is portrait.

ORIENTATION_LANDSCAPE_LEFT 

The device orientation is landscape, rotated left from portrait

ORIENTATION_LANDSCAPE_RIGHT 

The device orientation is landscape, rotated right from portrait

Member Function Documentation

static Type getClassType ( )
static

Get the Type for class 'EyewearDevice'.

virtual bool isSeeThru ( ) const
pure virtual

Get whether this eyewear device has a see-through display.

virtual bool isDualDisplay ( ) const
pure virtual

Get whether this eyewear device has a display for each eye (i.e. stereo).

virtual bool setDisplayExtended ( bool  enable)
pure virtual

Set whether the display surface is extended over both eyes, or duplicated.

For eyewear with a display for each eye (i.e. isDualDisplay() returns true), Vuforia can either extend the output display to cover each eye (and therefore provide stereo output), or duplicate displayed content in each eye (providing mono output).

Parameters
enabletrue to extend the display surface across both eyes and enable 3D (stereo) mode, false to duplicate content for each eye and use 2D (mono) mode
Returns
true if successful, or false if the device doesn't support the request.
virtual bool isDisplayExtended ( ) const
pure virtual

Get whether the display surface is extended over both eyes.

See setDisplayExtended().

virtual bool isDisplayExtendedGLOnly ( ) const
pure virtual

Returns true if the Eyewear device dual display mode is only for OpenGL content.

Some Eyewear devices don't support stereo for 2D (typically Android widget) content. On these devices 2D content is rendered to each eye automatically without the need for the app to create a split screen view. On such devices this method will return true.

virtual ORIENTATION getScreenOrientation ( ) const
pure virtual

Get the screen orientation that should be used when rendering for this device.

virtual bool setPredictiveTracking ( bool  enable)
pure virtual

Turn predictive tracking on or off.

Predictive tracking uses device sensors to predict user motion and reduce perceived latency.

By default, predictive tracking is enabled on devices that support it.

Parameters
enabletrue to use predictive tracking via device sensors, or false to disable predictive tracking.
Returns
true if successful, or false if predicted tracking was requested and the device does not support it.
virtual bool isPredictiveTrackingEnabled ( ) const
pure virtual

Get whether predictive tracking is enabled.

virtual EyewearCalibrationProfileManager& getCalibrationProfileManager ( )
pure virtual

Get the calibration profile manager.

Note
This calibration is only relevant for see-through eyewear devices.
virtual EyewearUserCalibrator& getUserCalibrator ( )
pure virtual

Get the calibrator used for creating custom user calibration experiences.

Note
This calibration is only relevant for see-through eyewear devices.