Babylon.js API documentation|

Class XRFrame Abstract

Hierarchy

XRFrame

Implements

XRFrame

Implemented by

XRFrame

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new XRFrame(): XRFrame

Returns XRFrame

Properties

Optional detectedPlanes Search playground for detectedPlanes

detectedPlanes?: XRPlaneSet

Optional featurePointCloud Search playground for featurePointCloud

featurePointCloud?: number[]

Optional Readonly predictedDisplayTime Search playground for predictedDisplayTime

predictedDisplayTime?: number

Readonly session Search playground for session

session: XRSession

Optional trackedAnchors Search playground for trackedAnchors

trackedAnchors?: XRAnchorSet

Optional worldInformation Search playground for worldInformation

worldInformation?: XRWorldInformation

Methods

Optional createAnchor Search playground for createAnchor

createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>

- Defined in .temp/docdirectory/doc.d.ts:114965
Parameters
- pose: XRRigidTransform
- space: XRSpace
Returns Promise<XRAnchor>

Optional fillJointRadii Search playground for fillJointRadii

fillJointRadii(jointSpaces: XRJointSpace[], radii: Float32Array): boolean

- Defined in .temp/docdirectory/doc.d.ts:115496
Parameters
- jointSpaces: XRJointSpace[]
- radii: Float32Array
Returns boolean

Optional fillPoses Search playground for fillPoses

fillPoses(spaces: XRSpace[], baseSpace: XRSpace, transforms: Float32Array): boolean

- Defined in .temp/docdirectory/doc.d.ts:115488
Parameters
- spaces: XRSpace[]
- baseSpace: XRSpace
- transforms: Float32Array
Returns boolean

getDepthInformation Search playground for getDepthInformation

getDepthInformation(view: XRView): undefined | XRCPUDepthInformation

- Defined in .temp/docdirectory/doc.d.ts:115613
Parameters
- view: XRView
Returns undefined | XRCPUDepthInformation

getHitTestResults Search playground for getHitTestResults

getHitTestResults(hitTestSource: XRHitTestSource): XRHitTestResult[]

- Defined in .temp/docdirectory/doc.d.ts:115029
Parameters
- hitTestSource: XRHitTestSource
Returns XRHitTestResult[]

getHitTestResultsForTransientInput Search playground for getHitTestResultsForTransientInput

getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): XRTransientInputHitTestResult[]

- Defined in .temp/docdirectory/doc.d.ts:115030
Parameters
- hitTestSource: XRTransientInputHitTestSource
Returns XRTransientInputHitTestResult[]

Optional getImageTrackingResults Search playground for getImageTrackingResults

getImageTrackingResults(): XRImageTrackingResult[]

- Defined in .temp/docdirectory/doc.d.ts:115498
Returns XRImageTrackingResult[]

Optional getJointPose Search playground for getJointPose

getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose

- Defined in .temp/docdirectory/doc.d.ts:115495
Parameters
- joint: XRJointSpace
- baseSpace: XRSpace
Returns XRJointPose

getLightEstimate Search playground for getLightEstimate

getLightEstimate(xrLightProbe: XRLightProbe): XRLightEstimate

- Defined in .temp/docdirectory/doc.d.ts:115499
Parameters
- xrLightProbe: XRLightProbe
Returns XRLightEstimate

getPose Search playground for getPose

getPose(space: XRSpace, baseSpace: XRSpace): undefined | XRPose

- Defined in .temp/docdirectory/doc.d.ts:114732
Provides the pose of space relative to baseSpace as an XRPose, at the time represented by the XRFrame.

Parameters
- space: XRSpace
- baseSpace: XRSpace
Returns undefined | XRPose

getViewerPose Search playground for getViewerPose

getViewerPose(referenceSpace: XRReferenceSpace): undefined | XRViewerPose

- Defined in .temp/docdirectory/doc.d.ts:114740
Provides the pose of the viewer relative to referenceSpace as an XRViewerPose, at the XRFrame's time.

Parameters
- referenceSpace: XRReferenceSpace
Returns undefined | XRViewerPose