Interface InteractiveObject3D

Hierarchy

Interactive
InstancedMeshInstance
Object3D
- InteractiveObject3D

Properties

$$instanceOf

$$instanceOf: InstancedMesh<BufferGeometry, Material | Material[]>

_headStateHasChanged

_headStateHasChanged: boolean

a signal indicating whether the head state has changed.

_immediatelyRenderOnce

_immediatelyRenderOnce: boolean

render the state syncronize

_uiStateChangeLogs

_uiStateChangeLogs: any[]

logs to record the state before calling onXX. It's data onXX returns.

color

color: number

id

id: number

instanceIndex

instanceIndex: number

isHighlighted

isHighlighted: boolean

isHovered

isHovered: boolean

isInstancedMesh

isInstancedMesh: boolean

isInstancedMeshInstance

isInstancedMeshInstance: boolean

isInteractable

isInteractable: true

isSelected

isSelected: boolean

model

model: PlainObject

`Readonly` popup

popup: boolean

`Readonly` position

position: Vector3

`Readonly` rotation

rotation: Euler

`Readonly` tooltip

tooltip: boolean

Methods

delete

delete(): void
delete from the mesh

Returns void
Inherited from InstancedMeshInstance.delete
- Defined in src/3d/basic/interface.ts:14

display

display(): void
Returns void
Inherited from InstancedMeshInstance.display
- Defined in src/3d/basic/interface.ts:16

getColor

getColor(): number
Returns number
Inherited from InstancedMeshInstance.getColor
- Defined in src/3d/basic/interface.ts:20

hide

hide(): void
Returns void
Inherited from InstancedMeshInstance.hide
- Defined in src/3d/basic/interface.ts:15

iInit

iInit(): void
Returns void
Inherited from InstancedMeshInstance.iInit
- Defined in src/3d/basic/interface.ts:17

`Optional` onClick

onClick(e?: unknown): void
Parameters
- Optional e: unknown
Returns void
Inherited from Interactive.onClick
- Defined in src/interfaces/Interactive.ts:63

`Optional` onContextMenu

onContextMenu(evt?: unknown): ContextMenuItem[]
Parameters
- Optional evt: unknown
Returns ContextMenuItem[]
Inherited from Interactive.onContextMenu
- Defined in src/interfaces/Interactive.ts:77

`Optional` onContextMenuClick

onContextMenuClick(key: string): void | Promise<any>
Parameters
- key: string
Returns void | Promise<any>
Inherited from Interactive.onContextMenuClick
- Defined in src/interfaces/Interactive.ts:78

`Optional` onDblClick

onDblClick(e?: unknown): void
Parameters
- Optional e: unknown
Returns void
Inherited from Interactive.onDblClick
- Defined in src/interfaces/Interactive.ts:67

`Optional` onDragEnd

onDragEnd(coord?: unknown): void
Parameters
- Optional coord: unknown
Returns void
Inherited from Interactive.onDragEnd
- Defined in src/interfaces/Interactive.ts:71

`Optional` onDragStart

onDragStart(): void
Returns void
Inherited from Interactive.onDragStart
- Defined in src/interfaces/Interactive.ts:72

`Optional` onDragging

onDragging(coord?: unknown): void
Parameters
- Optional coord: unknown
Returns void
Inherited from Interactive.onDragging
- Defined in src/interfaces/Interactive.ts:73

`Optional` onHighlight

onHighlight(data?: any): any
Parameters
- Optional data: any
  
  the event maybe
Returns any
Inherited from Interactive.onHighlight
- Defined in src/interfaces/Interactive.ts:53

`Optional` onHover

onHover(data?: any): any
Parameters
- Optional data: any
  
  the event maybe
Returns any
Inherited from Interactive.onHover
- Defined in src/interfaces/Interactive.ts:8

`Optional` onSelect

onSelect(data?: any): any
Parameters
- Optional data: any
  
  the event maybe
Returns any
Inherited from Interactive.onSelect
- Defined in src/interfaces/Interactive.ts:30

`Optional` onUnHighlight

onUnHighlight(state?: any, data?: any): void
Parameters
- Optional state: any
  
  the state onHightlight returns
- Optional data: any
  
  the even maybe
Returns void
Inherited from Interactive.onUnHighlight
- Defined in src/interfaces/Interactive.ts:59

`Optional` onUnHover

onUnHover(state?: any, data?: any): void
Parameters
- Optional state: any
  
  the state onHover returns
- Optional data: any
  
  the event maybe
Returns void
Inherited from Interactive.onUnHover
- Defined in src/interfaces/Interactive.ts:14

`Optional` onUnSelect

onUnSelect(state?: any, data?: any): void
Parameters
- Optional state: any
  
  the state onSelect returns
- Optional data: any
  
  the event maybe
Returns void
Inherited from Interactive.onUnSelect
- Defined in src/interfaces/Interactive.ts:37

reRender

reRender(): void
run the render function again, it's a sync call, no post render call.

Returns void
Inherited from Interactive.reRender
- Defined in src/interfaces/Interactive.ts:99

requestUpdate

requestUpdate(flag: 0 | 1 | 2 | 3): void
Parameters
- flag: 0 | 1 | 2 | 3
Returns void
Inherited from InstancedMeshInstance.requestUpdate
- Defined in src/3d/basic/interface.ts:18

setColor

setColor(color: number): void
Parameters
- color: number
Returns void
Inherited from InstancedMeshInstance.setColor
- Defined in src/3d/basic/interface.ts:19

setPosition

setPosition(pos: Partial<Position>): void
Parameters
- pos: Partial<Position>
Returns void
Inherited from InstancedMeshInstance.setPosition
- Defined in src/3d/basic/interface.ts:23

setRotation

setRotation(rotation: Partial<Position>, order?: string): void
Parameters
- rotation: Partial<Position>
- Optional order: string
Returns void
Inherited from InstancedMeshInstance.setRotation
- Defined in src/3d/basic/interface.ts:24

toGhostStyle

toGhostStyle(): void
Returns void
Inherited from InstancedMeshInstance.toGhostStyle
- Defined in src/3d/basic/interface.ts:22

toIndividual

toIndividual(): Object3D<Event>
Returns Object3D<Event>
Inherited from InstancedMeshInstance.toIndividual
- Defined in src/3d/basic/interface.ts:21

Interface InteractiveObject3D

Hierarchy

Index

Properties

Methods

Properties

$$instanceOf

_headStateHasChanged

_immediatelyRenderOnce

_uiStateChangeLogs

color

id

instanceIndex

isHighlighted

isHovered

isInstancedMesh

isInstancedMeshInstance

isInteractable

isSelected

model

Readonly popup

Readonly position

Readonly rotation

Readonly tooltip

Methods

delete

Returns void

display

Returns void

getColor

Returns number

hide

Returns void

iInit

Returns void

Optional onClick

Parameters

Optional e: unknown

Returns void

Optional onContextMenu

Parameters

Optional evt: unknown

Returns ContextMenuItem[]

Optional onContextMenuClick

Parameters

key: string

Returns void | Promise<any>

Optional onDblClick

Parameters

Optional e: unknown

Returns void

Optional onDragEnd

Parameters

Optional coord: unknown

Returns void

Optional onDragStart

Returns void

Optional onDragging

Parameters

Optional coord: unknown

Returns void

Optional onHighlight

Parameters

Optional data: any

Returns any

Optional onHover

Parameters

Optional data: any

Returns any

Optional onSelect

Parameters

Optional data: any

Returns any

Optional onUnHighlight

Parameters

Optional state: any

Optional data: any

Returns void

Optional onUnHover

Parameters

`Readonly` popup

`Readonly` position

`Readonly` rotation

`Readonly` tooltip

`Optional` onClick

`Optional` e: unknown

`Optional` onContextMenu

`Optional` evt: unknown

`Optional` onContextMenuClick

`Optional` onDblClick

`Optional` e: unknown

`Optional` onDragEnd

`Optional` coord: unknown

`Optional` onDragStart

`Optional` onDragging

`Optional` coord: unknown

`Optional` onHighlight

`Optional` data: any

`Optional` onHover

`Optional` data: any

`Optional` onSelect

`Optional` data: any

`Optional` onUnHighlight

`Optional` state: any

`Optional` data: any

`Optional` onUnHover

`Optional` state: any

`Optional` data: any

`Optional` onUnSelect

`Optional` state: any

`Optional` data: any

`Optional` order: string