Class Context

constructor

• new Context(args?): Context

• Parameters

  • Optional args: ContextArgs

  Returns Context

domElement

Optional hash

isManagedExternally

isPaused

runInBackground

Optional targetFrameRate

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

• set mainCamera(cam): void

• Parameters

  • cam: any

  Returns void

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

xrCamera

• get xrCamera(): any

• Returns any

xrFrame

• get xrFrame(): any

• Returns any

xrSession

• get xrSession(): any

• Returns any

Static Current

• get Current(): Context

• The currently active context. Only set during the update loops

  Returns Context

Static DefaultTargetFrameRate

• get DefaultTargetFrameRate(): number

• When a new context is created this is the framerate that will be used by default

  Returns number
• set DefaultTargetFrameRate(val): void

• When a new context is created this is the framerate that will be used by default

  Parameters

  • val: number

  Returns void

Static DefaultWebGLRendererParameters

• get DefaultWebGLRendererParameters(): WebGLRendererParameters

• Returns WebGLRendererParameters

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

appendHTMLElement

• appendHTMLElement(element): HTMLElement

• Parameters

  • element: HTMLElement

  Returns HTMLElement

clear

• clear(): void

• Will destroy all scenes and objects in the scene

  Returns void

create

• create(opts?): Promise<boolean | any[]>

• Parameters

  • Optional opts: ContextCreateArgs

  Returns Promise<boolean | any[]>

dispose

• dispose(): void

• Returns void

recreate

• recreate(): void

• This will recreate the whole needle engine context and dispose the whole scene content
  All content will be reloaded (loading times might be faster due to browser caches)
  All scripts will be recreated

  Returns void

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

update

• update(timestamp, frame?): void

• Performs a full update step including script callbacks, rendering (unless isManagedExternally is set to false) and post render callbacks

  Parameters

  • timestamp: number
  • Optional frame: any

  Returns void

updateAspect

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

• Parameters

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

  Returns void

updatePhysics

• updatePhysics(steps): void

• Call to manually perform physics steps.
  By default the context uses the physicsSteps property to perform steps during the update loop
  If you just want to increase the accuracy of physics you can instead set the physicsSteps property to a higher value

  Parameters

  • steps: number

  Returns void

updateSize

• updateSize(): void

• Returns void