akasha.xr

Class XRFrame

java.lang.Object

akasha.xr.XRFrame

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="XRFrame")
public class XRFrame
extends java.lang.Object

A WebXR Device API XRFrame object is passed into the requestAnimationFrame() callback function and provides access to the information needed in order to render a single frame of animation for an XRSession describing a VR or AR sccene. Events which communicate the tracking state of objects also provide an XRFrame reference as part of their structure.A WebXR Device API XRFrame object is passed into the requestAnimationFrame() callback function and provides access to the information needed in order to render a single frame of animation for an XRSession describing a VR or AR sccene.In addition to providing a reference to the XRSession for which this frame is to be rendered, the getViewerPose() method is provided to obtain the XRViewerPose describing the viewer's position and orientation in space, and getPose() can be used to create an XRPose describing the relative position of one XRSpace relative to another.

See Also:

XRFrame - MDN, XRFrame - WebXR Device API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XRFrame()

Method Summary

Modifier and Type	Method and Description
XRPose	getPose(XRSpace space, XRSpace baseSpace) The XRFrame method getPose() returns the relative position and orientation—the pose—of one XRSpace to that of another space.
XRViewerPose	getViewerPose(XRReferenceSpace referenceSpace) The getViewerPose() method, a member of the XRFrame interface, returns a XRViewerPose object which describes the viewer's pose (position and orientation) relative to the specified reference space.
XRSession	session() An XRFrame object's read-only session property returns the XRSession object that generated the frame.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XRFrame

protected XRFrame()

Method Detail

session

@JsProperty(name="session")
 @Nonnull
public XRSession session()

An XRFrame object's read-only session property returns the XRSession object that generated the frame.

See Also:

XRFrame.session - MDN, XRFrame.session - WebXR Device API

getPose

@Nullable
public XRPose getPose(@Nonnull
                                XRSpace space,
                                @Nonnull
                                XRSpace baseSpace)

The XRFrame method getPose() returns the relative position and orientation—the pose—of one XRSpace to that of another space.

See Also:

XRFrame.getPose - MDN, XRFrame.getPose() - WebXR Device API

getViewerPose

@Nullable
public XRViewerPose getViewerPose(@Nonnull
                                            XRReferenceSpace referenceSpace)

The getViewerPose() method, a member of the XRFrame interface, returns a XRViewerPose object which describes the viewer's pose (position and orientation) relative to the specified reference space.

See Also:

XRFrame.getViewerPose - MDN, XRFrame.getViewerPose() - WebXR Device API