WebXRAnchorSystem | Babylon.js API documentation

Class WebXRAnchorSystem

An implementation of the anchor system for WebXR. For further information see https://github.com/immersive-web/anchors/

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRAnchorSystem

Constructors

constructor

new WebXRAnchorSystem(
_xrSessionManager: WebXRSessionManager,
_options?: IWebXRAnchorSystemOptions,
): WebXRAnchorSystem
constructs a new anchor system
Parameters
- _xrSessionManager: WebXRSessionManager
  an instance of WebXRSessionManager
- Optional_options: IWebXRAnchorSystemOptions
  configuration object for this feature
Returns WebXRAnchorSystem
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10768

Properties

`Optional`dependsOn

dependsOn?: string[]

The dependencies of this feature, if any

disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

isDisposed: boolean

Is this feature disposed?

onAnchorAddedObservable

onAnchorAddedObservable: Observable<IWebXRAnchor>

Observers registered here will be executed when a new anchor was added to the session

onAnchorRemovedObservable

onAnchorRemovedObservable: Observable<IWebXRAnchor>

Observers registered here will be executed when an anchor was removed from the session

onAnchorUpdatedObservable

onAnchorUpdatedObservable: Observable<IWebXRAnchor>

Observers registered here will be executed when an existing anchor updates This can execute N times every frame

onFeatureAttachObservable

onFeatureAttachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is attached

onFeatureDetachObservable

onFeatureDetachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is detached

`Static` `Readonly`Name

Name: "xr-anchor-system"

The module's name

`Static` `Readonly`Version

Version: 1

The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the WebXR specs version

Accessors

anchors

get anchors(): IWebXRAnchor[]
Get the list of anchors currently being tracked by the system

Returns IWebXRAnchor[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10799

attached

get attached(): boolean
Is this feature attached

Returns boolean
Inherited from WebXRAbstractFeature.attached
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10866

referenceSpaceForFrameAnchors

set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace): void
Set the reference space to use for anchor creation, when not using a hit test. Will default to the session's reference space if not defined
Parameters
- referenceSpace: XRReferenceSpace
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10762

xrNativeFeatureName

get xrNativeFeatureName(): string
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)

Returns string
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10844
set xrNativeFeatureName(name: string): void
The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
Parameters
- name: string
Returns void
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10845

Methods

addAnchorAtPositionAndRotationAsync

addAnchorAtPositionAndRotationAsync(
    position: Vector3,
    rotationQuaternion?: Quaternion,
    forceCreateInCurrentFrame?: boolean,
): Promise<IWebXRAnchor>
Add a new anchor at a specific position and rotation This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function will be called in the next xrFrame loop to make sure that the anchor can be created correctly. An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that. Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
Parameters
- position: Vector3
  the position in which to add an anchor
- OptionalrotationQuaternion: Quaternion
  an optional rotation for the anchor transformation
- OptionalforceCreateInCurrentFrame: boolean
  force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
Returns Promise<IWebXRAnchor>
A promise that fulfills when babylon has created the corresponding WebXRAnchor object and tracking has begun
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10795

addAnchorPointUsingHitTestResultAsync

addAnchorPointUsingHitTestResultAsync(
    hitTestResult: IWebXRHitResult,
    position?: Vector3,
    rotationQuaternion?: Quaternion,
): Promise<IWebXRAnchor>
Create a new anchor point using a hit test result at a specific point in the scene An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that. Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
Parameters
- hitTestResult: IWebXRHitResult
  The hit test result to use for this anchor creation
- Optionalposition: Vector3
  an optional position offset for this anchor
- OptionalrotationQuaternion: Quaternion
  an optional rotation offset for this anchor
Returns Promise<IWebXRAnchor>
A promise that fulfills when babylon has created the corresponding WebXRAnchor object and tracking has begun
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10782

attach

attach(force?: boolean): boolean
attach this feature
Parameters
- Optionalforce: boolean
  should attachment be forced (even when already attached)
Returns boolean
true if successful, false is failed or already attached
Inherited from WebXRAbstractFeature.attach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10873

detach

detach(): boolean
detach this feature. Will usually be called by the features manager

Returns boolean
true if successful.
Overrides WebXRAbstractFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10806

dispose

dispose(): void
Dispose this feature and all of the resources attached

Returns void
Overrides WebXRAbstractFeature.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10810

isCompatible

isCompatible(): boolean
This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it

Returns boolean
whether or not the feature is compatible in this environment
Inherited from WebXRAbstractFeature.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10890

Class WebXRAnchorSystem

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRAnchorSystem

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onAnchorAddedObservable

onAnchorRemovedObservable

onAnchorUpdatedObservable

onFeatureAttachObservable

onFeatureDetachObservable

Static ReadonlyName

Static ReadonlyVersion

Accessors

anchors

Returns IWebXRAnchor[]

attached

Returns boolean

referenceSpaceForFrameAnchors

Parameters

Returns void

xrNativeFeatureName

Returns string

Parameters

Returns void

Methods

addAnchorAtPositionAndRotationAsync

Parameters

Returns Promise<IWebXRAnchor>

addAnchorPointUsingHitTestResultAsync

Parameters

Returns Promise<IWebXRAnchor>

attach

Parameters

Returns boolean

detach

Returns boolean

dispose

Returns void

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Static` `Readonly`Name

`Static` `Readonly`Version