Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Screen

窗口, 用于描述一个 Canvas / Renderer @ignore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Screen(container?: HTMLElement, options?: object): Screen

  • Parameters

    • Optional container: HTMLElement
    • Default value options: object = {}
      • Optional eventOnContainer?: undefined | false | true
      • Optional height?: undefined | number
      • Optional isCanvas?: undefined | false | true
      • Optional logarithmicDepthBuffer?: undefined | false | true
      • Optional preserveDrawingBuffer?: undefined | false | true
      • Optional width?: undefined | number

    Returns Screen

Properties

canvas

canvas: HTMLCanvasElement

container

container: HTMLElement

enabled

enabled: boolean

eventEnable

eventEnable: boolean = false

Protected eventMap

eventMap: Map<string, Set<Function>>

eventOnContainer

eventOnContainer: boolean

height

height: number

renderer

renderer: WebGL1Renderer | WebGLRenderer

width

width: number

Methods

addView

  • addView(view: View): void

  • 添加 View

    Parameters

    • view: View

      需要添加到 Screen 的 View

    Returns void

contextMenu

  • contextMenu(e: MouseEvent): void

  • Parameters

    • e: MouseEvent

    Returns void

dblclick

  • dblclick(e: MouseEvent): void

  • Parameters

    • e: MouseEvent

    Returns void

dispose

  • dispose(): void

  • Returns void

Protected emit

  • emit(event: string, ...args: unknown[]): void

  • Parameters

    • event: string
    • Rest ...args: unknown[]

    Returns void

mouseDown

  • mouseDown(e: MouseEvent): void

  • Parameters

    • e: MouseEvent

    Returns void

mouseMove

  • mouseMove(e: MouseEvent): void

  • Parameters

    • e: MouseEvent

    Returns void

mouseUp

  • mouseUp(e: MouseEvent): void

  • Parameters

    • e: MouseEvent

    Returns void

mouseWheel

  • mouseWheel(e: WheelEvent): void

  • Parameters

    • e: WheelEvent

    Returns void

off

  • off(event: string, callback: Function): void

  • 注销事件监听

    Parameters

    • event: string

      事件名

    • callback: Function

      回调函数

    Returns void

on

  • on(event: string, callback: Function): void

  • 注册事件监听

    Parameters

    • event: string

      事件名

    • callback: Function

      回调函数

    Returns void

removeView

  • removeView(view: View): void

  • 删除 View

    Parameters

    • view: View

      需要删除的 View

    Returns void

renderScreen

  • renderScreen(): void

  • Returns void

resize

  • resize(width?: undefined | number, height?: undefined | number): void

  • Parameters

    • Optional width: undefined | number
    • Optional height: undefined | number

    Returns void

setClearColor

  • setClearColor(color: number | string, alpha?: number): void

  • 设置清屏时的颜色

    Parameters

    • color: number | string

      颜色

    • Default value alpha: number = 1

      不透明度

    Returns void

setEnabled

  • setEnabled(value: boolean): void

  • 设置当前 Screen 是否工作

    Parameters

    • value: boolean

      开关值

    Returns void

setEventEnable

  • setEventEnable(enable: boolean): void

  • 设置事件有效

    Parameters

    • enable: boolean

      有效

    Returns void

setEventOnContainer

  • setEventOnContainer(eventOnContainer: boolean): void

  • 设置事件在容器上

    Parameters

    • eventOnContainer: boolean

      事件在容器S

    Returns void

touchEnd

  • touchEnd(e: TouchEvent): void

  • Parameters

    • e: TouchEvent

    Returns void

touchMove

  • touchMove(e: TouchEvent): void

  • Parameters

    • e: TouchEvent

    Returns void

touchStart

  • touchStart(e: TouchEvent): void

  • Parameters

    • e: TouchEvent

    Returns void

update

  • update(): boolean

  • Returns boolean