Class SceneRenderer

场景渲染器

Export

Date

2022.3.22

Author

lyx

Hierarchy

EngineObject
- SceneRenderer

Constructors

constructor

new SceneRenderer(engine, parameters?): SceneRenderer
Parameters
- engine: Engine
- parameters: SceneRendererParameters = {}
Returns SceneRenderer

Overrides EngineObject.constructor

Properties

`Protected` _engine

_engine: Engine

activeCamera

activeCamera: Entity = null

当前激活的相机

Memberof

SceneRenderer

activeScene

activeScene: Entity = null

当前激活的场景实体

Memberof

SceneRenderer

`Readonly` renderer

renderer: WebGLRenderer

场景渲染器

Memberof

SceneRenderer

`Readonly` viewport

viewport: HTMLElement

渲染窗口

Memberof

SceneRenderer

Accessors

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from EngineObject.engine

Methods

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from EngineObject.addEventListener

compile

compile(scene, camera): void
预编译场景材质
Parameters
- scene: Entity
  
  场景实体
- camera: Entity
  
  相机实体
Returns void

Memberof
SceneRenderer

createPostprocessing

createPostprocessing<T, B>(type, scene, camera, parameters?): T
创建后期处理对象
Type Parameters
- T extends PostprocessingBase
- B extends PostprocessingBaseParameters
Parameters
- type: PostprocessingCtor<T, B>
  
  后期类型
- scene: Entity
  
  关联的场景实体
- camera: Entity
  
  关联的相机实体
- Optional parameters: B
  
  初始化参数
Returns T

Memberof
SceneRenderer

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.dispatchEvent

dispose

dispose(): void
释放渲染器

Returns void

Memberof
SceneRenderer

Overrides EngineObject.dispose

getPostprocessing

getPostprocessing(guid): PostprocessingBase
获取指定GUID后期对象
Parameters
- guid: string
  
  后期处理对象GUID，为其关联的场景&关联的相机GUID的组合（scene.guid_camera.guid）
Returns PostprocessingBase

Memberof
SceneRenderer

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListenerByEventId

removePostprocessing

removePostprocessing(guid): void
移除并消耗指定GUID后期对象
Parameters
- guid: string
  
  后期处理对象GUID，为其关联的场景&关联的相机GUID的组合（scene.guid_camera.guid）
Returns void

Memberof
SceneRenderer

renderOneFrame

renderOneFrame(timeSinceLastFrame?, renderTarget?): void
渲染一帧
Parameters
- Optional timeSinceLastFrame: number
  
  距离上一帧的更新时长（单位：毫秒）
- Optional renderTarget: WebGLRenderTarget<Texture> = null
  
  渲染目标，默认null
Returns void

Memberof
SceneRenderer

renderScene

renderScene(timeSinceLastFrame, timeStamp?, frame?): void
渲染场景
Parameters
- timeSinceLastFrame: number
  
  距离上一帧的更新时长（单位：毫秒）
- Optional timeStamp: number
  
  时间戳
- Optional frame: XRFrame
Returns void

Memberof
SceneRenderer

renderStandardScene

renderStandardScene(timeSinceLastFrame, renderTarget?): void
渲染标准场景（即非XR场景）
Parameters
- timeSinceLastFrame: number
  
  距离上一帧的更新时长（单位：毫秒）
- Optional renderTarget: WebGLRenderTarget<Texture>
  
  渲染目标
Returns void

Memberof
SceneRenderer

resize

resize(width, height): void
渲染窗口‘resize’
Parameters
- width: number
- height: number
Returns void

Memberof
SceneRenderer

screenSnapshot

screenSnapshot(width?, height?): string
场景快照
Parameters
- Optional width: number = 512
  
  快照宽度（单位：像素）
- Optional height: number = 512
  
  快照高度（单位：像素）
Returns string

Memberof
SceneRenderer

setAnimationLoop

setAnimationLoop(callback): void
设置动画循环
Parameters
- callback: any
Returns void

Memberof
SceneRenderer

setupCSS3DRenderer

setupCSS3DRenderer(): void
初始化CSS3D渲染器

Returns void

Memberof
SceneRenderer

transition

transition(targetScene, targetCamera, options?): void
场景转场
Parameters
- targetScene: Entity
  
  目标场景
- targetCamera: Entity
  
  目标相机
- Optional options: TransitionOptions
  
  转场选项
Returns void

Memberof
SceneRenderer