Class Scene2D

graphic render component

Hierarchy

BaseScene<PIXI.Application, HTMLCanvasElement, never, never, never, PIXI.Container, PIXI.DisplayObject, PIXI.Sprite>
- Scene2D

Index

Constructors

constructor

Accessors

context

Constructors

constructor

new Scene2D(props): Scene2D
Parameters
- props: ComponentProps<BaseSceneProps>
Returns Scene2D
Overrides BaseScene.constructor
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:73

Properties

_vNode

_vNode: VirtualNode<any>

backgroundImage

backgroundImage: DisplayObject

`Private` `Optional` brt

brt?: BaseRenderTexture

`Optional` camera

camera?: undefined

相机实例，仅 3d 下有

coordinate

coordinate: CoordinateController

defaultSceneViewType

defaultSceneViewType: symbol = Scene2DSymbol

默认的场景视图类型标识

getCurrentApp

getCurrentApp: (() => undefined | Application)

Type declaration

- (): undefined | Application
- Returns undefined | Application

getCurrentInteractiveController

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

Type declaration

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

height

height: number

maxFPS

maxFPS: number

mountTimer

mountTimer: number

`Private` offsetCenter

offsetCenter: Vec2 = ...

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

`Private` originalResizeFramebufferFunction

originalResizeFramebufferFunction: Function

props

props: ComponentProps<BaseSceneProps>

`Optional` raycaster

raycaster?: undefined

射线实例，仅 3d 下有

renderFlag

renderFlag: boolean

resolution

resolution: number

`Private` `Optional` rt

rt?: RenderTexture

`Optional` scene

scene?: undefined

场景实例，仅 3d 下有

sceneContext

sceneContext: SceneContext

sceneType

sceneType: SceneType = SceneType.Scene2D

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

tickers

tickers: Function[]

view

view: Container

模型实际容器

`Optional` viewport

viewport?: Sprite

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

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 BaseScene.context
- Defined in packages/renderer-core/typings/component.d.ts:38

Methods

addChildView

addChildView(view): void
添加子视图的接口
Parameters
- view: DisplayObject
Returns void
Overrides BaseScene.addChildView
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:279

addRootViewContainer

addRootViewContainer(app): void
添加根视图容器到 app stage 的实现
Parameters
- app: Application
Returns void
Overrides BaseScene.addRootViewContainer
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:159

canvasDragImpl

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

canvasScaleImpl

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

componentDidMount

componentDidMount(): void
Returns void
Inherited from BaseScene.componentDidMount
- Defined in packages/renderer-core/typings/scene.d.ts:163

componentDidUpdate

componentDidUpdate(): void
Returns void
Overrides BaseScene.componentDidUpdate
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:78

componentWillMount

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

componentWillUnmount

componentWillUnmount(): void
Returns void
Inherited from BaseScene.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 BaseScene.componentWillUpdate
- Defined in packages/renderer-core/typings/component.d.ts:43

createApp

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

Returns Application
Overrides BaseScene.createApp
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:217

createCoordinateController

createCoordinateController(app): CoordinateControllerPixi
初始化坐标系控制系统
Parameters
- app: Application
Returns CoordinateControllerPixi
Overrides BaseScene.createCoordinateController
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:325

createView

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

Returns Container
Overrides BaseScene.createView
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:91

createViewport

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

Returns void
Overrides BaseScene.createViewport
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:182

destroyApp

destroyApp(app): void
销毁 gl app 及相关清理工作的实现
Parameters
- app: Application
Returns void
Overrides BaseScene.destroyApp
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:369

destroyRendererInteraction

destroyRendererInteraction(app): void
停止内置的 InteractionManager
Parameters
- app: Application
Returns void
Overrides BaseScene.destroyRendererInteraction
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:273

`Private` fixResizeFramebufferBug

fixResizeFramebufferBug(app, resizeFramebuffer?): void
修复 PIXI bug，改写 resizeFramebuffer，解决 pixi frame buffer 只能由大变小但不能由小变大 resize 的问题因为修复此 bug 会导致性能问题，所以只在必要的时候使用，通过参数控制改写的内容
Parameters
- app: Application
- resizeFramebuffer: boolean = false
Returns void
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:254

forceUpdate

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

getCanvasView

getCanvasView(app): {
    height: number;
    renderer: HTMLCanvasElement;
    width: number;
}
Parameters
- app: Application
Returns {
    height: number;
    renderer: HTMLCanvasElement;
    width: number;
}
- height: number
- renderer: HTMLCanvasElement
- width: number
Overrides BaseScene.getCanvasView
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:283

getHitTargetOriginal

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

Returns ((point, container, configMap, interactiveType) => {
originalTarget: DisplayObject;
target: undefined | DisplayObject;
})
- - (point, container, configMap, interactiveType): {
    originalTarget: DisplayObject;
    target: undefined | DisplayObject;
    }
  - Parameters
    - point: Vec2
    - container: Container
    - configMap: Map<DisplayObject, InteractiveConfig>
    - interactiveType: InteractiveType
    Returns {
    originalTarget: DisplayObject;
    target: undefined | DisplayObject;
    }
    - originalTarget: DisplayObject
    - target: undefined | DisplayObject
Overrides BaseScene.getHitTargetOriginal
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:300

getScreenShot

getScreenShot(sx?, sy?, w?, h?, fileType?, quality?, isBase64?): Promise<string | Blob>
获取截图
Parameters
- sx: number = 0
- sy: number = 0
- Optional w: number
- Optional h: number
- fileType: string = 'image/png'
- quality: number = 1
- isBase64: boolean = true
Returns Promise<string | Blob>
Overrides BaseScene.getScreenShot
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:379

getViewInfo

getViewInfo(): {
    position: {
        x: number;
        y: number;
    };
    scale: {
        x: number;
        y: number;
    };
    visible: boolean;
}
获取根视图的基本信息（position、scale、visible）

Returns {
    position: {
        x: number;
        y: number;
    };
    scale: {
        x: number;
        y: number;
    };
    visible: boolean;
}
- position: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- scale: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- visible: boolean
Overrides BaseScene.getViewInfo
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:98

getViewport

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

Returns undefined | Sprite
Overrides BaseScene.getViewport
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:200

getViewportInfo

getViewportInfo(): undefined | {
    height: number;
    position: {
        x: number;
        y: number;
    };
    scale: {
        x: number;
        y: number;
    };
    visible: boolean;
    width: number;
}
获取视口基础信息的实现

Returns undefined | {
    height: number;
    position: {
        x: number;
        y: number;
    };
    scale: {
        x: number;
        y: number;
    };
    visible: boolean;
    width: number;
}
Overrides BaseScene.getViewportInfo
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:204

initSkyBox

initSkyBox(): void
初始化天空盒

Returns void
Overrides BaseScene.initSkyBox
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:348

mountCanvas

mountCanvas(): void
将渲染器/画布挂载到视图布局上（浏览器环境下无需另外实现）

Returns void
Overrides BaseScene.mountCanvas
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:296

removeAppChildrenView

removeAppChildrenView(app): void
移除应用子视图
Parameters
- app: Application
Returns void
Overrides BaseScene.removeAppChildrenView
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:374

render

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

resizeStage

resizeStage(app): void
resize 场景大小
Parameters
- app: Application
Returns void
Overrides BaseScene.resizeStage
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:329

resizeViewport

resizeViewport(app): void
resize 视口
Parameters
- app: Application
Returns void
Overrides BaseScene.resizeViewport
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:361

setBackGroundImage

setBackGroundImage(app): void
设置背景图
Parameters
- app: Application
Returns void
Overrides BaseScene.setBackGroundImage
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:336

setViewPosition

setViewPosition(position): void
设置根视图的位置
Parameters
- position: Partial<Vec3>
Returns void
Overrides BaseScene.setViewPosition
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:106

setViewScale

setViewScale(scale): void
设置根视图的缩放
Parameters
- scale: Partial<Vec3>
Returns void
Overrides BaseScene.setViewScale
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:115

setViewVisible

setViewVisible(visible): void
设置根视图是否可见
Parameters
- visible: boolean
Returns void
Overrides BaseScene.setViewVisible
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:124

setViewportPosition

setViewportPosition(position): void
设置视口的位置
Parameters
- position: Partial<Vec3>
Returns void
Overrides BaseScene.setViewportPosition
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:128

setViewportScale

setViewportScale(scale): void
设置视口的缩放
Parameters
- scale: Partial<Vec3>
Returns void
Overrides BaseScene.setViewportScale
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:140

setViewportVisible

setViewportVisible(visible): void
设置视口是否可见
Parameters
- visible: boolean
Returns void
Overrides BaseScene.setViewportVisible
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:152

shouldComponentUpdate

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

unmountCanvas

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

Returns void
Overrides BaseScene.unmountCanvas
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:292

updateCameraPosition

updateCameraPosition(): void
更新相机位置

Returns void
Overrides BaseScene.updateCameraPosition
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:246

updateCameraTarget

updateCameraTarget(): void
Returns void
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:242

updateCursor

updateCursor(app, cursor): void
Parameters
- app: Application
- cursor: string
Returns void
Overrides BaseScene.updateCursor
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:321

updateResolution

updateResolution(app): void
更新分辨率
Parameters
- app: Application
Returns void
Overrides BaseScene.updateResolution
- Defined in packages/renderer-pixi/src/Scene2D/index.ts:352

Class Scene2D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: ComponentProps<BaseSceneProps>

Returns Scene2D

Properties

_vNode

backgroundImage

Private Optional brt

Optional camera

coordinate

defaultSceneViewType

getCurrentApp

Type declaration

Returns undefined | Application

getCurrentInteractiveController

Type declaration

Returns undefined | InteractiveController<any, any, any>

height

maxFPS

mountTimer

Private offsetCenter

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

Parameters

event: SceneEvent<any>

Returns void

onPinchEnd

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onPinchStart

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onPointerMove

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onPointerUp

Type declaration

Parameters

event: SceneEvent<any>

Returns void

onPress

`Private` `Optional` brt

`Optional` camera

`Private` offsetCenter

`Private` originalResizeFramebufferFunction

`Optional` raycaster

`Private` `Optional` rt

`Optional` scene

`Optional` viewport

`Static` BACKGROUND_COLOR

`Static` DEFAULT_HEIGHT

`Static` DEFAULT_WIDTH

`Static` SCALE_BIGGER

`Static` SCALE_SMALLER

`Static` TRANSPARENT

`Static` appMap

`Static` appMountedStatus

`Static` interactiveMap