Skip to main content

Interface: XrFrameLike

Defined in: threejs-environment/src/xr.ts:86

Properties

PropertyModifierTypeDescriptionDefined in
detectedMeshes?readonlyIterable<XrMeshLike, any, any>-threejs-environment/src/xr.ts:89
detectedPlanes?readonlyIterable<XrPlaneLike, any, any>XRPlaneSet / XRMeshSet / XRAnchorSet - all of them iterable sets.threejs-environment/src/xr.ts:88
session?readonlyunknownNever read. It is here so that a REAL XRFrame is recognised as one. An interface whose members are all optional is a "weak type", and TypeScript rejects an assignment that shares none of them. getLightEstimate is missing from the DOM's XRFrame in some lib versions, so without a member both shapes have, an app passing its actual renderer gets "has no properties in common" - which is exactly the error this file exists to prevent.threejs-environment/src/xr.ts:105
trackedAnchors?readonlyIterable<XrAnchorLike, any, any>-threejs-environment/src/xr.ts:90

Methods

createAnchor()?

optional createAnchor(pose: unknown, space: unknown): Promise<XrAnchorLike> | undefined;

Defined in: threejs-environment/src/xr.ts:93

Parameters

ParameterType
poseunknown
spaceunknown

Returns

Promise<XrAnchorLike> | undefined


getHitTestResults()?

optional getHitTestResults(source: unknown): readonly XrHitTestResultLike[];

Defined in: threejs-environment/src/xr.ts:92

Parameters

ParameterType
sourceunknown

Returns

readonly XrHitTestResultLike[]


getLightEstimate()?

optional getLightEstimate(probe: object): XrLightEstimateLike | null | undefined;

Defined in: threejs-environment/src/xr.ts:94

Parameters

ParameterType
probeobject

Returns

XrLightEstimateLike | null | undefined


getPose()?

optional getPose(space: unknown, baseSpace: unknown): XrPoseLike | null | undefined;

Defined in: threejs-environment/src/xr.ts:91

Parameters

ParameterType
spaceunknown
baseSpaceunknown

Returns

XrPoseLike | null | undefined