C++ Java Unity
Java Reference
EyewearDevice Class Reference

Detailed Description

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

Inheritance diagram for EyewearDevice:
Device

Classes

class  ORIENTATION
 Device orientation. More...
 

Public Member Functions

boolean equals (Object obj)
 
boolean isSeeThru ()
 Get whether this eyewear device has a see-through display. More...
 
boolean isDualDisplay ()
 Get whether this eyewear device has a display for each eye (i.e. More...
 
boolean setDisplayExtended (boolean enable)
 Set whether the display surface is extended over both eyes, or duplicated. More...
 
boolean isDisplayExtended ()
 Get whether the display surface is extended over both eyes. More...
 
boolean isDisplayExtendedGLOnly ()
 Returns true if the Eyewear device dual display mode is only for OpenGL content. More...
 
int getScreenOrientation ()
 Get the screen orientation that should be used when rendering for this device. More...
 
boolean setPredictiveTracking (boolean enable)
 Turn predictive tracking on or off. More...
 
boolean isPredictiveTrackingEnabled ()
 Get whether predictive tracking is enabled. More...
 
EyewearCalibrationProfileManager getCalibrationProfileManager ()
 Get the calibration profile manager. More...
 
EyewearUserCalibrator getUserCalibrator ()
 Get the calibrator used for creating custom user calibration experiences. More...
 
- Public Member Functions inherited from Device
boolean equals (Object obj)
 
Type getType ()
 Get the Type of this instance (may be a subclass of Device). More...
 
boolean isOfType (Type type)
 Get whether this Device instance's type equals or has been derived from the given type. More...
 
boolean setMode (int m)
 Set the rendering mode. More...
 
int getMode ()
 Get the current rendering mode. More...
 
void setViewerActive (boolean active)
 Activate or deactivate the selected viewer. More...
 
boolean isViewerActive ()
 Returns true if a viewer is active, false otherwise. More...
 
ViewerParametersList getViewerList ()
 Get the list of ViewerParameters known to the system. More...
 
boolean selectViewer (ViewerParameters vp)
 Select the viewer to use. More...
 
ViewerParameters getSelectedViewer ()
 Get the ViewerParameters for the currently selected viewer. More...
 
void setConfigurationChanged ()
 Tell Vuforia that the configuration has changed, so new RenderingPrimitives need to be generated. More...
 
RenderingPrimitives getRenderingPrimitives ()
 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 Device getInstance ()
 Get the singleton instance. More...
 
static Type getClassType ()
 Get the Type for class "Device". More...
 

Member Function Documentation

boolean equals ( Object  obj)
static Type getClassType ( )
static

Get the Type for class 'EyewearDevice'.

boolean isSeeThru ( )

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

boolean isDualDisplay ( )

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

stereo).

boolean setDisplayExtended ( boolean  enable)

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.
boolean isDisplayExtended ( )

Get whether the display surface is extended over both eyes.

See setDisplayExtended().

boolean isDisplayExtendedGLOnly ( )

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.

int getScreenOrientation ( )

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

boolean setPredictiveTracking ( boolean  enable)

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.
boolean isPredictiveTrackingEnabled ( )

Get whether predictive tracking is enabled.

EyewearCalibrationProfileManager getCalibrationProfileManager ( )

Get the calibration profile manager.

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

EyewearUserCalibrator getUserCalibrator ( )

Get the calibrator used for creating custom user calibration experiences.

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