Class XRFrameAbstract

Implements

Implemented by

Constructors

constructor

Properties

session predictedDisplayTime trackedAnchors? createAnchor? detectedPlanes? detectedMeshes? getJointPose?

Methods

getPose getViewerPose getHitTestResults getHitTestResultsForTransientInput

Constructors

constructor

Properties

Readonlysession

session: XRSession

ReadonlypredictedDisplayTime

predictedDisplayTime: number

OptionaltrackedAnchors

trackedAnchors?: XRAnchorSet

OptionalcreateAnchor

createAnchor?: ((pose: XRRigidTransform, space: XRSpace) => undefined | Promise<XRAnchor>)

Optional ReadonlydetectedPlanes

detectedPlanes?: XRPlaneSet

XRFrame is extended to contain detectedPlanes attribute which contains
all planes that are still tracked in the frame.

The set is initially empty and will be populated by the update planes
algorithm. If this attribute is accessed when the frame is not active,
the user agent MUST throw InvalidStateError.

See

https://immersive-web.github.io/real-world-geometry/plane-detection.html#plane-set

Optional ReadonlydetectedMeshes

detectedMeshes?: XRMeshSet

XRFrame is extended to contain detectedMeshes attribute
which contains all meshes that are still tracked in the frame.

The set is initially empty and will be populated by the update meshes algorithm.
If this attribute is accessed when the frame is not active, the user agent
MUST throw InvalidStateError.

See

https://immersive-web.github.io/real-world-meshing/#mesh-set

OptionalgetJointPose

getJointPose?: ((joint: XRJointSpace, baseSpace: XRSpace) => undefined | XRJointPose)

Methods

getPose

  • getPose(space, baseSpace): undefined | XRPose

  • Provides the pose of space relative to baseSpace as an XRPose, at the time represented by
    the XRFrame.

    Parameters

    Returns undefined | XRPose

getViewerPose

  • getViewerPose(referenceSpace): undefined | XRViewerPose

  • Provides the pose of the viewer relative to referenceSpace as an XRViewerPose, at the
    XRFrame's time.

    Parameters

    Returns undefined | XRViewerPose

getHitTestResults

getHitTestResultsForTransientInput

Settings

Member Visibility

On This Page

constructorsessionpredictedDisplayTimetrackedAnchorscreateAnchordetectedPlanesdetectedMeshesgetJointPosegetPosegetViewerPosegetHitTestResultsgetHitTestResultsForTransientInput