stingray.GoogleVR namespace reference

Description

This object provides access to the Google VR interface.

Other related reference items

Plug-ins

Functions

compute_distorted_point ( eye, point ) : stingray.Vector2+ Computes the distorted point for a given point in a given eye, if possible.

Parameters

eye :	integer	The eye to query (stingray.GoogleVR.LEFT_EYE or stingray.GoogleVR.RIGHT_EYE)
point :	stingray.Vector2	a point in screen eye Viewport Space in [0,1]^2 with (0, 0) in the lower left corner of the eye's viewport and (1, 1) in the upper right corner of the eye's viewport

Returns

stingray.Vector2+

Returns three Vector2 with the red, green and blue distorted points. The + notation indicates that there may be one or more instances of the specified type.

The distortion inverts the optical distortion caused by the lens for the eye. Due to chromatic aberration, the distortion is different for each color channel.

controller_acceleration ( ) : stingray.Vector3 Returns the acceleration direction feels in meters per second squared (m/s^2) this frame for the current controller.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

Acceleration direction in meters per second squared of the controller

controller_api_status ( ) : integer Returns the API status of the controller.

Parameters

This function does not accept any parameters.

Returns

integer

The API status of the controller [GoogleVR.STATUS_API_OK, GoogleVR.STATUS_API_UNSUPPORTED, GoogleVR.STATUS_API_NOT_AUTHORIZED, GoogleVR.STATUS_API_UNAVAILABLE, GoogleVR.STATUS_API_SERVICE_OBSOLETE, GoogleVR.STATUS_API_CLIENT_OBSOLETE, GoogleVR.STATUS_API_MALFUNCTION]

controller_api_status_string ( status ) : string Returns the API status of the controller as a string.

Parameters

status :

integer

Controller API status [GoogleVR.STATUS_API_OK, GoogleVR.STATUS_API_UNSUPPORTED, GoogleVR.STATUS_API_NOT_AUTHORIZED, GoogleVR.STATUS_API_UNAVAILABLE, GoogleVR.STATUS_API_SERVICE_OBSOLETE, GoogleVR.STATUS_API_CLIENT_OBSOLETE, GoogleVR.STATUS_API_MALFUNCTION]

Returns

string

The API status of the controller as a string

controller_connection_status ( ) : integer Returns the connection status of the controller.

Parameters

This function does not accept any parameters.

Returns

integer

The connection status of the controller [GoogleVR.STATUS_DISCONNECTED, GoogleVR.STATUS_SCANNING, GoogleVR.STATUS_CONNECTING, GoogleVR.STATUS_CONNECTED]

controller_connection_status_string ( status ) : string Returns the connection status of the controller as a string.

Parameters

status :

integer

Controller connection status [GoogleVR.STATUS_DISCONNECTED, GoogleVR.STATUS_SCANNING, GoogleVR.STATUS_CONNECTING, GoogleVR.STATUS_CONNECTED]

Returns

string

The connection status of the controller as a string

controller_gyroscope ( ) : stingray.Vector3 Returns the current controller angular speed in radians.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector3

Angular speed in radians of the controller

controller_held ( button ) : boolean Indicates if the specified button is currently held.

Parameters

button :

integer

Controller button [GoogleVR.BUTTON_CLICK, GoogleVR.BUTTON_HOME, GoogleVR.BUTTON_APP, GoogleVR.BUTTON_VOLUME_UP, GoogleVR.BUTTON_VOLUME_DOWN]

Returns

boolean

true if specified button is held on the controller, false otherwise

controller_orientation ( ) : stingray.Quaternion Returns the current controller orientation.

Parameters

This function does not accept any parameters.

Returns

stingray.Quaternion

Orientation of the controller

controller_pressed ( button ) : boolean Indicates if the specified button has been pressed this frame.

Parameters

button :

integer

Controller button [GoogleVR.BUTTON_CLICK, GoogleVR.BUTTON_HOME, GoogleVR.BUTTON_APP, GoogleVR.BUTTON_VOLUME_UP, GoogleVR.BUTTON_VOLUME_DOWN]

Returns

boolean

true if specified button is pressed on controller, false otherwise.

This is a "transient" result; when it is true it will be true for only one frame after the event, and false for calls in subsequent frames.

controller_released ( button ) : boolean Indicates if the specified button has been released this frame for a given controller.

Parameters

button :

integer

Controller button [GoogleVR.BUTTON_CLICK, GoogleVR.BUTTON_HOME, GoogleVR.BUTTON_APP, GoogleVR.BUTTON_VOLUME_UP, GoogleVR.BUTTON_VOLUME_DOWN]

Returns

boolean

true if specified button is released on controller, false otherwise.

This is a "transient" result; when it is true it will be true for only one frame after the event, and false for calls in subsequent frames.

controller_touch ( ) : boolean Returns true or false depending if the touchpad is being touched this frame for the current controller.

Parameters

This function does not accept any parameters.

Returns

boolean

True if touchpad is touched on the controller, false otherwise

controller_touched ( ) : boolean Indicates if the touchpad has begun to be touched this frame.

Parameters

This function does not accept any parameters.

Returns

boolean

true if user just started touching the touchpad, false otherwise.

This is a "transient" result; when it is true it will be true for only one frame after the event, and false for calls in subsequent frames.

controller_touch_position ( ) : stingray.Vector2 Returns current or last touch position in normalized coordinates (0,0 top left, 1,1 bottom right) depending if the touchpad is being touched for the current controller.

Parameters

This function does not accept any parameters.

Returns

stingray.Vector2

Touch position in normalized coordinates of the controller's touchpad

controller_untouched ( ) : boolean Indicates if the touchpad has stopped being touched this frame.

Parameters

This function does not accept any parameters.

Returns

boolean

true if user just stopped touching the touchpad, false otherwise.

This is a "transient" result; when it is true it will be true for only one frame after the event, and false for calls in subsequent frames.

controller_value ( controller, button ) : number, number Returns the analog values of a specified controller button.

Parameters

controller :	integer	Controller index (Unused for GoogleVR, set to 0)
button :	integer	Controller button [GoogleVR.BUTTON_CLICK, GoogleVR.BUTTON_HOME, GoogleVR.BUTTON_APP, GoogleVR.BUTTON_VOLUME_UP, GoogleVR.BUTTON_VOLUME_DOWN]

Returns

number	First analog value of specified controller button. If unused, 0.0 is returned.
number	Second analog value of specified controller button. If unused, 0.0 is returned.

If GoogleVR.BUTTON_CLICK is requested, x and y analog positions of the touchpad will be returned. Otherwise, for any other button, the first value will contain the analog value (varying between 0 and 1) while the second will always be 0.

eye_fov ( eye ) : table Returns a table containing field of view on the specified eye.

Parameters

eye :

integer

The eye to query (stingray.GoogleVR.LEFT_EYE or stingray.GoogleVR.RIGHT_EYE)

Returns

table

Table populated with eye field of view.

hide_ui_overlay ( ) Hides the GoogleVR UI overlay that includes the divider bar, the settings button, and the back button.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

hmd_info ( ) : table Returns a table containing HMD information.

Parameters

This function does not accept any parameters.

Returns

table

Table populated with GoogleVR HMD information.

The "type" field identifies the viewer type as "Cardboard", "Daydream", or "unknown".

hmd_local_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4 Returns the head, left eye and right eye local poses of the HMD.

Parameters

This function does not accept any parameters.

Returns

stingray.Matrix4x4	Head local pose
stingray.Matrix4x4	Left eye local pose
stingray.Matrix4x4	Right eye local pose

hmd_world_pose ( ) : stingray.Matrix4x4, stingray.Matrix4x4, stingray.Matrix4x4 Returns the head, left eye and right eye world poses of the HMD.

Parameters

This function does not accept any parameters.

Returns

stingray.Matrix4x4	Head world pose
stingray.Matrix4x4	Left eye world pose
stingray.Matrix4x4	Right eye world pose

If not tracked, identity matrices are returned.

initialize ( ) : boolean Initializes Google VR system.

Parameters

This function does not accept any parameters.

Returns

boolean

Returns true if Google VR was initialized properly, otherwise returns false.

launch_or_install_settings_app ( ) Launches or installs the Google VR settings app.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

link_node_to_eye ( unit, node, eye, world ) Links a Unit node to be automatically updated by the VR tracker.

Parameters

unit :	stingray.Unit	Unit to link to eye
node :	integer	Scene graph node that is linked within the unit
eye :	integer	The eye to link (stingray.GoogleVR.LEFT_EYE or stingray.GoogleVR.RIGHT_EYE)
world :	stingray.World	World containing the unit

Returns

This function does not return any values.

recenter ( ) Re-centers the head orientation (resets the yaw to zero, leaving pitch and roll unmodified).

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

Does nothing on daydream devices (re-centering is handled automatically).

refresh_viewer_profile ( ) Refreshes Google VR with the viewer profile that is stored on the device.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

setup_render_targets ( left_eye_rt, right_eye_rt ) Setup Google VR render targets.

Parameters

left_eye_rt :	string	The left eye render target name.
right_eye_rt :	string	The right eye render target name.

Returns

This function does not return any values.

set_default_viewer_profile ( uri ) Sets the default viewer profile specified by uri.

Parameters

uri :

string

A string that contains either the shortened URI or the standard URI representing the viewer profile that the app should be using.

Returns

This function does not return any values.

set_tracking_space_pose ( pose ) Sets provided pose as the default tracking space pose

Parameters

pose :

stingray.Matrix4x4

Tracking space pose

Returns

This function does not return any values.

show_ui_overlay ( ) Shows the GoogleVR UI overlay that includes the divider bar, the settings button, and the back button.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

shutdown ( ) Shuts down Google VR system.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

unlink_eye ( eye ) Unlinks a any Unit node that is being automatically updated by the VR tracker.

Parameters

eye :

integer

The eye to unlink (stingray.GoogleVR.LEFT_EYE or stingray.GoogleVR.RIGHT_EYE)

Returns

This function does not return any values.