Class BimCTCanvas

Abstract base class for BIM canvas, providing core functionalities and event handling.

Hierarchy

BaseBimCanvas
- BimCTCanvas

Constructors

constructor

new BimCTCanvas(divElement: HTMLDivElement, options?: BaseBimCanvasOptions): BimCTCanvas
Constructor for BimCTCanvas.
Parameters
- divElement: HTMLDivElement
  
  The HTMLDivElement to attach the canvas to.
- Optional options: BaseBimCanvasOptions
  
  Optional configuration options.
Returns BimCTCanvas
Overrides BaseBimCanvas.constructor
- Defined in canvas/local.ts:23

Accessors

canvasElement

get canvasElement(): HTMLCanvasElement
Gets the canvas element.

Returns HTMLCanvasElement
Inherited from BaseBimCanvas.canvasElement
- Defined in canvas/base.ts:470

canvasHeight

get canvasHeight(): number
Gets the height of the canvas element.

Returns number
Inherited from BaseBimCanvas.canvasHeight
- Defined in canvas/base.ts:460

canvasWidth

get canvasWidth(): number
Gets the width of the canvas element.

Returns number
Inherited from BaseBimCanvas.canvasWidth
- Defined in canvas/base.ts:450

clipping

get clipping(): BimCTClippingRegions
Gets the clipping regions instance.

Returns BimCTClippingRegions
Inherited from BaseBimCanvas.clipping
- Defined in canvas/base.ts:511

containerElement

get containerElement(): HTMLDivElement
Gets the container div element (supplied in initialization time).

Returns HTMLDivElement
Inherited from BaseBimCanvas.containerElement
- Defined in canvas/base.ts:546

customCursor

set customCursor(cursorURL: string): void
Sets a custom cursor for the canvas.
Parameters
- cursorURL: string
  
  The URL of the custom cursor image.
Returns void
Inherited from BaseBimCanvas.customCursor
- Defined in canvas/base.ts:478

glContext

get glContext(): WebGL2RenderingContext
Gets the WebGL context.

Returns
The WebGL context.

Returns WebGL2RenderingContext
- Defined in canvas/local.ts:295

gpuInfo

get gpuInfo(): GPUInfo
Gets the GPU information.

Returns
The GPU information.

Returns GPUInfo
Overrides BaseBimCanvas.gpuInfo
- Defined in canvas/local.ts:66

markups

get markups(): Markups
Gets the markups instance.

Returns Markups
Inherited from BaseBimCanvas.markups
- Defined in canvas/base.ts:518

markupsElement

get markupsElement(): HTMLDivElement
Gets the markups div element.

Returns HTMLDivElement
Inherited from BaseBimCanvas.markupsElement
- Defined in canvas/base.ts:497

onCanvasRecreate

get onCanvasRecreate(): ISignal
Gets the canvas recreate event dispatcher.

Returns ISignal
Inherited from BaseBimCanvas.onCanvasRecreate
- Defined in canvas/base.ts:420

options

get options(): BaseBimCanvasOptions
Gets the options for the canvas.

Returns BaseBimCanvasOptions
Inherited from BaseBimCanvas.options
- Defined in canvas/base.ts:398

overlay

get overlay(): BimCTOverlay
Gets the overlay instance.

Returns BimCTOverlay
Inherited from BaseBimCanvas.overlay
- Defined in canvas/base.ts:504

pins

get pins(): Pins
Gets the pins instance.

Returns Pins
Inherited from BaseBimCanvas.pins
- Defined in canvas/base.ts:525

renderer

get renderer(): BaseRenderer
Gets the renderer.

Returns BaseRenderer
Inherited from BaseBimCanvas.renderer
- Defined in canvas/base.ts:405
set renderer(renderer: BaseRenderer): void
Sets the renderer.
Parameters
- renderer: BaseRenderer
  
  The renderer to set.
Returns void
Inherited from BaseBimCanvas.renderer
- Defined in canvas/base.ts:413

rendererElement

get rendererElement(): HTMLDivElement
Gets the viewer div element.

Returns HTMLDivElement
Inherited from BaseBimCanvas.rendererElement
- Defined in canvas/base.ts:539

viewerElement

get viewerElement(): HTMLDivElement
Gets the viewer div element.

Returns HTMLDivElement
Inherited from BaseBimCanvas.viewerElement
- Defined in canvas/base.ts:532

wrapperBounds

get wrapperBounds(): DOMRect
Gets the bounding rectangle of the wrapper element.

Returns DOMRect
Inherited from BaseBimCanvas.wrapperBounds
- Defined in canvas/base.ts:427

wrapperHeight

get wrapperHeight(): number
Gets the height of the wrapper element. WARN: Not accurate on zooming windows.

Returns number
Inherited from BaseBimCanvas.wrapperHeight
- Defined in canvas/base.ts:443

wrapperWidth

get wrapperWidth(): number
Gets the width of the wrapper element.

Returns number
Inherited from BaseBimCanvas.wrapperWidth
- Defined in canvas/base.ts:434

xrRefSpace

get xrRefSpace(): XRReferenceSpace | XRBoundedReferenceSpace
Gets the XR reference space.

Returns
The XR reference space.

Returns XRReferenceSpace | XRBoundedReferenceSpace
- Defined in canvas/local.ts:303

xrSession

get xrSession(): XRSession
Gets the XR session.

Returns
The XR session.

Returns XRSession
- Defined in canvas/local.ts:279

xrWebLayer

get xrWebLayer(): XRWebGLLayer
Gets the XR web layer.

Returns
The XR web layer.

Returns XRWebGLLayer
- Defined in canvas/local.ts:287

Methods

clearRendererImageFromCanvas

clearRendererImageFromCanvas(): void
Clears the renderer image from the canvas.

Returns void
Overrides BaseBimCanvas.clearRendererImageFromCanvas
- Defined in canvas/local.ts:345

createXR

createXR(mode: XRSessionMode, eventDispatcher?: EventDispatcher<BaseRenderer, XrSessionEventState>): Promise<boolean>
Creates an XR session.

Returns
A promise that resolves to a boolean indicating success.
Parameters
- mode: XRSessionMode
  
  The XR session mode.
- Optional eventDispatcher: EventDispatcher<BaseRenderer, XrSessionEventState>
  
  Optional event dispatcher.
Returns Promise<boolean>
- Defined in canvas/local.ts:145

cropSnapshot

cropSnapshot(x: number, y: number, width: number, height: number, drawOverlays?: boolean, transparentBackgroundColor?: RGB): Promise<string>
Crops a snapshot of the canvas at a specific location with given dimensions. If drawOverlays is true, it includes html overlays in the output.

Returns
A promise that resolves to a URI containing the cropped image.
Parameters
- x: number
  
  The x-coordinate of the top-left corner of the crop area.
- y: number
  
  The y-coordinate of the top-left corner of the crop area.
- width: number
  
  The width of the crop area.
- height: number
  
  The height of the crop area.
- drawOverlays: boolean = false
  
  Whether to include overlays in the snapshot.
- Optional transparentBackgroundColor: RGB
Returns Promise<string>
Inherited from BaseBimCanvas.cropSnapshot
- Defined in canvas/base.ts:814

destroy

destroy(): Promise<void>
Destroys the canvas and performs cleanup.

Returns Promise<void>
Inherited from BaseBimCanvas.destroy
- Defined in canvas/base.ts:553

destroyXR

destroyXR(endSession?: boolean): Promise<void>
Destroys the XR session.
Parameters
- endSession: boolean = true
  
  Whether to end the session.
Returns Promise<void>
- Defined in canvas/local.ts:266

getCursor

getCursor(): BaseBimCanvasCursor
Gets the current cursor type.

Returns BaseBimCanvasCursor
Inherited from BaseBimCanvas.getCursor
- Defined in canvas/base.ts:653

isNotificationVisible

isNotificationVisible(): boolean
Returns boolean
Inherited from BaseBimCanvas.isNotificationVisible
- Defined in canvas/base.ts:294

pushRendererImageToCanvas

pushRendererImageToCanvas(): Promise<void>
Pushes the renderer image to the canvas.

Returns
A promise that resolves when the operation is complete.

Returns Promise<void>
Overrides BaseBimCanvas.pushRendererImageToCanvas
- Defined in canvas/local.ts:337

recreateCanvas

recreateCanvas(): void
Recreates the canvas.

Returns void
Inherited from BaseBimCanvas.recreateCanvas
- Defined in canvas/base.ts:660

resize

resize(): Promise<void>
Resizes the canvas.

Returns Promise<void>
Inherited from BaseBimCanvas.resize
- Defined in canvas/base.ts:670

setCloseEventCallback

setCloseEventCallback(owner: any, closeEventCallback?: ((event: BimEvent) => void)): void
Sets the close event callback.
Parameters
- owner: any
  
  The owner of the callback.
- Optional closeEventCallback: ((event: BimEvent) => void)
  
  The callback function.
  - - (event: BimEvent): void
    - Parameters
      
      event: BimEvent
      
      Returns void
Returns void
Inherited from BaseBimCanvas.setCloseEventCallback
- Defined in canvas/base.ts:601

setCursor

setCursor(cursor: BaseBimCanvasCursor): void
Sets the cursor type for the canvas.
Parameters
- cursor: BaseBimCanvasCursor
  
  The cursor type to set.
Returns void
Inherited from BaseBimCanvas.setCursor
- Defined in canvas/base.ts:610

setExternalMouseMoveCallback

setExternalMouseMoveCallback(owner: any, externalMouseMoveCallback: ((event: MouseEvent) => Promise<void>)): void
Sets the external mouse move callback.
Parameters
- owner: any
  
  The owner of the callback.
- externalMouseMoveCallback: ((event: MouseEvent) => Promise<void>)
  
  The callback function.
  - - (event: MouseEvent): Promise<void>
    - Parameters
      
      event: MouseEvent
      
      Returns Promise<void>
Returns void
Inherited from BaseBimCanvas.setExternalMouseMoveCallback
- Defined in canvas/base.ts:571

setExternalMouseUpCallback

setExternalMouseUpCallback(owner: any, externalMouseUpCallback: ((event: MouseEvent) => void)): void
Sets the external mouse up callback.
Parameters
- owner: any
  
  The owner of the callback.
- externalMouseUpCallback: ((event: MouseEvent) => void)
  
  The callback function.
  - - (event: MouseEvent): void
    - Parameters
      
      event: MouseEvent
      
      Returns void
Returns void
Inherited from BaseBimCanvas.setExternalMouseUpCallback
- Defined in canvas/base.ts:581

setGameLegendVisible

setGameLegendVisible(visible: boolean): void
Sets the visibility of the game legend.
Parameters
- visible: boolean
  
  Whether the game legend should be visible.
Returns void
Inherited from BaseBimCanvas.setGameLegendVisible
- Defined in canvas/base.ts:1037

setNotificationText

setNotificationText(text: string): void
Parameters
- text: string
Returns void
Inherited from BaseBimCanvas.setNotificationText
- Defined in canvas/base.ts:298

setResizeEventCallBack

setResizeEventCallBack(owner: any, resizeEventCallback?: ((event: ResizeBimEvent) => void)): void
Sets the resize event callback.
Parameters
- owner: any
  
  The owner of the callback.
- Optional resizeEventCallback: ((event: ResizeBimEvent) => void)
  
  The callback function.
  - - (event: ResizeBimEvent): void
    - Parameters
      
      event: ResizeBimEvent
      
      Returns void
Returns void
Inherited from BaseBimCanvas.setResizeEventCallBack
- Defined in canvas/base.ts:591

setSplashScreenVisible

setSplashScreenVisible(visible: boolean, gifImagePath?: string): void
Sets the visibility of the splash screen.
Parameters
- visible: boolean
  
  Whether the splash screen should be visible.
- Optional gifImagePath: string
  
  The path to the GIF image for the splash screen.
Returns void
Inherited from BaseBimCanvas.setSplashScreenVisible
- Defined in canvas/base.ts:1021

showCloseButton

showCloseButton(show: boolean, closeButtonCallback?: (() => void), buttonTextI18n?: string): void
Controls the visibility of the close button and optionally sets a callback for the button's click event.
Parameters
- show: boolean
  
  A boolean indicating whether to show or hide the close button.
- Optional closeButtonCallback: (() => void)
  
  An optional callback function to be executed when the close button is clicked.
  - - (): void
    - Returns void
- Optional buttonTextI18n: string
  
  An optional text to be displayed on the close button.
Returns void
Inherited from BaseBimCanvas.showCloseButton
- Defined in canvas/base.ts:359

showNotification

showNotification(text: string, type: "error" | "info" | "question" | "warning", closeCallback?: ((result?: "yes" | "no") => void)): void
Parameters
- text: string
- type: "error" | "info" | "question" | "warning"
- Optional closeCallback: ((result?: "yes" | "no") => void)
  - - (result?: "yes" | "no"): void
    - Parameters
      
      Optional result: "yes" | "no"
      
      Returns void
Returns void
Inherited from BaseBimCanvas.showNotification
- Defined in canvas/base.ts:302

takeSnapshot

takeSnapshot(requestedWidth?: number, requestedHeight?: number): Promise<string>
Takes a snapshot image and maintains aspect ratio.

Returns
A URI that contains the image to download or use.
Parameters
- Optional requestedWidth: number
  
  The requested width of the snapshot.
- Optional requestedHeight: number
  
  The requested height of the snapshot.
Returns Promise<string>
Inherited from BaseBimCanvas.takeSnapshot
- Defined in canvas/base.ts:733

takeTopCamera2DSnapshot

takeTopCamera2DSnapshot(bBox?: BoundingBox3D, transparentBackgroundColor?: boolean): Promise<{ base64: string; height: number; width: number }>
Takes a snapshot of the top view of the canvas.
Parameters
- Optional bBox: BoundingBox3D
  
  The bounding box to capture.
- Optional transparentBackgroundColor: boolean
Returns Promise<{ base64: string; height: number; width: number }>
Inherited from BaseBimCanvas.takeTopCamera2DSnapshot
- Defined in canvas/base.ts:924

updateCloseButton

updateCloseButton(disabled: boolean, buttonTextI18n?: string): void
Updates the close button with the given parameters.
Parameters
- disabled: boolean
- Optional buttonTextI18n: string
Returns void
Inherited from BaseBimCanvas.updateCloseButton
- Defined in canvas/base.ts:379

Class BimCTCanvas

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

divElement: HTMLDivElement

Optional options: BaseBimCanvasOptions

Returns BimCTCanvas

Accessors

canvasElement

Returns HTMLCanvasElement

canvasHeight

Returns number

canvasWidth

Returns number

clipping

Returns BimCTClippingRegions

containerElement

Returns HTMLDivElement

customCursor

Parameters

cursorURL: string

Returns void

glContext

Returns

Returns WebGL2RenderingContext

gpuInfo

Returns

Returns GPUInfo

markups

Returns Markups

markupsElement

Returns HTMLDivElement

onCanvasRecreate

Returns ISignal

options

Returns BaseBimCanvasOptions

overlay

Returns BimCTOverlay

pins

Returns Pins

renderer

Returns BaseRenderer

Parameters

renderer: BaseRenderer

Returns void

rendererElement

Returns HTMLDivElement

viewerElement

Returns HTMLDivElement

wrapperBounds

Returns DOMRect

wrapperHeight

Returns number

wrapperWidth

Returns number

xrRefSpace

Returns

Returns XRReferenceSpace | XRBoundedReferenceSpace

xrSession

Returns

Returns XRSession

xrWebLayer

Returns

Returns XRWebGLLayer

Methods

clearRendererImageFromCanvas

Returns void

createXR

Returns

Parameters

mode: XRSessionMode

Optional eventDispatcher: EventDispatcher<BaseRenderer, XrSessionEventState>

Returns Promise<boolean>

cropSnapshot

Returns

`Optional` options: BaseBimCanvasOptions

`Optional` eventDispatcher: EventDispatcher<BaseRenderer, XrSessionEventState>

`Optional` transparentBackgroundColor: RGB

`Optional` closeEventCallback: ((event: BimEvent) => void)

`Optional` resizeEventCallback: ((event: ResizeBimEvent) => void)