IPluginTool | Pointerra 3D Viewer JavaScript API

Interface that defines the API required for adding a custom plugin tool

Hierarchy

IPluginTool

Properties

Optional acceptMoveOverWhenDisabled

acceptMoveOverWhenDisabled: () => boolean

Type declaration

- (): boolean
- Returns boolean

canHidePanel

canHidePanel: boolean

Optional getHelpText

getHelpText: () => string

Type declaration

- (): string
- Returns string

Optional handleContextMenuRequested

handleContextMenuRequested: (clientPosition: { x: number; y: number }, worldPosition: ICartesianPoint, entityId: string | Entity) => boolean

Type declaration

- (clientPosition: { x: number; y: number }, worldPosition: ICartesianPoint, entityId: string | Entity): boolean
- Parameters
  - clientPosition: { x: number; y: number }
    - x: number
    - y: number
  - worldPosition: ICartesianPoint
  - entityId: string | Entity
  Returns boolean

Optional handleDrag

handleDrag: (movement: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, entityId: string) => boolean

Type declaration

- (movement: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, entityId: string): boolean
- Parameters
  - movement: any
  - modifier: KeyboardModifier
  - pointPosition: ICartesianPoint
  - entityId: string
  Returns boolean

Optional handleMouseClick

handleMouseClick: (event: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, entityId: string | Entity, left: boolean, middle: boolean, right: boolean) => boolean

Type declaration

- (event: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, entityId: string | Entity, left: boolean, middle: boolean, right: boolean): boolean
- Parameters
  - event: any
  - modifier: KeyboardModifier
  - pointPosition: ICartesianPoint
  - entityId: string | Entity
  - left: boolean
  - middle: boolean
  - right: boolean
  Returns boolean

Optional handleMouseDoubleClick

handleMouseDoubleClick: (event: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, left: boolean, right: boolean) => boolean

Type declaration

- (event: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, left: boolean, right: boolean): boolean
- Parameters
  - event: any
  - modifier: KeyboardModifier
  - pointPosition: ICartesianPoint
  - left: boolean
  - right: boolean
  Returns boolean

Optional handleMouseDown

handleMouseDown: (movement: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, entityId: string | Entity, left: boolean, middle: boolean, right: boolean) => boolean

Type declaration

- (movement: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, entityId: string | Entity, left: boolean, middle: boolean, right: boolean): boolean
- Parameters
  - movement: any
  - modifier: KeyboardModifier
  - pointPosition: ICartesianPoint
  - entityId: string | Entity
  - left: boolean
  - middle: boolean
  - right: boolean
  Returns boolean

Optional handleMouseMove

handleMouseMove: (movement: any, modifier: KeyboardModifier, pickedCoordinate: IMousePickInfo) => boolean

Type declaration

- (movement: any, modifier: KeyboardModifier, pickedCoordinate: IMousePickInfo): boolean
- Parameters
  - movement: any
  - modifier: KeyboardModifier
  - pickedCoordinate: IMousePickInfo
  Returns boolean

Optional handleMouseOver

handleMouseOver: (entityId: string) => boolean

Type declaration

- (entityId: string): boolean
- Parameters
  - entityId: string
  Returns boolean

Optional handleMouseUp

handleMouseUp: (movement: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, left: boolean, middle: boolean, right: boolean) => boolean

Type declaration

- (movement: any, modifier: KeyboardModifier, pointPosition: ICartesianPoint, left: boolean, middle: boolean, right: boolean): boolean
- Parameters
  - movement: any
  - modifier: KeyboardModifier
  - pointPosition: ICartesianPoint
  - left: boolean
  - middle: boolean
  - right: boolean
  Returns boolean

Optional handleMouseWheel

handleMouseWheel: (event: any, modifier?: KeyboardModifier) => boolean

Type declaration

- (event: any, modifier?: KeyboardModifier): boolean
- Parameters
  - event: any
  - Optional modifier: KeyboardModifier
  Returns boolean

Optional handlePinchEnd

handlePinchEnd: (event: any) => boolean

Type declaration

- (event: any): boolean
- Parameters
  - event: any
  Returns boolean

Optional handlePinchMove

handlePinchMove: (event: any, pointPosition: ICartesianPoint, prevPositions: any, positions: any) => boolean

Type declaration

- (event: any, pointPosition: ICartesianPoint, prevPositions: any, positions: any): boolean
- Parameters
  - event: any
  - pointPosition: ICartesianPoint
  - prevPositions: any
  - positions: any
  Returns boolean

Optional handlePinchStart

handlePinchStart: (event: any, pointPosition1: ICartesianPoint, pointPosition2: ICartesianPoint) => boolean

Type declaration

- (event: any, pointPosition1: ICartesianPoint, pointPosition2: ICartesianPoint): boolean
- Parameters
  - event: any
  - pointPosition1: ICartesianPoint
  - pointPosition2: ICartesianPoint
  Returns boolean

Optional handlePointCloudLoaded

handlePointCloudLoaded: () => boolean

Type declaration

- (): boolean
- Returns boolean

mountedTool

mountedTool: AbstractTool | null

Optional onActivated

onActivated: () => void

Type declaration

- (): void
- Returns void

Optional onCleanup

onCleanup: () => void

Type declaration

- (): void
- Returns void

Optional onDeactivated

onDeactivated: () => void

Type declaration

- (): void
- Returns void

Optional panelComponent

panelComponent: () => any

Type declaration

- (): any
- Returns any

Optional processKeyDown

processKeyDown: (event: any) => boolean

Type declaration

- (event: any): boolean
- Parameters
  - event: any
  Returns boolean

Optional processKeyUp

processKeyUp: (event: any) => boolean

Type declaration

- (event: any): boolean
- Parameters
  - event: any
  Returns boolean

Hierarchy

Index

Properties

Properties

Optional acceptMoveOverWhenDisabled

Type declaration

Returns boolean

canHidePanel

Optional getHelpText

Type declaration

Returns string

Optional handleContextMenuRequested

Type declaration

Parameters

clientPosition: { x: number; y: number }

x: number

y: number

worldPosition: ICartesianPoint

entityId: string | Entity

Returns boolean

Optional handleDrag

Type declaration

Parameters

movement: any

modifier: KeyboardModifier

pointPosition: ICartesianPoint

entityId: string

Returns boolean

Optional handleMouseClick

Type declaration

Parameters

event: any

modifier: KeyboardModifier

pointPosition: ICartesianPoint

entityId: string | Entity

left: boolean

middle: boolean

right: boolean

Returns boolean

Optional handleMouseDoubleClick

Type declaration

Parameters

event: any

modifier: KeyboardModifier

pointPosition: ICartesianPoint

left: boolean

right: boolean

Returns boolean

Optional handleMouseDown

Type declaration

Parameters

movement: any

modifier: KeyboardModifier

pointPosition: ICartesianPoint

entityId: string | Entity

left: boolean

middle: boolean

right: boolean

Returns boolean

Optional handleMouseMove

Type declaration

Parameters

movement: any

modifier: KeyboardModifier

pickedCoordinate: IMousePickInfo

Returns boolean

Optional handleMouseOver

Type declaration

Parameters

entityId: string

Returns boolean

Optional handleMouseUp

Type declaration

Parameters

movement: any

modifier: KeyboardModifier

pointPosition: ICartesianPoint

left: boolean

middle: boolean

right: boolean