Class WebXR

Hierarchy (view full)

Properties

allowARPlacementReticle

Accessors

ARButton Controllers HeadPose IsInAR IsInVR LeftController Rig RightController TransformOrientation VRButton activeAndEnabled context destroyed enabled forward hideFlags isComponent layer name right scene static tag up worldEuler worldPosition worldQuaternion worldRotation IsARSupported IsInWebXR IsVRSupported OptionalFeatures_AR OptionalFeatures_VR XRSupported

Methods

addEventListener awake destroy dispatchEvent earlyUpdate? endSession lateUpdate? onAfterRender? onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine update? addEventListener createARButton createVRButton removeEventListener resetButtonStyles

Properties

allowARPlacementReticle

allowARPlacementReticle: boolean = true

When enabled

Accessors

ARButton

Controllers

HeadPose

  • get HeadPose(): any

  • Returns any

IsInAR

  • get IsInAR(): boolean

  • Returns boolean

IsInVR

  • get IsInVR(): boolean

  • Returns boolean

LeftController

Rig

  • get Rig(): Object3D

  • Returns Object3D

RightController

TransformOrientation

  • get TransformOrientation(): Quaternion

  • Returns Quaternion

VRButton

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

destroyed

  • get destroyed(): boolean

  • Returns boolean

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

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

name

  • get name(): string

  • Returns string

  • 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

  • Returns Scene

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • 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

    • val: Euler

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    • val: Vector3

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    • val: Quaternion

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    • val: Vector3

    Returns void

Static IsARSupported

  • get IsARSupported(): boolean

  • Returns boolean

Static IsInWebXR

  • get IsInWebXR(): boolean

  • Returns boolean

Static IsVRSupported

  • get IsVRSupported(): boolean

  • Returns boolean

Static OptionalFeatures_AR

  • get OptionalFeatures_AR(): string[]

  • Returns string[]

Static OptionalFeatures_VR

  • get OptionalFeatures_VR(): string[]

  • Returns string[]

Static XRSupported

  • get XRSupported(): boolean

  • Returns boolean

Methods

addEventListener

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

  • Type Parameters

    Parameters

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

        • Parameters

          • evt: T

          Returns any

    Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

destroy

dispatchEvent

Optional earlyUpdate

endSession

  • endSession(): void

  • Returns void

Optional lateUpdate

Optional onAfterRender

onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

Optional onPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

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

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

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

    Parameters

    • Optional prop: string

    Returns void

removeEventListener

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

  • Type Parameters

    Parameters

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

        • Parameters

          • arg: T

          Returns any

    Returns void

Optional resolveGuids

  • 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

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

Optional start

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

Optional update

Static addEventListener

  • addEventListener(type, listener): any

  • Parameters

    • type: string
    • listener: any

    Returns any

Static createARButton

Static createVRButton

Static removeEventListener

  • removeEventListener(type, listener): any

  • Parameters

    • type: string
    • listener: any

    Returns any

Static resetButtonStyles

  • resetButtonStyles(button): void

  • Parameters

    • button: any

    Returns void

Settings

Member Visibility

Theme

On This Page

allowARPlacementReticleARButtonControllersHeadPoseIsInARIsInVRLeftControllerRigRightControllerTransformOrientationVRButtonactiveAndEnabledcontextdestroyedenabledforwardhideFlagsisComponentlayernamerightscenestatictagupworldEulerworldPositionworldQuaternionworldRotationIsARSupportedIsInWebXRIsVRSupportedOptionalFeatures_AROptionalFeatures_VRXRSupportedaddEventListenerawakedestroydispatchEventearlyUpdateendSessionlateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineupdateaddEventListenercreateARButtoncreateVRButtonremoveEventListenerresetButtonStyles

Generated using TypeDoc