Class BaseScene<ApplicationContext, Renderer, Scene, Camera, Raycaster, Container, DisplayObject, Viewport>`Abstract`

graphic render component

Type Parameters

ApplicationContext
Renderer
Scene
Camera
Raycaster
Container
DisplayObject
Viewport

Hierarchy

Component<BaseSceneProps>
- BaseScene

Index

Constructors

constructor

Accessors

context

Constructors

constructor

new BaseScene<ApplicationContext, Renderer, Scene, Camera, Raycaster, Container, DisplayObject, Viewport>(props): BaseScene<ApplicationContext, Renderer, Scene, Camera, Raycaster, Container, DisplayObject, Viewport>
Type Parameters
- ApplicationContext
- Renderer
- Scene
- Camera
- Raycaster
- Container
- DisplayObject
- Viewport
Parameters
- props: ComponentProps<BaseSceneProps>
Returns BaseScene<ApplicationContext, Renderer, Scene, Camera, Raycaster, Container, DisplayObject, Viewport>
Overrides Component.constructor
- Defined in packages/renderer-core/typings/scene.d.ts:162

Properties

_vNode

_vNode: VirtualNode<any>

backgroundImage

backgroundImage: DisplayObject

`Optional` camera

camera?: Camera

相机实例，仅 3d 下有

`Private` compute2dOriginView

compute2dOriginView: any

计算2d原始视图的缩放和位置

`Private` computeViewport

computeViewport: any

计算视口的缩放和位置、可见性

coordinate

coordinate: CoordinateController

`Private` coordinateTransform

coordinateTransform: any

坐标转化

`Abstract` defaultSceneViewType

defaultSceneViewType: symbol

默认的场景视图类型标识

`Private` getCoordinateCtrl

getCoordinateCtrl: any

getCurrentApp

getCurrentApp: (() => undefined | ApplicationContext)

Type declaration

- (): undefined | ApplicationContext
- Returns undefined | ApplicationContext

getCurrentInteractiveController

getCurrentInteractiveController: (() => undefined | InteractiveController<any, any, any>)

Type declaration

- (): undefined | InteractiveController<any, any, any>
- Returns undefined | InteractiveController<any, any, any>

`Private` getSceneTools

getSceneTools: any

`Private` getViewEntity

getViewEntity: any

height

height: number

`Private` initInteractiveController

initInteractiveController: any

`Private` loadCanvas

loadCanvas: any

maxFPS

maxFPS: number

mountTimer

mountTimer: number

onClick

onClick: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onDBClick

onDBClick: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onDragEnd

onDragEnd: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onDragMove

onDragMove: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onDragStart

onDragStart: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onPinch

onPinch: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onPinchEnd

onPinchEnd: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onPinchStart

onPinchStart: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onPointerMove

onPointerMove: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onPointerUp

onPointerUp: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onPress

onPress: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onPressUp

onPressUp: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onRightClick

onRightClick: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onRotate

onRotate: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onRotateEnd

onRotateEnd: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onRotateStart

onRotateStart: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

onWheel

onWheel: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: SceneEvent<any>
  Returns void

props

props: ComponentProps<BaseSceneProps>

`Optional` raycaster

raycaster?: Raycaster

射线实例，仅 3d 下有

renderFlag

renderFlag: boolean

`Private` resizeHandler

resizeHandler: any

`Private` resizeStageByCanvas

resizeStageByCanvas: any

resolution

resolution: number

`Optional` scene

scene?: Scene

场景实例，仅 3d 下有

sceneContext

sceneContext: SceneContext

`Abstract` sceneType

sceneType: SceneType

场景类型，标识是 2d 还是 3d 场景

tickers

tickers: Function[]

`Private` updateCameraInfo

updateCameraInfo: any

`Private` updateCursorHandler

updateCursorHandler: any

`Private` updateRenderFlag

updateRenderFlag: any

更新渲染状态

view

view: Container

模型实际容器

`Optional` viewport

viewport?: Viewport

模型视口容器（有多视图的时候才有）

width

width: number

`Static` BACKGROUND_COLOR

BACKGROUND_COLOR: number

默认背景色

`Static` DEFAULT_HEIGHT

DEFAULT_HEIGHT: number

默认画布高度

`Static` DEFAULT_WIDTH

DEFAULT_WIDTH: number

默认画布宽度

`Static` SCALE_BIGGER

SCALE_BIGGER: number

`Static` SCALE_SMALLER

SCALE_SMALLER: number

`Static` TRANSPARENT

TRANSPARENT: boolean

默认是否透明

`Static` appMap

appMap: Map<string, any>

挂载点与应用上下文的映射关系

`Static` appMountedStatus

appMountedStatus: Map<string, boolean>

应用上下文是否已经挂载的状态

`Static` interactiveMap

interactiveMap: Map<any, IInteractiveControllerInfo<any, any, any>>

应用上下文与不同视角交互控制器的映射关系

Accessors

context

get context(): SceneContext
Returns SceneContext
Inherited from Component.context
- Defined in packages/renderer-core/typings/component.d.ts:38

Methods

`Abstract` addChildView

addChildView(view): void
添加子视图的接口
Parameters
- view: DisplayObject
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:181

`Abstract` addRootViewContainer

addRootViewContainer(app): void
添加根视图容器到 app stage 的实现
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:245

`Abstract` canvasDragImpl

canvasDragImpl(event, type): void
画布拖拽功能的实现，注意：如果已经引入其他交互插件则无需重复实现，避免实现上的冲突
Parameters
- event: SceneEvent<any>
- type: "start" | "move" | "end"
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:264

`Abstract` canvasScaleImpl

canvasScaleImpl(event): void
画布缩放功能的实现，注意：如果已经引入其他交互插件则无需重复实现，避免实现上的冲突
Parameters
- event: SceneEvent<any>
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:266

componentDidMount

componentDidMount(): void
Returns void
Overrides Component.componentDidMount
- Defined in packages/renderer-core/typings/scene.d.ts:163

componentDidUpdate

componentDidUpdate(): void
Returns void
Overrides Component.componentDidUpdate
- Defined in packages/renderer-core/typings/scene.d.ts:164

componentWillMount

componentWillMount(): void | Promise<void>
Returns void | Promise<void>
Inherited from Component.componentWillMount
- Defined in packages/renderer-core/typings/component.d.ts:42

componentWillUnmount

componentWillUnmount(): void
Returns void
Overrides Component.componentWillUnmount
- Defined in packages/renderer-core/typings/scene.d.ts:169

componentWillUpdate

componentWillUpdate(nextProps?): void | Promise<void>
Parameters
- Optional nextProps: Readonly<ComponentProps<BaseSceneProps>>
Returns void | Promise<void>
Inherited from Component.componentWillUpdate
- Defined in packages/renderer-core/typings/component.d.ts:43

`Abstract` createApp

createApp(): ApplicationContext
创建 gl app instance，并返回

Returns ApplicationContext
- Defined in packages/renderer-core/typings/scene.d.ts:175

`Abstract` createCoordinateController

createCoordinateController(app): CoordinateController
初始化坐标系控制系统
Parameters
- app: ApplicationContext
Returns CoordinateController
- Defined in packages/renderer-core/typings/scene.d.ts:220

`Abstract` createView

createView(): Container
创建根视图，给 view 设值

Returns Container
- Defined in packages/renderer-core/typings/scene.d.ts:177

`Abstract` createViewport

createViewport(): void
初始化视口，给 viewport 设值

Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:272

`Abstract` destroyApp

destroyApp(app): void
销毁 gl app 及相关清理工作的实现
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:173

`Abstract` destroyRendererInteraction

destroyRendererInteraction(app): void
关闭渲染器的默认交互
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:183

forceUpdate

forceUpdate(): void
Returns void
Inherited from Component.forceUpdate
- Defined in packages/renderer-core/typings/component.d.ts:40

`Abstract` getCanvasView

getCanvasView(app): ICanvasInfo<Renderer>
Parameters
- app: ApplicationContext
Returns ICanvasInfo<Renderer>
- Defined in packages/renderer-core/typings/scene.d.ts:184

`Abstract` getHitTargetOriginal

getHitTargetOriginal(): ((point, container, configMap, interactiveType) => {
    originalTarget?: DisplayObject;
    originalTargetPoint?: Vec2 | Vec3;
    target?: DisplayObject;
})
获取 hitTarget 的原始实现方法

Returns ((point, container, configMap, interactiveType) => {
    originalTarget?: DisplayObject;
    originalTargetPoint?: Vec2 | Vec3;
    target?: DisplayObject;
})
- - (point, container, configMap, interactiveType): {
        originalTarget?: DisplayObject;
        originalTargetPoint?: Vec2 | Vec3;
        target?: DisplayObject;
    }
  - 获取 hitTarget 的原始实现方法
    Parameters
    - point: Vec2
    - container: Container
    - configMap: Map<DisplayObject, InteractiveConfig>
    - interactiveType: InteractiveType
    Returns {
        originalTarget?: DisplayObject;
        originalTargetPoint?: Vec2 | Vec3;
        target?: DisplayObject;
    }
    - Optional originalTarget?: DisplayObject
      event 的直接对象
    - Optional originalTargetPoint?: Vec2 | Vec3
      选中对象的具体场景鼠标位置
    - Optional target?: DisplayObject
      originalTarget 或 originalTarget 的祖先中的第一个可被交互的元素
- Defined in packages/renderer-core/typings/scene.d.ts:186

`Abstract` getScreenShot

getScreenShot(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>
- Defined in packages/renderer-core/typings/scene.d.ts:280

`Abstract` getViewInfo

getViewInfo(): ViewInfo
获取根视图的基本信息（position、scale、visible）

Returns ViewInfo
- Defined in packages/renderer-core/typings/scene.d.ts:179

`Abstract` getViewport

getViewport(): undefined | Viewport
获取视口的实现

Returns undefined | Viewport
- Defined in packages/renderer-core/typings/scene.d.ts:268

`Abstract` getViewportInfo

getViewportInfo(): undefined | ViewInfo
获取视口基础信息的实现

Returns undefined | ViewInfo
- Defined in packages/renderer-core/typings/scene.d.ts:270

`Abstract` initSkyBox

initSkyBox(app): void
初始化天空盒
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:223

`Abstract` mountCanvas

mountCanvas(renderer): void
将渲染器/画布挂载到视图布局上（浏览器环境下无需另外实现）
Parameters
- renderer: Renderer
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:213

`Abstract` removeAppChildrenView

removeAppChildrenView(app): void
移除应用子视图
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:171

render

render(): null | Element<any>[]
Returns null | Element<any>[]
Inherited from Component.render
- Defined in packages/renderer-core/typings/component.d.ts:44

`Abstract` resizeStage

resizeStage(app): void
resize 场景大小
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:227

`Abstract` resizeViewport

resizeViewport(app): void
resize 视口
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:237

`Abstract` setBackGroundImage

setBackGroundImage(app): void
设置背景图
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:229

`Abstract` setViewPosition

setViewPosition(position): void
设置根视图的位置
Parameters
- position: Partial<Vec3>
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:239

`Abstract` setViewScale

setViewScale(scale): void
设置根视图的缩放
Parameters
- scale: Partial<Vec3>
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:241

`Abstract` setViewVisible

setViewVisible(visible): void
设置根视图是否可见
Parameters
- visible: boolean
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:243

`Abstract` setViewportPosition

setViewportPosition(position): void
设置视口的位置
Parameters
- position: Partial<Vec3>
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:274

`Abstract` setViewportScale

setViewportScale(scale): void
设置视口的缩放
Parameters
- scale: Partial<Vec3>
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:276

`Abstract` setViewportVisible

setViewportVisible(visible): void
设置视口是否可见
Parameters
- visible: boolean
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:278

shouldComponentUpdate

shouldComponentUpdate(nextProps?): boolean
Parameters
- Optional nextProps: Readonly<ComponentProps<BaseSceneProps>>
Returns boolean
Inherited from Component.shouldComponentUpdate
- Defined in packages/renderer-core/typings/component.d.ts:41

`Abstract` unmountCanvas

unmountCanvas(): void
卸载画布的钩子（主要做一些清理回收工作，浏览器环境下无需另外实现）

Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:168

`Abstract` updateCameraPosition

updateCameraPosition(position): void
更新相机位置
Parameters
- position: Vec3
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:217

`Abstract` updateCursor

updateCursor(app, cursor): void
Parameters
- app: ApplicationContext
- cursor: string
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:204

`Abstract` updateResolution

updateResolution(app): void
更新分辨率
Parameters
- app: ApplicationContext
Returns void
- Defined in packages/renderer-core/typings/scene.d.ts:195

Class BaseScene<ApplicationContext, Renderer, Scene, Camera, Raycaster, Container, DisplayObject, Viewport>Abstract

Type Parameters

ApplicationContext

Renderer

Scene

Camera

Raycaster

Container

DisplayObject

Viewport

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

ApplicationContext

Renderer

Scene

Camera

Raycaster

Container

DisplayObject

Viewport

Parameters

props: ComponentProps<BaseSceneProps>

Returns BaseScene<ApplicationContext, Renderer, Scene, Camera, Raycaster, Container, DisplayObject, Viewport>

Properties

_vNode

backgroundImage

Optional camera

Private compute2dOriginView

Private computeViewport

coordinate

Private coordinateTransform

Abstract defaultSceneViewType

Private getCoordinateCtrl

getCurrentApp

Type declaration

Returns undefined | ApplicationContext

getCurrentInteractiveController

Type declaration

Returns undefined | InteractiveController<any, any, any>

Private getSceneTools

Private getViewEntity

height

Private initInteractiveController

Private loadCanvas

maxFPS

mountTimer

onClick

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onDBClick

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onDragEnd

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onDragMove

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onDragStart

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onPinch

Type declaration

Class BaseScene<ApplicationContext, Renderer, Scene, Camera, Raycaster, Container, DisplayObject, Viewport>`Abstract`

`Optional` camera

`Private` compute2dOriginView

`Private` computeViewport

`Private` coordinateTransform

`Abstract` defaultSceneViewType

`Private` getCoordinateCtrl

`Private` getSceneTools

`Private` getViewEntity

`Private` initInteractiveController

`Private` loadCanvas

`Optional` raycaster

`Private` resizeHandler

`Private` resizeStageByCanvas

`Optional` scene

`Abstract` sceneType

`Private` updateCameraInfo

`Private` updateCursorHandler