akasha.xr

Class XRFrame

java.lang.Object

akasha.core.JsObject

akasha.xr.XRFrame

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

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 scene. Events which communicate the tracking state of objects also provide an XRFrame reference as part of their structure.

See Also:

XRFrame - MDN, # xrframe-interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XRFrame()

Method Summary

Modifier and Type	Method and Description
@JsNonNull Promise<XRAnchor>	createAnchor(XRRigidTransform pose, XRSpace space)
boolean	fillJointRadii(JsArray<XRJointSpace> jointSpaces, Float32Array radii)
boolean	fillJointRadii(XRJointSpace[] jointSpaces, Float32Array radii)
boolean	fillPoses(JsArray<XRSpace> spaces, XRSpace baseSpace, Float32Array transforms)
boolean	fillPoses(XRSpace[] spaces, XRSpace baseSpace, Float32Array transforms)
@JsNullable XRCPUDepthInformation	getDepthInformation(XRView view)
@JsNonNull JsArray<XRHitTestResult>	getHitTestResults(XRHitTestSource hitTestSource)
@JsNonNull JsArray<XRTransientInputHitTestResult>	getHitTestResultsForTransientInput(XRTransientInputHitTestSource hitTestSource)
@JsNullable XRJointPose	getJointPose(XRJointSpace joint, XRSpace baseSpace)
@JsNullable XRLightEstimate	getLightEstimate(XRLightProbe lightProbe)
@JsNullable 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.
@JsNullable 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.
boolean	isCreateAnchorSupported()
boolean	isFillJointRadiiSupported()
boolean	isFillPosesSupported()
boolean	isGetDepthInformationSupported()
boolean	isGetHitTestResultsForTransientInputSupported()
boolean	isGetHitTestResultsSupported()
boolean	isGetJointPoseSupported()
boolean	isGetLightEstimateSupported()
boolean	isTrackedAnchorsSupported()
double	predictedDisplayTime()
XRSession	session() An XRFrame object's read-only session property returns the XRSession object that generated the frame.
XRAnchorSet	trackedAnchors()

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

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

predictedDisplayTime

@JsProperty(name="predictedDisplayTime")
public double predictedDisplayTime()

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

isTrackedAnchorsSupported

@JsOverlay
public final boolean isTrackedAnchorsSupported()

trackedAnchors

@JsProperty(name="trackedAnchors")
 @Nonnull
public XRAnchorSet trackedAnchors()

getPose

public @JsNullable 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

public @JsNullable 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

isCreateAnchorSupported

@JsOverlay
public final boolean isCreateAnchorSupported()

createAnchor

public @JsNonNull Promise<XRAnchor> createAnchor(@Nonnull
                                                 XRRigidTransform pose,
                                                 @Nonnull
                                                 XRSpace space)

isGetDepthInformationSupported

@JsOverlay
public final boolean isGetDepthInformationSupported()

getDepthInformation

public @JsNullable XRCPUDepthInformation getDepthInformation(@Nonnull
                                                             XRView view)

isFillJointRadiiSupported

@JsOverlay
public final boolean isFillJointRadiiSupported()

fillJointRadii

public boolean fillJointRadii(@Nonnull
                              JsArray<XRJointSpace> jointSpaces,
                              @Nonnull
                              Float32Array radii)

fillJointRadii

public boolean fillJointRadii(@Nonnull
                              XRJointSpace[] jointSpaces,
                              @Nonnull
                              Float32Array radii)

isFillPosesSupported

@JsOverlay
public final boolean isFillPosesSupported()

fillPoses

public boolean fillPoses(@Nonnull
                         JsArray<XRSpace> spaces,
                         @Nonnull
                         XRSpace baseSpace,
                         @Nonnull
                         Float32Array transforms)

fillPoses

public boolean fillPoses(@Nonnull
                         XRSpace[] spaces,
                         @Nonnull
                         XRSpace baseSpace,
                         @Nonnull
                         Float32Array transforms)

isGetJointPoseSupported

@JsOverlay
public final boolean isGetJointPoseSupported()

getJointPose

public @JsNullable XRJointPose getJointPose(@Nonnull
                                            XRJointSpace joint,
                                            @Nonnull
                                            XRSpace baseSpace)

isGetHitTestResultsSupported

@JsOverlay
public final boolean isGetHitTestResultsSupported()

getHitTestResults

public @JsNonNull JsArray<XRHitTestResult> getHitTestResults(@Nonnull
                                                             XRHitTestSource hitTestSource)

isGetHitTestResultsForTransientInputSupported

@JsOverlay
public final boolean isGetHitTestResultsForTransientInputSupported()

getHitTestResultsForTransientInput

public @JsNonNull JsArray<XRTransientInputHitTestResult> getHitTestResultsForTransientInput(@Nonnull
                                                                                            XRTransientInputHitTestSource hitTestSource)

isGetLightEstimateSupported

@JsOverlay
public final boolean isGetLightEstimateSupported()

getLightEstimate

public @JsNullable XRLightEstimate getLightEstimate(@Nonnull
                                                    XRLightProbe lightProbe)