Class Context

constructor

• new Context(args?): Context

• Parameters

  • Optional args: ContextArgs

  Returns Context

Optional hash

arOverlayElement

• get arOverlayElement(): HTMLElement

• Returns HTMLElement

currentFrameEvent

• get currentFrameEvent(): FrameEvent

• Current event of the update cycle

  Returns FrameEvent

depthTexture

• get depthTexture(): any

• Returns any

domHeight

• get domHeight(): number

• Returns number

domWidth

• get domWidth(): number

• Returns number

domX

• get domX(): number

• Returns number

domY

• get domY(): number

• Returns number

isCreated

• get isCreated(): boolean

• Returns boolean

isInAR

• get isInAR(): boolean

• Returns boolean

isInVR

• get isInVR(): boolean

• Returns boolean

isInXR

• get isInXR(): any

• Returns any

isRendering

• get isRendering(): boolean

• Returns boolean

isVisibleToUser

• get isVisibleToUser(): boolean

• returns true if the dom element is visible on screen

  Returns boolean

mainCamera

• get mainCamera(): any

• Returns any

opaqueColorTexture

• get opaqueColorTexture(): any

• Returns any

rendererData

• get rendererData(): RendererData

• Returns RendererData

  Deprecated

  Use sceneLighting

resolutionScaleFactor

• get resolutionScaleFactor(): number

• Returns number

• set resolutionScaleFactor(val): void

• use to scale the resolution up or down of the renderer. default is 1

  Parameters

  • val: number

  Returns void

version

• get version(): string

• the needle engine version

  Returns string

xrFrame

• get xrFrame(): any

• Returns any

xrSession

• get xrSession(): any

• Returns any

Static Current

• get Current(): Context

• Returns Context

• set Current(context): void

• Parameters

  • context: Context

  Returns void

addAfterRenderListener

• addAfterRenderListener(target, callback): void

• use this to subscribe to onAfterRender events on threejs objects

  Parameters

  • target: Object3D
  • callback: OnRenderCallback

  Returns void

addBeforeRenderListener

• addBeforeRenderListener(target, callback): void

• use this to subscribe to onBeforeRender events on threejs objects

  Parameters

  • target: Object3D
  • callback: OnRenderCallback

  Returns void

clear

• clear(): void

• Will destroy all scenes and objects in the scene

  Returns void

dispose

• dispose(): void

• Returns void

onCreate

• onCreate(buildScene?, opts?): Promise<boolean | any[]>

• Parameters

  • Optional buildScene: ((context, loadingOptions?) => Promise<void>)
    • • (context, loadingOptions?): Promise<void>

      • Parameters

        • context: Context
        • Optional loadingOptions: LoadingOptions

        Returns Promise<void>

  • Optional opts: LoadingOptions

  Returns Promise<boolean | any[]>

registerCoroutineUpdate

• registerCoroutineUpdate(script, coroutine, evt): Generator<unknown, any, unknown>

• Parameters

  • script: IComponent
  • coroutine: Generator<unknown, any, unknown>
  • evt: FrameEvent

  Returns Generator<unknown, any, unknown>

removeAfterRenderListener

• removeAfterRenderListener(target, callback): void

• Parameters

  • target: Object3D
  • callback: OnRenderCallback

  Returns void

removeBeforeRenderListener

• removeBeforeRenderListener(target, callback): void

• Parameters

  • target: Object3D
  • callback: OnRenderCallback

  Returns void

removeCamera

• removeCamera(cam?): void

• Parameters

  • Optional cam: ICamera

  Returns void

renderNow

• renderNow(camera?): boolean

• Parameters

  • Optional camera: Camera

  Returns boolean

restartRenderLoop

• restartRenderLoop(): boolean

• Sets the animation loop.
  Can not be done while creating the context or when disposed

  Returns boolean

setCurrentCamera

• setCurrentCamera(cam): void

• Parameters

  • cam: ICamera

  Returns void

setRequireColor

• setRequireColor(val): void

• Parameters

  • val: boolean

  Returns void

setRequireDepth

• setRequireDepth(val): void

• Parameters

  • val: boolean

  Returns void

stopAllCoroutinesFrom

• stopAllCoroutinesFrom(script): void

• Parameters

  • script: IComponent

  Returns void

unregisterCoroutineUpdate

• unregisterCoroutineUpdate(coroutine, evt): void

• Parameters

  • coroutine: Generator<unknown, any, unknown>
  • evt: FrameEvent

  Returns void

updateAspect

• updateAspect(camera, width?, height?): void

• Parameters

  • camera: PerspectiveCamera
  • Optional width: number
  • Optional height: number

  Returns void

updateSize

• updateSize(): void

• Returns void