This site has been archived and remains strictly as a historical reference for developers who actively maintain apps built using the legacy Google VR SDK, which was last updated in 2019 and is no longer receiving updates.
  • All developers actively developing experiences for Google Cardboard should use the new open source Cardboard SDKs for iOS, Android NDK, and Unity XR Plugin. These new SDKs offer streamlined APIs, improved device compatibility, and built-in viewer profile QR code scanning.
  • The Daydream View VR headset is no longer available for purchase as of October 15, 2019. Existing apps on supported devices are unaffected for users who previously installed those applications. It is no longer possible to opt-in to Daydream distribution via Google Play.

GVRWidgetView Class

Stay organized with collections Save and categorize content based on your preferences.
Class Methods | Properties
GVRWidgetView Class Reference

Overview

Defines a base class for all widget views, that encapsulates common functionality.

Inherits UIView.

Inherited by GVRPanoramaView, and GVRVideoView.

Class Method Summary

(void) + setViewerParamsFromUrl:withCompletion:
 Sets the Cardboard viewer parameters from a Url. More...
 

Property Summary

id< GVRWidgetViewDelegate > delegate
 The delegate that is called when the widget view is loaded. More...
 
BOOL enableFullscreenButton
 Displays a button that allows the user to transition to fullscreen mode. More...
 
BOOL enableCardboardButton
 Displays a button that allows the user to transition to fullscreen VR mode. More...
 
BOOL enableInfoButton
 Displays a button that allows the user to get more information about VRView. More...
 
BOOL hidesTransitionView
 Hides the transition view when entering VR mode. More...
 
BOOL enableTouchTracking
 Enables touch gesture detection for manual heading control. More...
 
GVRHeadRotation headRotation
 The current head rotation corresponding to where the user is looking. More...
 
GVRWidgetDisplayMode displayMode
 Controls the current ::GVRWidgetDisplayMode of the widget view. More...
 

Method Detail

+ (void) setViewerParamsFromUrl: (NSURL *)  url
withCompletion: (void(^)(BOOL success, NSError *error))  completion 

Sets the Cardboard viewer parameters from a Url.

This allows programmatically pairing a viewer without having the user go through the pairing flow. Calls the supplied completion handler with the result of pairing and the error if it fails.

Note: The viewer parameters can be set only if no other viewer pairing exists. In other words, this only works if the user hasn't already paired a viewer for the current application.

A valid viewer parameters URI can be generated from this page: https://www.google.com/get/cardboard/viewerprofilegenerator/

Property Detail

- (id<GVRWidgetViewDelegate>) delegate
readwritenonatomicweak

The delegate that is called when the widget view is loaded.

- (BOOL) enableFullscreenButton
readwritenonatomicassign

Displays a button that allows the user to transition to fullscreen mode.

- (BOOL) enableCardboardButton
readwritenonatomicassign

Displays a button that allows the user to transition to fullscreen VR mode.

- (BOOL) enableInfoButton
readwritenonatomicassign

Displays a button that allows the user to get more information about VRView.

- (BOOL) hidesTransitionView
readwritenonatomicassign

Hides the transition view when entering VR mode.

- (BOOL) enableTouchTracking
readwritenonatomicassign

Enables touch gesture detection for manual heading control.

Regardless of how this is set, touch tracking is disabled in fullscreen VR mode.

- (GVRHeadRotation) headRotation
readnonatomicassign

The current head rotation corresponding to where the user is looking.

- (GVRWidgetDisplayMode) displayMode
readwritenonatomicassign

Controls the current ::GVRWidgetDisplayMode of the widget view.

Changing the value of this property is similar to pressing one of the fullscreen, cardboard or back UI buttons.