HMD

Causes the borders in HUD windows to be enlarged when the laser intersects them in HMD mode. By default, borders are not enlarged.

Calculates the intersection of a ray with the HUD overlay.

Parameters

Example

Draw a square on the HUD overlay in the direction you're looking.

var hudIntersection = HMD.calculateRayUICollisionPoint(MyAvatar.getHeadPosition(),
    Quat.getForward(MyAvatar.headOrientation));
var hudPoint = HMD.overlayFromWorldPoint(hudIntersection);

var DIMENSIONS = { x: 50, y: 50 };
var square = Overlays.addOverlay("rectangle", {
    x: hudPoint.x - DIMENSIONS.x / 2,
    y: hudPoint.y - DIMENSIONS.y / 2,
    width: DIMENSIONS.x,
    height: DIMENSIONS.y,
    color: { red: 255, green: 0, blue: 0 }
});

Script.scriptEnding.connect(function () {
    Overlays.deleteOverlay(square);
});

Recenters the HMD HUD to the current HMD position and orientation.

Closes the tablet if it is open.

Causes the border in HUD windows to no longer be enlarged when the laser intersects them in HMD mode. By default, borders are not enlarged.

Gets the position on the HUD overlay that your HMD is looking at, in HUD coordinates.

Gets the position on the HUD overlay that your HMD is looking at, in world coordinates.

Checks whether there is an HMD available.

Parameters

Example

Report on HMD availability.

print("Is any HMD available: " + HMD.isHMDAvailable());
print("Is an Oculus Rift HMD available: " + HMD.isHMDAvailable("Oculus Rift"));
print("Is a Vive HMD available: " + HMD.isHMDAvailable("OpenVR (Vive)"));

Checks whether there are HMD hand controllers available.

Parameters

Example

Report HMD hand controller availability.

print("Are any HMD hand controllers available: " + HMD.isHandControllerAvailable());
print("Are Oculus hand controllers available: " + HMD.isHandControllerAvailable("Oculus"));
print("Are Vive hand controllers available: " + HMD.isHandControllerAvailable("OpenVR"));

Checks whether there is an HMD head controller available.

Parameters

Example

Report HMD head controller availability.

print("Is any HMD head controller available: " + HMD.isHeadControllerAvailable());
print("Is an Oculus head controller available: " + HMD.isHeadControllerAvailable("Oculus"));
print("Is a Vive head controller available: " + HMD.isHeadControllerAvailable("OpenVR"));

Checks whether the HMD-provided keyboard, if any, is visible.

Checks whether there are specific HMD controllers available.

Parameters

Example

Report if particular Oculus controllers are available.

print("Is an Oculus Touch controller available: " + HMD.isSubdeviceContainingNameAvailable("Touch"));
print("Is an Oculus Remote controller available: " + HMD.isSubdeviceContainingNameAvailable("Remote"));

Opens the tablet if the tablet is used in the current display mode and it isn't already showing, and sets the tablet to contextual mode if requested. In contextual mode, the page displayed on the tablet is wholly controlled by script (i.e., the user cannot navigate to another).

Parameters

Gets the 2D HUD overlay coordinates of a 3D point on the HUD overlay. 2D HUD overlay coordinates are pixels with the origin at the top left of the overlay.

Parameters

Example

Draw a square on the HUD overlay in the direction you're looking.

var hudIntersection = HMD.calculateRayUICollisionPoint(MyAvatar.getHeadPosition(),
    Quat.getForward(MyAvatar.headOrientation));
var hudPoint = HMD.overlayFromWorldPoint(hudIntersection);

var DIMENSIONS = { x: 50, y: 50 };
var square = Overlays.addOverlay("rectangle", {
    x: hudPoint.x - DIMENSIONS.x / 2,
    y: hudPoint.y - DIMENSIONS.y / 2,
    width: DIMENSIONS.x,
    height: DIMENSIONS.y,
    color: { red: 255, green: 0, blue: 0 }
});

Script.scriptEnding.connect(function () {
    Overlays.deleteOverlay(square);
});

Gets the spherical coordinates of a 2D point on the HUD overlay. 2D HUD overlay coordinates are pixels with the origin at the top left of the overlay. Spherical coordinates are polar coordinates in radians with { x: 0, y: 0 } being the center of the HUD overlay.

Parameters

Gets the name of the HMD audio input device.

Gets the name of the HMD audio output device.

Signals that it is no longer necessary to display models of the HMD hand controllers being used. If no other scripts want the models displayed then they are no longer displayed.

Signals that models of the HMD hand controllers being used should be displayed. The models are displayed at their actual, real-world locations.

Example

Show your hand controllers for 10 seconds.

HMD.requestShowHandControllers();
Script.setTimeout(function () {
    HMD.requestHideHandControllers();
}, 10000);

Checks whether any script wants models of the HMD hand controllers displayed. Requests are made and canceled using requestShowHandControllers and requestHideHandControllers.

Gets the 2D point on the HUD overlay represented by given spherical coordinates. 2D HUD overlay coordinates are pixels with the origin at the top left of the overlay. Spherical coordinates are polar coordinates in radians with { x: 0, y: 0 } being the center of the HUD overlay.

Parameters

Suppresses the activation of the HMD-provided keyboard, if any. Successful calls should be balanced with a call to unsuppressKeyboard within a reasonable amount of time.

Unsuppresses the activation of the HMD-provided keyboard, if any.

Gets the 3D world coordinates of a 2D point on the HUD overlay. 2D HUD overlay coordinates are pixels with the origin at the top left of the overlay.

Parameters

Triggered when the HMD.ipdScale property value changes.

Triggered when the altering the mode for going into an away state when the interface focus is lost in VR.

Parameters

Triggered when Interface's display mode changes and when the user puts on or takes off their HMD.

Parameters

Example

Report when the display mode changes.

HMD.displayModeChanged.connect(function (isHMDMode) {
    print("Display mode changed");
    print("isHMD = " + isHMDMode);
    print("HMD.active = " + HMD.active);
    print("HMD.mounted = " + HMD.mounted);
});

Triggered when the ability to display the mini tablet has changed.

Parameters

Triggered when the HMD.mounted property value changes.

Example

Report when there's a change in the HMD being worn.

HMD.mountedChanged.connect(function () {
    print("Mounted changed. HMD is mounted: " + HMD.mounted);
});
     

Triggered when a request to show or hide models of the HMD hand controllers is made using requestShowHandControllers or requestHideHandControllers.

Example

Report when showing of hand controllers changes.

function onShouldShowHandControllersChanged() {
    print("Should show hand controllers: " + HMD.shouldShowHandControllers());
}
HMD.shouldShowHandControllersChanged.connect(onShouldShowHandControllersChanged);

HMD.requestShowHandControllers();
Script.setTimeout(function () {
    HMD.requestHideHandControllers();
}, 10000);

Triggered when the tablet is shown or hidden.

Parameters