Interface SceneTool

interface SceneTool {
    addTicker: ((ticker) => void);
    coordinateTransform: ((point, type, z?) => Vec2 | Vec3);
    getApp: (() => any);
    getCamera: (() => any);
    getRaycaster: (() => any);
    getRootView: (() => any);
    getScene: (() => any);
    getScreenShot: ((sx?, sy?, w?, h?, fileType?, quality?, isBase64?) => Promise<string | Blob>);
    hitTarget: ((point) => undefined | Partial<ViewEntity>);
    removeTicker: ((ticker) => void);
    updateCursor: ((cursor?) => void);
    updateInteractiveObject: ((view, config?) => void);
}

Properties

addTicker coordinateTransform getApp getCamera getRaycaster getRootView getScene getScreenShot hitTarget removeTicker updateCursor updateInteractiveObject

Properties

addTicker

addTicker: ((ticker) => void)

Type declaration

    • (ticker): void

    • Parameters

      • ticker: (() => void)
          • (): void

          • Returns void

      Returns void

coordinateTransform

coordinateTransform: ((point, type, z?) => Vec2 | Vec3)

Type declaration

    • (point, type, z?): Vec2 | Vec3

    • Parameters

      Returns Vec2 | Vec3

getApp

getApp: (() => any)

Type declaration

    • (): any

    • Returns any

getCamera

getCamera: (() => any)

Type declaration

    • (): any

    • Returns any

getRaycaster

getRaycaster: (() => any)

Type declaration

    • (): any

    • Returns any

getRootView

getRootView: (() => any)

Type declaration

    • (): any

    • Returns any

getScene

getScene: (() => any)

Type declaration

    • (): any

    • Returns any

getScreenShot

getScreenShot: ((sx?, sy?, w?, h?, fileType?, quality?, isBase64?) => Promise<string | Blob>)

Type declaration

    • (sx?, sy?, w?, h?, fileType?, quality?, isBase64?): Promise<string | Blob>

    • Parameters

      • Optional sx: number
      • Optional sy: number
      • Optional w: number
      • Optional h: number
      • Optional fileType: string
      • Optional quality: number
      • Optional isBase64: boolean

      Returns Promise<string | Blob>

hitTarget

hitTarget: ((point) => undefined | Partial<ViewEntity>)

Type declaration

    • (point): undefined | Partial<ViewEntity>

    • Parameters

      • point: {
            x: number;
            y: number;
        }
        • x: number
        • y: number

      Returns undefined | Partial<ViewEntity>

removeTicker

removeTicker: ((ticker) => void)

Type declaration

    • (ticker): void

    • Parameters

      • ticker: (() => void)
          • (): void

          • Returns void

      Returns void

updateCursor

updateCursor: ((cursor?) => void)

Type declaration

    • (cursor?): void

    • Parameters

      • Optional cursor: string

      Returns void

updateInteractiveObject

updateInteractiveObject: ((view, config?) => void)

Type declaration

    • (view, config?): void

    • Parameters

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc