API Reference

Class List

pc.VrDisplay

Extends: pc.EventHandler

Represents a single Display for VR content. This could be a Head Mounted display that can present content on a separate screen or a phone which can display content full screen on the same screen. This object contains the native `navigator.VRDisplay` object from the WebVR API.

Summary

Properties

capabilitiesReturns the displayThe native VRDisplay object from the WebVR API
idAn identifier for this distinct VRDisplay
presentingTrue if this display is currently presenting VR content

Methods

destroyDestroy this display object
exitPresentTry to stop presenting VR content on this display
getFrameDataReturn the current frame data that is updated during polling.
pollCalled once per frame to update the current status from the display.
requestAnimationFrameUsed in the main application loop instead of the regular `window.
requestPresentTry to present full screen VR content on this display
resetCalled to reset the pose of the pc.
setClipPlanesSet the near and far depth plans of the display.
submitFrameCalled when animation update is complete and the frame is ready to be sent to the display.

Inherited

Methods

fireFire an event, all additional arguments are passed on to the event listener
hasEventTest if there are any handlers bound to an event name
offDetach an event handler from an event.
onAttach an event handler to an event
onceAttach an event handler to an event.

Details

Constructor

VrDisplay(app, display)

Represents a single Display for VR content. This could be a Head Mounted display that can present content on a separate screen or a phone which can display content full screen on the same screen. This object contains the native `navigator.VRDisplay` object from the WebVR API.

Parameters

apppc.ApplicationThe application outputting to this VR display.
displayVRDisplayThe native VRDisplay object from the WebVR API.

Properties

VRDisplayCapabilitiescapabilities

Returns the VRDisplayCapabilities object from the VRDisplay. This can be used to determine what features are available on this display.

VRDisplaydisplay

The native VRDisplay object from the WebVR API

Numberid

An identifier for this distinct VRDisplay

Booleanpresenting

True if this display is currently presenting VR content

Methods

destroy()

Destroy this display object

exitPresent(callback)

Try to stop presenting VR content on this display

Parameters

callbackpc.callbacks.VrDisplayCalled when the request is completed. Callback takes a single argument (err) that is the error message return if presenting fails, or null if the call succeeds. Usually called by pc.CameraComponent#exitVr.

getFrameData()

Return the current frame data that is updated during polling.

Returns

VRFrameData The frame data object

poll()

Called once per frame to update the current status from the display. Usually called by pc.VrManager.

requestAnimationFrame(fn)

Used in the main application loop instead of the regular `window.requestAnimationFrame`. Usually only called from inside pc.Application

Parameters

fnpc.callbacks.VrFrameFunction called when it is time to update the frame.

requestPresent(callback)

Try to present full screen VR content on this display

Parameters

callbackpc.callbacks.VrDisplayCalled when the request is completed. Callback takes a single argument (err) that is the error message return if presenting fails, or null if the call succeeds. Usually called by pc.CameraComponent#enterVr.

reset()

Called to reset the pose of the pc.VrDisplay. Treating its current pose as the origin/zero. This should only be called in 'sitting' experiences.

setClipPlanes(n, f)

Set the near and far depth plans of the display. This enables mapping of values in the render target depth attachment to scene coordinates

Parameters

nNumberThe near depth distance
fNumberThe far depth distance

submitFrame()

Called when animation update is complete and the frame is ready to be sent to the display. Usually only called from inside pc.Application.

Inherited

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])

Fire an event, all additional arguments are passed on to the event listener

obj.fire('test', 'This is the message');

Parameters

nameObjectName of event to fire
arg1*First argument that is passed to the event handler
arg2*Second argument that is passed to the event handler
arg3*Third argument that is passed to the event handler
arg4*Fourth argument that is passed to the event handler
arg5*Fifth argument that is passed to the event handler
arg6*Sixth argument that is passed to the event handler
arg7*Seventh argument that is passed to the event handler
arg8*Eighth argument that is passed to the event handler

Returns

pc.EventHandler Self for chaining.

hasEvent(name)

Test if there are any handlers bound to an event name

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

nameStringThe name of the event to test

Returns

Boolean true if the object has handlers bound to the specified event name.

off([name], [callback], [scope])

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all hander functions, called 'test' with scope this

Parameters

nameStringName of the event to unbind
callbackpc.callbacks.HandleEventFunction to be unbound.
scopeObjectScope that was used as the this when the event is fired

Returns

pc.EventHandler Self for chaining.

on(name, callback, [scope])

Attach an event handler to an event

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.

once(name, callback, [scope])

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.