Class PinWidget3D

Hierarchy

Widget
- PinWidget3D

Constructors

constructor

new PinWidget3D(owner: BaseBimCanvas, vector3d: Vector3D): PinWidget3D
Parameters
- owner: BaseBimCanvas
- vector3d: Vector3D
Returns PinWidget3D
Overrides Widget.constructor
- Defined in ovl/pin-widget.ts:100

Accessors

absoluteX

get absoluteX(): number
Returns number
Inherited from Widget.absoluteX
- Defined in ovl/widget.ts:164

absoluteY

get absoluteY(): number
Returns number
Inherited from Widget.absoluteY
- Defined in ovl/widget.ts:174

clippable

get clippable(): boolean
Returns boolean
Inherited from Widget.clippable
- Defined in ovl/widget.ts:73
set clippable(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Widget.clippable
- Defined in ovl/widget.ts:77

dispatchMovedEvent

get dispatchMovedEvent(): boolean
Returns boolean
- Defined in ovl/pin-widget.ts:198
set dispatchMovedEvent(d: boolean): void
Parameters
- d: boolean
Returns void
- Defined in ovl/pin-widget.ts:202

draggingAllowed

get draggingAllowed(): boolean
Returns boolean
- Defined in ovl/pin-widget.ts:238
set draggingAllowed(draggingAllowed: boolean): void
Parameters
- draggingAllowed: boolean
Returns void
- Defined in ovl/pin-widget.ts:242

fillParent

get fillParent(): boolean
Returns boolean
Inherited from Widget.fillParent
- Defined in ovl/widget.ts:133
set fillParent(fillParent: boolean): void
Parameters
- fillParent: boolean
Returns void
Inherited from Widget.fillParent
- Defined in ovl/widget.ts:137

fillStyle

get fillStyle(): string | CanvasGradient | CanvasPattern
Returns string | CanvasGradient | CanvasPattern
Inherited from Widget.fillStyle
- Defined in ovl/widget.ts:142
set fillStyle(fillStyle: string | CanvasGradient | CanvasPattern): void
Parameters
- fillStyle: string | CanvasGradient | CanvasPattern
Returns void
Inherited from Widget.fillStyle
- Defined in ovl/widget.ts:146

height

get height(): number
Returns number
Inherited from Widget.height
- Defined in ovl/widget.ts:120
set height(height: number): void
Parameters
- height: number
Returns void
Inherited from Widget.height
- Defined in ovl/widget.ts:127

highlighted

set highlighted(highlighted: boolean): void
Parameters
- highlighted: boolean
Returns void
- Defined in ovl/pin-widget.ts:246

isAnimating

get isAnimating(): boolean
Returns boolean
- Defined in ovl/pin-widget.ts:154

label

get label(): string
Returns string
- Defined in ovl/pin-widget.ts:230
set label(label: string): void
Parameters
- label: string
Returns void
- Defined in ovl/pin-widget.ts:234

labelWidget

get labelWidget(): LabelWidget
Returns LabelWidget
- Defined in ovl/pin-widget.ts:307

onKeyDown

set onKeyDown(handler: ((event: KeyButtonBimEvent) => boolean)): void
Parameters
- handler: ((event: KeyButtonBimEvent) => boolean)
  - - (event: KeyButtonBimEvent): boolean
    - Parameters
      
      event: KeyButtonBimEvent
      
      Returns boolean
Returns void
Inherited from Widget.onKeyDown
- Defined in ovl/widget.ts:322

onKeyUp

set onKeyUp(handler: ((event: KeyButtonBimEvent) => boolean)): void
Parameters
- handler: ((event: KeyButtonBimEvent) => boolean)
  - - (event: KeyButtonBimEvent): boolean
    - Parameters
      
      event: KeyButtonBimEvent
      
      Returns boolean
Returns void
Inherited from Widget.onKeyUp
- Defined in ovl/widget.ts:326

onMouseButton

set onMouseButton(handler: ((event: MouseButtonBimEvent) => boolean)): void
Parameters
- handler: ((event: MouseButtonBimEvent) => boolean)
  - - (event: MouseButtonBimEvent): boolean
    - Parameters
      
      event: MouseButtonBimEvent
      
      Returns boolean
Returns void
Inherited from Widget.onMouseButton
- Defined in ovl/widget.ts:310

onMouseEnter

set onMouseEnter(handler: ((event: MouseMoveBimEvent) => boolean)): void
Parameters
- handler: ((event: MouseMoveBimEvent) => boolean)
  - - (event: MouseMoveBimEvent): boolean
    - Parameters
      
      event: MouseMoveBimEvent
      
      Returns boolean
Returns void
Inherited from Widget.onMouseEnter
- Defined in ovl/widget.ts:314

onMouseLeave

set onMouseLeave(handler: ((event: MouseMoveBimEvent) => boolean)): void
Parameters
- handler: ((event: MouseMoveBimEvent) => boolean)
  - - (event: MouseMoveBimEvent): boolean
    - Parameters
      
      event: MouseMoveBimEvent
      
      Returns boolean
Returns void
Inherited from Widget.onMouseLeave
- Defined in ovl/widget.ts:318

onMouseMove

set onMouseMove(handler: ((event: MouseMoveBimEvent) => boolean)): void
Parameters
- handler: ((event: MouseMoveBimEvent) => boolean)
  - - (event: MouseMoveBimEvent): boolean
    - Parameters
      
      event: MouseMoveBimEvent
      
      Returns boolean
Returns void
Inherited from Widget.onMouseMove
- Defined in ovl/widget.ts:302

onMouseWheel

set onMouseWheel(handler: ((event: MouseWheelBimEvent) => boolean)): void
Parameters
- handler: ((event: MouseWheelBimEvent) => boolean)
  - - (event: MouseWheelBimEvent): boolean
    - Parameters
      
      event: MouseWheelBimEvent
      
      Returns boolean
Returns void
Inherited from Widget.onMouseWheel
- Defined in ovl/widget.ts:306

parent

get parent(): ContainerWidget
Returns ContainerWidget
Inherited from Widget.parent
- Defined in ovl/widget.ts:42
set parent(parent: ContainerWidget): void
Parameters
- parent: ContainerWidget
Returns void
Inherited from Widget.parent
- Defined in ovl/widget.ts:46

position3D

get position3D(): Vector3D
Returns Vector3D
- Defined in ovl/pin-widget.ts:218
set position3D(vector3d: Vector3D): void
Parameters
- vector3d: Vector3D
Returns void
- Defined in ovl/pin-widget.ts:206

strokeStyle

get strokeStyle(): string | CanvasGradient | CanvasPattern
Returns string | CanvasGradient | CanvasPattern
Inherited from Widget.strokeStyle
- Defined in ovl/widget.ts:153
set strokeStyle(strokeStyle: string | CanvasGradient | CanvasPattern): void
Parameters
- strokeStyle: string | CanvasGradient | CanvasPattern
Returns void
Inherited from Widget.strokeStyle
- Defined in ovl/widget.ts:157

userObject

get userObject(): unknown
Returns unknown
- Defined in ovl/pin-widget.ts:226
set userObject(userObject: unknown): void
Parameters
- userObject: unknown
Returns void
- Defined in ovl/pin-widget.ts:222

visible

get visible(): boolean
Returns boolean
Inherited from Widget.visible
- Defined in ovl/widget.ts:64
set visible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from Widget.visible
- Defined in ovl/widget.ts:68

width

get width(): number
Returns number
Inherited from Widget.width
- Defined in ovl/widget.ts:107
set width(width: number): void
Parameters
- width: number
Returns void
Inherited from Widget.width
- Defined in ovl/widget.ts:114

x

get x(): number
Returns number
Inherited from Widget.x
- Defined in ovl/widget.ts:81
set x(x: number): void
Parameters
- x: number
Returns void
Inherited from Widget.x
- Defined in ovl/widget.ts:88

y

get y(): number
Returns number
Inherited from Widget.y
- Defined in ovl/widget.ts:94
set y(y: number): void
Parameters
- y: number
Returns void
Inherited from Widget.y
- Defined in ovl/widget.ts:101

Methods

contains

contains(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from Widget.contains
- Defined in ovl/widget.ts:29

destroy

destroy(): void
Returns void
Overrides Widget.destroy
- Defined in ovl/pin-widget.ts:377

getData

getData(): PinData
Returns PinData
- Defined in ovl/pin-widget.ts:354

hasMouseEntered

hasMouseEntered(): boolean
Returns boolean
Inherited from Widget.hasMouseEntered
- Defined in ovl/widget.ts:288

hasMouseLeave

hasMouseLeave(): boolean
Returns boolean
Inherited from Widget.hasMouseLeave
- Defined in ovl/widget.ts:295

keyboard

keyboard(event: KeyButtonBimEvent): boolean
Parameters
- event: KeyButtonBimEvent
Returns boolean
Inherited from Widget.keyboard
- Defined in ovl/widget.ts:278

loadByColor

loadByColor(color?: string): void
Parameters
- Optional color: string
Returns void
- Defined in ovl/pin-widget.ts:104

loadByImage

loadByImage(imageURL?: string, width?: number, height?: number): void
Parameters
- Optional imageURL: string
- Optional width: number
- Optional height: number
Returns void
- Defined in ovl/pin-widget.ts:119

mouseButton

mouseButton(event: MouseButtonBimEvent): boolean
Parameters
- event: MouseButtonBimEvent
Returns boolean
Inherited from Widget.mouseButton
- Defined in ovl/widget.ts:269

mouseMove

mouseMove(event: MouseMoveBimEvent): boolean
Parameters
- event: MouseMoveBimEvent
Returns boolean
Inherited from Widget.mouseMove
- Defined in ovl/widget.ts:237

mouseWheel

mouseWheel(event: MouseWheelBimEvent): boolean
Parameters
- event: MouseWheelBimEvent
Returns boolean
Inherited from Widget.mouseWheel
- Defined in ovl/widget.ts:260

paint

paint(context: CanvasRenderingContext2D): void
Parameters
- context: CanvasRenderingContext2D
Returns void
Overrides Widget.paint
- Defined in ovl/pin-widget.ts:318

remove

remove(): void
Returns void
- Defined in ovl/pin-widget.ts:385

repaint

repaint(context: CanvasRenderingContext2D): void
Parameters
- context: CanvasRenderingContext2D
Returns void
Inherited from Widget.repaint
- Defined in ovl/widget.ts:190

setData

setData(data: PinData): void
Parameters
- data: PinData
Returns void
- Defined in ovl/pin-widget.ts:359

update

update(): void
Returns void
Inherited from Widget.update
- Defined in ovl/widget.ts:184