Class Gizmo3d

graphic render component

Hierarchy

Mesh3D
- Gizmo3d

Constructors

constructor

new Gizmo3d(props?): Gizmo3d
Parameters
- Optional props: ComponentProps<{}>
Returns Gizmo3d
Inherited from Mesh3D.constructor
- Defined in packages/renderer-three/typings/Mesh3D/Mesh3D.d.ts:6

Properties

_vNode

_vNode: VirtualNode<any>

`Protected` autoAppendToWorld

autoAppendToWorld: boolean

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

props

props: ComponentProps<{}>

Type declaration

`Protected` reactivePipeLine

reactivePipeLine: (() => void)[]

响应式的渲染任务管线

Type declaration

- (): void
- Returns void

`Protected` view

view: Object3D

当前组件的视图对象

`Protected` viewType

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

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

Accessors

context

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

`Protected` interactiveConfig

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

Methods

addChildView

addChildView(view): void
提供接口用以给子组件添加 view
Parameters
- view: Object3D
Returns void
Inherited from Mesh3D.addChildView
- Defined in packages/renderer-three/typings/Mesh3D/Mesh3D.d.ts:8

addViewToScene

addViewToScene(scene3d, view): void
往场景中添加对象
Parameters
- scene3d: Scene3D
- view: Object3D
Returns void
Inherited from Mesh3D.addViewToScene
- Defined in packages/renderer-three/typings/Mesh3D/Mesh3D.d.ts:12

clearView

clearView(): void
清除当前视图

Returns void
Inherited from Mesh3D.clearView
- Defined in packages/renderer-three/typings/Mesh3D/Mesh3D.d.ts:9

commit

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

componentDidMount

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

componentDidUpdate

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

componentWillMount

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

componentWillUnmount

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

componentWillUpdate

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

createDefaultView

createDefaultView(): Group
Returns Group
Inherited from Mesh3D.createDefaultView
- Defined in packages/renderer-three/typings/Mesh3D/Mesh3D.d.ts:7

`Protected` draw

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

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

forceUpdate

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

`Protected` getViewEntity

getViewEntity(): Partial<ViewEntity>
Returns Partial<ViewEntity>
Inherited from Mesh3D.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 Mesh3D.onClick
- Defined in packages/renderer-core/typings/mesh.d.ts:54

`Protected` onClickable

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

Returns boolean
Inherited from Mesh3D.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 Mesh3D.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 Mesh3D.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 Mesh3D.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 Mesh3D.onDragStart
- Defined in packages/renderer-core/typings/mesh.d.ts:57

`Protected` onDraggable

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

Returns boolean
Inherited from Mesh3D.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 Mesh3D.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 Mesh3D.onHoverOut
- Defined in packages/renderer-core/typings/mesh.d.ts:69

`Protected` onHoverable

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

Returns boolean
Inherited from Mesh3D.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 Mesh3D.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 Mesh3D.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 Mesh3D.onPinchStart
- Defined in packages/renderer-core/typings/mesh.d.ts:60

`Protected` onPinchable

onPinchable(): boolean
Returns boolean
Inherited from Mesh3D.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 Mesh3D.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 Mesh3D.onPressUp
- Defined in packages/renderer-core/typings/mesh.d.ts:67

`Protected` onPressable

onPressable(): boolean
Returns boolean
Inherited from Mesh3D.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 Mesh3D.onRightClick
- Defined in packages/renderer-core/typings/mesh.d.ts:56

`Protected` onRotatable

onRotatable(): boolean
Returns boolean
Inherited from Mesh3D.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 Mesh3D.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 Mesh3D.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 Mesh3D.onRotateStart
- Defined in packages/renderer-core/typings/mesh.d.ts:63

removeFromWorld

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

Returns void
Inherited from Mesh3D.removeFromWorld
- Defined in packages/renderer-three/typings/Mesh3D/Mesh3D.d.ts:10

render

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

`Protected` resetCursor

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

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

setViewInteractive

setViewInteractive(interactive): void
设置视图是否可交互
Parameters
- interactive: boolean
Returns void
Inherited from Mesh3D.setViewInteractive
- Defined in packages/renderer-three/typings/Mesh3D/Mesh3D.d.ts:11

shouldComponentUpdate

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

`Protected` updateCursor

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

updateGeometry

updateGeometry(): void
Returns void
- Defined in packages/graphic-component-three/typings/gizmo3d/index.d.ts:4

updateMaterial

updateMaterial(): void
Returns void
- Defined in packages/graphic-component-three/typings/gizmo3d/index.d.ts:5

updatePosition

updatePosition(): void
Returns void
- Defined in packages/graphic-component-three/typings/gizmo3d/index.d.ts:6

updateRotation

updateRotation(): void
Returns void
- Defined in packages/graphic-component-three/typings/gizmo3d/index.d.ts:7

updateScale

updateScale(): void
Returns void
- Defined in packages/graphic-component-three/typings/gizmo3d/index.d.ts:8

Generated using TypeDoc