Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CameraView

相机元素视图, 渲染相机元素所看到的图像, 用于虚拟部署, 需要在新版本中更新

Hierarchy

  • View
    • CameraView

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new CameraView(container: HTMLElement): CameraView

  • Parameters

    • container: HTMLElement

      目标容器

    Returns CameraView

Properties

Optional camera

camera: NS_THREE.Camera

container

container: HTMLElement

Protected enabled

enabled: boolean

Protected eventMap

eventMap: Map<string, Set<Function>>

parent

parent: Screen | null

View 的父级 Screen, 可能不存在

renderOrder

renderOrder: number

该 View 在父级 Screen 的渲染顺序, 值越大渲染顺序越靠后, 即更高层级

renderStage

renderStage: boolean

是否渲染 Stage 内内容, 用于只希望渲染 Overlay 的情况

renderer

renderer: WebGL1Renderer

Protected rendererOffset

rendererOffset: Vector4

Protected rendererOffsetDefault

rendererOffsetDefault: Vector4

stage

stage: Stage

View 所关联的 Stage

Accessors

canvas

  • get canvas(): HTMLCanvasElement

  • Returns HTMLCanvasElement

render3D

  • set render3D(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

Methods

addOverlay

  • addOverlay(overlay: Overlay): void

  • 添加 Overlay, Overlay 渲染顺序与添加顺序一致

    Parameters

    • overlay: Overlay

      需要添加的 Overlay

    Returns void

bindCamera

  • bindCamera(camera: Camera): void

  • 绑定相机元素, 绑定后视图将显示传入相机元素所看到的图像

    Parameters

    • camera: Camera

      绑定的相机元素

    Returns void

bindScreen

  • bindScreen(screen: Screen): void

  • 绑定 Screen

    Parameters

    Returns void

bindStage

  • bindStage(stage: Stage): void

  • 绑定 Stage

    Parameters

    • stage: Stage

      需要绑定的 Stage

    Returns void

dispose

  • dispose(): void

  • Returns void

Protected emit

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

  • Parameters

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

    Returns void

getActiveCamera

  • getActiveCamera(): Camera | undefined | null

  • 获取当前绑定的相机元素

    Returns Camera | undefined | null

getViewHeight

  • getViewHeight(): number

  • 获取view的实际高度

    Returns number

getViewOffset

  • getViewOffset(): [number, number]

  • 获取view的实际与screen的偏离

    Returns [number, number]

getViewWidth

  • getViewWidth(): number

  • 获取view的实际宽度

    Returns number

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

removeOverlay

  • removeOverlay(overlay: Overlay): void

  • 移除 Overlay

    Parameters

    • overlay: Overlay

      需要移除的 Overlay

    Returns void

setEnabled

  • setEnabled(value: boolean): void

  • 设置当前View是否工作

    Parameters

    • value: boolean

      开关值

    Returns void

setRenderOrder

  • setRenderOrder(renderOrder: number): void

  • Parameters

    • renderOrder: number

    Returns void

setViewport

  • setViewport(rendererOffset: Vector4): void

  • 设置 View的 裁剪区域，外部调用

    Parameters

    • rendererOffset: Vector4

      裁剪配置

    Returns void

unbindCamera

  • unbindCamera(): void

  • 解绑相机元素 取消相机辅助线，并清空画布 edited by kxiao

    Returns void

unbindScreen

  • unbindScreen(): void

  • 解绑 Screen

    Returns void