Class PinWidget3D

Hierarchy (View Summary)

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:101

Accessors

isAnimating

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

dispatchMovedEvent

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

position3D

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

userObject

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

label

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

draggingAllowed

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

highlighted

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

labelWidget

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

parent

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

visible

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

clippable

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

x

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

y

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

width

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

height

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

fillParent

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

fillStyle

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

strokeStyle

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

absoluteX

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

absoluteY

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

onMouseMove

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

onMouseWheel

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

onMouseButton

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

onMouseEnter

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

onMouseLeave

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

onKeyDown

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

onKeyUp

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

Methods

loadByColor

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

loadByImage

loadByImage(imageURL?: string, width?: number, height?: number): void
Parameters
- OptionalimageURL: string
- Optionalwidth: number
- Optionalheight: number
Returns void
- Defined in ovl/pin-widget.ts:120

setPinBasedOrientation

setPinBasedOrientation(on: boolean): void
Parameters
- on: boolean
Returns void
- Defined in ovl/pin-widget.ts:251

getPinBasedOrientation

getPinBasedOrientation(): boolean
Returns boolean
- Defined in ovl/pin-widget.ts:255

paint

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

getData

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

setData

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

destroy

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

remove

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

contains

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

update

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

repaint

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

mouseMove

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

mouseWheel

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

mouseButton

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

keyboard

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

hasMouseEntered

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

hasMouseLeave

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