Class WebXR

WebXR component to enable VR, AR and Quicklook on iOS in your scene.
It provides a simple wrapper around the NeedleXRSession API and adds some additional features like creating buttons or enabling default movement behaviour.

Hierarchy (view full)

Properties

arScale autoCenter autoPlace createARButton createQRCode createSendToQuestButton createVRButton customARPlacementReticle? defaultAvatar? gameObject guid showControllerModels showHandModels sourceId? useDefaultControls useDepthSensing usePlacementAdjustment usePlacementReticle useQuicklookExport useSpatialGrab useXRAnchor

Accessors

activeAndEnabled context destroyed enabled forward hideFlags layer name right scene session sessionMode static tag up worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener awake createLocalAvatar destroy dispatchEvent earlyUpdate? enterAR enterVR exitXR getButtonsContainer getButtonsFactory lateUpdate? onAfterRender? onBeforeRender? onBeforeXR onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onEnterXR onLeaveXR onPausedChanged? onPointerClick? onPointerDown? onPointerEnter? onPointerExit? onPointerMove? onPointerUp? onTriggerEnter? onTriggerExit? onTriggerStay? onUpdateXR onValidate? onXRControllerAdded? onXRControllerRemoved? removeEventListener resolveGuids? setDefaultControllerRenderingEnabled setDefaultMovementEnabled setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine supportsXR? update?

Properties

arScale

arScale: number = 1

Used when usePlacementReticle is enabled. This is the scale of the user in the scene in AR. Larger values make the 3D content appear smaller

autoCenter

autoCenter: boolean = true

When enabled the AR session root center will be automatically adjusted to place the center of the scene

autoPlace

autoPlace: boolean = true

When enabled the scene will be placed automatically when a point in the real world is found

createARButton

createARButton: boolean = true

When enabled a button will be added to the UI to enter AR

createQRCode

createQRCode: boolean = true

When enabled a QRCode will be created to open the website on a mobile device

createSendToQuestButton

createSendToQuestButton: boolean = true

When enabled a send to quest button will be shown if the device does not support VR

createVRButton

createVRButton: boolean = true

When enabled a button will be added to the UI to enter VR

OptionalcustomARPlacementReticle

customARPlacementReticle?: AssetReference

When assigned this object will be used as the AR placement reticle

OptionaldefaultAvatar

defaultAvatar?: boolean | AssetReference

This avatar representation will be spawned when you enter a webxr session

gameObject

gameObject: GameObject

the object this component is attached to. Note that this is a threejs Object3D with some additional features

guid

guid: string = "invalid"

the unique identifier for this component

showControllerModels

showControllerModels: boolean = true

When enabled controller models will automatically be created and updated when you are using controllers in WebXR

showHandModels

showHandModels: boolean = true

When enabled hand models will automatically be created and updated when you are using hands in WebXR

OptionalsourceId

sourceId?: string

holds the source identifier this object was created with/from (e.g. if it was part of a glTF file the sourceId holds the url to the glTF)

useDefaultControls

useDefaultControls: boolean = true

When enabled default movement behaviour will be added

useDepthSensing

useDepthSensing: boolean = false

Preview feature enabling occlusion (when available: https://github.com/cabanier/three.js/commit/b6ee92bcd8f20718c186120b7f19a3b68a1d4e47) Enables the 'depth-sensing' WebXR feature to provide realtime depth occlusion. Only supported on Oculus Quest right now.

usePlacementAdjustment

usePlacementAdjustment: boolean = true

When enabled you can position, rotate or scale your AR scene with one or two fingers

usePlacementReticle

usePlacementReticle: boolean = true

When enabled the scene must be placed in AR

useQuicklookExport

useQuicklookExport: boolean = false

When enabled a USDZExporter component will be added to the scene (if none is found)

useSpatialGrab

useSpatialGrab: boolean = true

When enabled the spatial grab raycaster will be added or enabled in the scene

Default

true

useXRAnchor

useXRAnchor: boolean = false

Experimental: When enabled an XRAnchor will be created for the AR scene and the position will be updated to the anchor position every few frames

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

    true if the object is enabled and active in the hierarchy

context

  • get context(): Context

  • Use the context to get access to many Needle Engine features and use physics, timing, access the camera or scene

    Returns Context

  • set context(context): void

  • Parameters

    Returns void

destroyed

  • get destroyed(): boolean

  • Returns boolean

    true if this component was destroyed (this.destroy()) or the whole object this component was part of

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

  • Forward (0,0,-1) vector in world space

    Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

layer

  • get layer(): number

  • Returns number

    the layer of the gameObject this component is attached to

name

  • get name(): string

  • Returns string

    the name of the gameObject this component is attached to

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • Right (1,0,0) vector in world space

    Returns Vector3

scene

  • get scene(): Scene

  • shorthand for this.context.scene

    Returns Scene

    the scene of the context

session

sessionMode

  • get sessionMode(): null | XRSessionMode

  • immersive-vr or immersive-ar

    Returns null | XRSessionMode

static

  • get static(): boolean

  • Is the gameObject marked as static

    Returns boolean

  • set static(value): void

  • Parameters

    • value: boolean

    Returns void

tag

  • get tag(): string

  • Returns string

    the tag of the gameObject this component is attached to

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

up

  • get up(): Vector3

  • Up (0,1,0) vector in world space

    Returns Vector3

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    Returns void

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Type Parameters

    Parameters

    • type: string
    • listener: ((evt: T) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time (once per component)
    This is the first callback to be called

    Returns void

ProtectedcreateLocalAvatar

destroy

  • destroy(): void

  • Destroys this component (and removes it from the object)

    Returns void

dispatchEvent

  • dispatchEvent(evt): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

OptionalearlyUpdate

  • earlyUpdate(): void

  • first callback in a frame (called every frame when implemented)

    Returns void

enterAR

enterVR

exitXR

  • exitXR(): void

  • Call to end a WebXR (AR or VR) session

    Returns void

getButtonsContainer

getButtonsFactory

  • getButtonsFactory(): WebXRButtonFactory

  • Calling this function will get the Needle WebXR button factory (it will be created if it doesnt exist yet)

    Returns WebXRButtonFactory

    the Needle WebXR button factory

OptionallateUpdate

  • lateUpdate(): void

  • late callback in a frame (called every frame when implemented)

    Returns void

OptionalonAfterRender

OptionalonBeforeRender

  • onBeforeRender(frame): void

  • called before the scene gets rendered in the main update loop

    Parameters

    • frame: null | XRFrame

    Returns void

onBeforeXR

  • onBeforeXR(_mode, args): void

  • Called before the XR session is requested. Use this callback if you want to modify the session init features

    Parameters

    • _mode: XRSessionMode
    • args: XRSessionInit

    Returns void

OptionalonCollisionEnter

OptionalonCollisionExit

OptionalonCollisionStay

onDestroy

  • onDestroy(): void

  • Called when the component gets destroyed

    Returns void

onDisable

  • onDisable(): void

  • called every time the component gets disabled or if a parent object (or this.gameObject) gets set to invisible

    Returns void

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)
    or when it becomes active in the hierarchy (e.g. if a parent object or this.gameObject gets set to visible)

    Returns void

onEnterXR

onLeaveXR

  • onLeaveXR(_): void

  • Callback when this component exists a xr session (or when it becomes inactive in a running XR session)

    Parameters

    Returns void

OptionalonPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

  • Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

OptionalonPointerClick

  • onPointerClick(args): any

  • Called when an object (or any child object) is clicked (needs a EventSystem in the scene)

    Parameters

    Returns any

OptionalonPointerDown

OptionalonPointerEnter

  • onPointerEnter(args): any

  • Called when a pointer (mouse, touch, xr controller) starts pointing on/hovering an object (or a child object)

    Parameters

    Returns any

OptionalonPointerExit

  • onPointerExit(args): any

  • Called when a pointer (mouse, touch, xr controller) exists an object (it was hovering the object before but now it's not anymore)

    Parameters

    Returns any

OptionalonPointerMove

  • onPointerMove(args): any

  • Called when a pointer (mouse, touch, xr controller) is moving over an object (or a child object)

    Parameters

    Returns any

OptionalonPointerUp

  • onPointerUp(args): any

  • Called when a button is released (which was previously pressed in onPointerDown)

    Parameters

    Returns any

OptionalonTriggerEnter

OptionalonTriggerExit

OptionalonTriggerStay

onUpdateXR

OptionalonValidate

  • onValidate(prop?): void

  • called when you decorate fields with the @validate() decorator

    Parameters

    • Optionalprop: string

      the name of the field that was changed

    Returns void

OptionalonXRControllerAdded

  • onXRControllerAdded(args): void

  • Callback when a controller is connected/added while in a XR session
    OR when the component joins a running XR session that has already connected controllers
    OR when the component becomes active during a running XR session that has already connected controllers

    Parameters

    Returns void

OptionalonXRControllerRemoved

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Type Parameters

    Parameters

    • type: string
    • listener: ((arg: T) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

OptionalresolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

setDefaultControllerRenderingEnabled

  • setDefaultControllerRenderingEnabled(enabled): null | XRControllerModel

  • Call to enable or disable default controller rendering

    Parameters

    • enabled: boolean

    Returns null | XRControllerModel

setDefaultMovementEnabled

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

Optionalstart

  • start(): void

  • called at the beginning of a frame (once per component)

    Returns void

startCoroutine

  • startCoroutine(routine, evt?): Generator<unknown, any, unknown>

  • starts a coroutine (javascript generator function)
    yield will wait for the next frame:

    • Use yield WaitForSeconds(1) to wait for 1 second.
    • Use yield WaitForFrames(10) to wait for 10 frames.
    • Use yield new Promise(...) to wait for a promise to resolve.

    Parameters

    • routine: Generator<unknown, any, unknown>

      generator function to start

    • evt: FrameEvent = FrameEvent.Update

      event to register the coroutine for (default: FrameEvent.Update). Note that all coroutine FrameEvent callbacks are invoked after the matching regular component callbacks. For example FrameEvent.Update will be called after regular component update() methods)

    Returns Generator<unknown, any, unknown>

    the generator function (use it to stop the coroutine with stopCoroutine)

    Example

    onEnable() { this.startCoroutine(this.myCoroutine()); }
    private *myCoroutine() {
       while(this.activeAndEnabled) {
          console.log("Hello World", this.context.time.frame);
          // wait for 5 frames
          for(let i = 0; i < 5; i++) yield;
       }
    }

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Stop a coroutine that was previously started with startCoroutine

    Parameters

    • routine: Generator<unknown, any, unknown>

      the routine to be stopped

    • evt: FrameEvent = FrameEvent.Update

      the frame event to unregister the routine from (default: FrameEvent.Update)

    Returns void

OptionalsupportsXR

  • supportsXR(mode): boolean

  • Optional callback, you can implement this to only get callbacks for VR or AR sessions if necessary.

    Parameters

    • mode: XRSessionMode

    Returns boolean

    true if the mode is supported (if false the mode is not supported by this component and it will not receive XR callbacks for this mode)

Optionalupdate

  • update(): void

  • regular callback in a frame (called every frame when implemented)

    Returns void

Settings

Member Visibility

On This Page

Properties
Accessors
Methods