Class Context

Implements

  • IContext

Constructors

constructor

Properties

assets domElement hash? isManagedExternally isPaused runInBackground targetFrameRate?

Accessors

arOverlayElement currentFrameEvent depthTexture domHeight domWidth domX domY isCreated isInAR isInVR isInXR isRendering isVisibleToUser mainCamera opaqueColorTexture rendererData resolutionScaleFactor version xrCamera xrFrame xrSession Current DefaultTargetFrameRate

Methods

addAfterRenderListener addBeforeRenderListener appendHTMLElement clear create dispose onCreate onDestroy registerCoroutineUpdate removeAfterRenderListener removeBeforeRenderListener removeCamera renderNow restartRenderLoop setCurrentCamera setRequireColor setRequireDepth stopAllCoroutinesFrom unregisterCoroutineUpdate update updateAspect updateSize

Constructors

constructor

Properties

assets

assets: AssetDatabase

Deprecated

AssetDataBase is deprecated

domElement

domElement: HTMLElement

the HTML element

Optional hash

hash?: string

used to append to loaded assets

Readonly isManagedExternally

isManagedExternally: boolean = false

When the renderer or camera are managed by an external process (e.g. when running in r3f context)

isPaused

isPaused: boolean = false

set to true to pause the update loop. You can receive an event for it in your components. Note that script updates will not be called when paused

runInBackground

runInBackground: boolean = false

When enabled the application will run while not visible on the page

Optional targetFrameRate

targetFrameRate?: number | {
    value?: number;
}

Set to the target framerate you want your application to run in (you can use ?stats to check the fps) Set to undefined if you want to run at the maximum framerate

Type declaration

  • Optional value?: number

Accessors

arOverlayElement

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

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

Methods

addAfterRenderListener

  • addAfterRenderListener(target, callback): void

  • use this to subscribe to onAfterRender events on threejs objects

    Parameters

    Returns void

addBeforeRenderListener

  • addBeforeRenderListener(target, callback): void

  • use this to subscribe to onBeforeRender events on threejs objects

    Parameters

    Returns void

appendHTMLElement

clear

  • clear(): void

  • Will destroy all scenes and objects in the scene

    Returns void

create

dispose

  • dispose(): void

  • Returns void

onCreate

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

  • Parameters

    Returns Promise<boolean | any[]>

    Deprecated

    use create. This method will be removed in a future version

onDestroy

  • onDestroy(): void

  • Returns void

    Deprecated

    use dispose()

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

removeBeforeRenderListener

removeCamera

  • removeCamera(cam?): void

  • Parameters

    • Optional cam: ICamera

    Returns void

renderNow

  • renderNow(camera?): boolean

  • Parameters

    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

  • 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

updateSize

  • updateSize(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

constructorassetsdomElementhashisManagedExternallyisPausedrunInBackgroundtargetFrameRatearOverlayElementcurrentFrameEventdepthTexturedomHeightdomWidthdomXdomYisCreatedisInARisInVRisInXRisRenderingisVisibleToUsermainCameraopaqueColorTexturerendererDataresolutionScaleFactorversionxrCameraxrFramexrSessionCurrentDefaultTargetFrameRateaddAfterRenderListeneraddBeforeRenderListenerappendHTMLElementclearcreatedisposeonCreateonDestroyregisterCoroutineUpdateremoveAfterRenderListenerremoveBeforeRenderListenerremoveCamerarenderNowrestartRenderLoopsetCurrentCamerasetRequireColorsetRequireDepthstopAllCoroutinesFromunregisterCoroutineUpdateupdateupdateAspectupdateSize

Generated using TypeDoc