Class Mesh2D<Props>`Abstract`

graphic render component

Type Parameters

Props extends object = {}

Hierarchy

BaseMesh<Props, PIXI.Application, HTMLCanvasElement, never, never, never, PIXI.Container, PIXI.DisplayObject, PIXI.Sprite, Vec2>
- Mesh2D

Constructors

constructor

new Mesh2D<Props>(props?): Mesh2D<Props>
Type Parameters
- Props extends object = {}
Parameters
- props: ComponentProps<Props> = ...
Returns Mesh2D<Props>
Overrides BaseMesh.constructor
- Defined in packages/renderer-pixi/src/Mesh2D/Mesh2D.ts:6

Properties

_vNode

_vNode: VirtualNode<any>

`Protected` autoAppendToWorld

autoAppendToWorld: boolean

是否默认添加到场景中。默认：true

props

props: ComponentProps<Props>

`Protected` reactivePipeLine

reactivePipeLine: (() => void)[]

响应式的渲染任务管线

Type declaration

- (): void
- Returns void

`Protected` view

view: DisplayObject

当前组件的视图对象

`Protected` viewType

viewType: "camera" | "light" | "model"

视图对象的类型（有相机、灯光、模型三类，默认为 model）

Accessors

context

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

`Protected` interactiveConfig

get interactiveConfig(): InteractiveConfig
Returns InteractiveConfig
Inherited from BaseMesh.interactiveConfig
- Defined in packages/renderer-core/typings/mesh.d.ts:53

Methods

addChildView

addChildView(view): void
提供接口用以给子组件添加 view
Parameters
- view: DisplayObject
Returns void
Overrides BaseMesh.addChildView
- Defined in packages/renderer-pixi/src/Mesh2D/Mesh2D.ts:17

addViewToScene

addViewToScene(): void
往场景中添加对象

Returns void
Overrides BaseMesh.addViewToScene
- Defined in packages/renderer-pixi/src/Mesh2D/Mesh2D.ts:47

clearView

clearView(): void
清除当前视图

Returns void
Overrides BaseMesh.clearView
- Defined in packages/renderer-pixi/src/Mesh2D/Mesh2D.ts:23

commit

commit(type): void
Parameters
- type: CommitType
Returns void
Inherited from BaseMesh.commit
- Defined in packages/renderer-core/typings/mesh.d.ts:18

componentDidMount

componentDidMount(): void | Promise<void>
Returns void | Promise<void>
Inherited from BaseMesh.componentDidMount
- Defined in packages/renderer-core/typings/component.d.ts:45

componentDidUpdate

componentDidUpdate(prevProps): void | Promise<void>
Parameters
- prevProps: Readonly<ComponentProps<Props>>
Returns void | Promise<void>
Inherited from BaseMesh.componentDidUpdate
- Defined in packages/renderer-core/typings/component.d.ts:46

componentWillMount

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

componentWillUnmount

componentWillUnmount(): void | Promise<void>
Returns void | Promise<void>
Inherited from BaseMesh.componentWillUnmount
- Defined in packages/renderer-core/typings/component.d.ts:47

componentWillUpdate

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

createDefaultView

createDefaultView(): Container
Returns Container
Overrides BaseMesh.createDefaultView
- Defined in packages/renderer-pixi/src/Mesh2D/Mesh2D.ts:13

`Protected` draw

draw(): void
绘制图形图像，默认在 componentDidMount 时调用

Returns void
Inherited from BaseMesh.draw
- Defined in packages/renderer-core/typings/mesh.d.ts:27

forceUpdate

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

`Protected` getViewEntity

getViewEntity(): Partial<ViewEntity>
Returns Partial<ViewEntity>
Inherited from BaseMesh.getViewEntity
- Defined in packages/renderer-core/typings/mesh.d.ts:70

`Protected` onClick

onClick(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onClick
- Defined in packages/renderer-core/typings/mesh.d.ts:54

`Protected` onClickable

onClickable(): boolean
标记当前对象是否可点击

Returns boolean
Inherited from BaseMesh.onClickable
- Defined in packages/renderer-core/typings/mesh.d.ts:41

`Protected` onDBClick

onDBClick(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onDBClick
- Defined in packages/renderer-core/typings/mesh.d.ts:55

`Protected` onDragEnd

onDragEnd(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onDragEnd
- Defined in packages/renderer-core/typings/mesh.d.ts:59

`Protected` onDragMove

onDragMove(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onDragMove
- Defined in packages/renderer-core/typings/mesh.d.ts:58

`Protected` onDragStart

onDragStart(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onDragStart
- Defined in packages/renderer-core/typings/mesh.d.ts:57

`Protected` onDraggable

onDraggable(): boolean
标记当前对象是否可拖拽

Returns boolean
Inherited from BaseMesh.onDraggable
- Defined in packages/renderer-core/typings/mesh.d.ts:49

`Protected` onHoverIn

onHoverIn(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onHoverIn
- Defined in packages/renderer-core/typings/mesh.d.ts:68

`Protected` onHoverOut

onHoverOut(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onHoverOut
- Defined in packages/renderer-core/typings/mesh.d.ts:69

`Protected` onHoverable

onHoverable(): boolean
标记当前对象是否可 Hover

Returns boolean
Inherited from BaseMesh.onHoverable
- Defined in packages/renderer-core/typings/mesh.d.ts:45

`Protected` onPinch

onPinch(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onPinch
- Defined in packages/renderer-core/typings/mesh.d.ts:61

`Protected` onPinchEnd

onPinchEnd(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onPinchEnd
- Defined in packages/renderer-core/typings/mesh.d.ts:62

`Protected` onPinchStart

onPinchStart(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onPinchStart
- Defined in packages/renderer-core/typings/mesh.d.ts:60

`Protected` onPinchable

onPinchable(): boolean
Returns boolean
Inherited from BaseMesh.onPinchable
- Defined in packages/renderer-core/typings/mesh.d.ts:50

`Protected` onPress

onPress(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onPress
- Defined in packages/renderer-core/typings/mesh.d.ts:66

`Protected` onPressUp

onPressUp(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onPressUp
- Defined in packages/renderer-core/typings/mesh.d.ts:67

`Protected` onPressable

onPressable(): boolean
Returns boolean
Inherited from BaseMesh.onPressable
- Defined in packages/renderer-core/typings/mesh.d.ts:52

`Protected` onRightClick

onRightClick(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onRightClick
- Defined in packages/renderer-core/typings/mesh.d.ts:56

`Protected` onRotatable

onRotatable(): boolean
Returns boolean
Inherited from BaseMesh.onRotatable
- Defined in packages/renderer-core/typings/mesh.d.ts:51

`Protected` onRotate

onRotate(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onRotate
- Defined in packages/renderer-core/typings/mesh.d.ts:64

`Protected` onRotateEnd

onRotateEnd(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onRotateEnd
- Defined in packages/renderer-core/typings/mesh.d.ts:65

`Protected` onRotateStart

onRotateStart(viewEntity, event, tools): void
Parameters
- viewEntity: Partial<ViewEntity>
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from BaseMesh.onRotateStart
- Defined in packages/renderer-core/typings/mesh.d.ts:63

removeFromWorld

removeFromWorld(): void
从世界中移除当前对象

Returns void
Overrides BaseMesh.removeFromWorld
- Defined in packages/renderer-pixi/src/Mesh2D/Mesh2D.ts:29

render

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

`Protected` resetCursor

resetCursor(): void
恢复默认 cursor 状态

Returns void
Inherited from BaseMesh.resetCursor
- Defined in packages/renderer-core/typings/mesh.d.ts:37

setViewInteractive

setViewInteractive(interactive): void
设置视图是否可交互
Parameters
- interactive: boolean
Returns void
Overrides BaseMesh.setViewInteractive
- Defined in packages/renderer-pixi/src/Mesh2D/Mesh2D.ts:43

shouldComponentUpdate

shouldComponentUpdate(nextProps): boolean
Parameters
- nextProps: Readonly<ComponentProps<Props>>
Returns boolean
Inherited from BaseMesh.shouldComponentUpdate
- Defined in packages/renderer-core/typings/component.d.ts:50

`Protected` updateCursor

updateCursor(cursor): void
设置当前 cursor 状态
Parameters
- cursor: string
Returns void
Inherited from BaseMesh.updateCursor
- Defined in packages/renderer-core/typings/mesh.d.ts:33

Generated using TypeDoc