Class BimCTOverlay

The main overlay class for the BIM canvas.

Hierarchy

  • BimCTOverlay

Constructors

constructor

Accessors

canvas halfSplashScreen topLeftLabel

Methods

addLabel addPolyLine3D addRectangle3D addRuler canvasWidget clearFillMessage clearLoading clearLoadingStatus clearRubberband clearTopCenterMessage clearTopLeftMessage createCanvas createDateTimeSpinner createGameLegend createSplashScreen destroy isFullOverlay isLoading isSplashScreenVisible isTopCenterLabelVisible isTopLeftLabelVisible redraw removeDateTimeSpinner removeGameLegend removeSplashScreen resize setDateTime setFillMessage setGameLegendVisible setLoading setScreenSpaceSymbol2D setSplashScreenVisible setTopCenterLabelVisible setTopCenterMessage setTopLeftLabelVisible setTopLeftMessage updateRubberband

Constructors

constructor

Accessors

canvas

  • get canvas(): HTMLCanvasElement

  • Gets the primary canvas element.

    Returns

    The primary canvas HTMLCanvasElement.

    Returns HTMLCanvasElement

halfSplashScreen

  • set halfSplashScreen(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

topLeftLabel

  • get topLeftLabel(): LabelWidget

  • Gets the top left label widget.

    Returns

    The top left label widget.

    Returns LabelWidget

Methods

addLabel

  • Adds a label to the canvas.

    Returns

    The created LabelWidget.

    Parameters

    • text: string

      The label text.

    • x: number

      The x-coordinate.

    • y: number

      The y-coordinate.

    • orientation: Orientation

      The label orientation.

    • rotationAngle: number

      The rotation angle.

    • background: boolean

      Whether the label has a background.

    • border: boolean

      Whether the label has a border.

    Returns LabelWidget

addPolyLine3D

  • Adds a 3D polyline to the canvas.

    Returns

    The created PolyLineWidget3D.

    Parameters

    Returns PolyLineWidget3D

addRectangle3D

  • Adds a 3D polyline to the canvas.

    Returns

    The created PolyLineWidget3D.

    Parameters

    Returns RectangleWidget3D

addRuler

  • Adds a ruler to the canvas.

    Returns

    The created MeasureRulerWidget3D.

    Parameters

    Returns MeasureRulerWidget3D

canvasWidget

  • Gets the canvas widget.

    Returns

    The canvas widget.

    Returns CanvasWidget

clearFillMessage

  • Clears the fill message.

    Returns void

clearLoading

  • Clears the loading status.

    Returns void

clearLoadingStatus

  • Clears the loading status.

    Returns void

clearRubberband

  • Clears the rubberband selection area.

    Returns void

clearTopCenterMessage

  • Clears the top center message.

    Returns void

clearTopLeftMessage

  • Clears the top left message.

    Returns void

createCanvas

  • Creates the primary canvas element.

    Returns

    The primary canvas HTMLCanvasElement.

    Returns HTMLCanvasElement

createDateTimeSpinner

  • Creates the date and time spinner element.

    Returns

    The date and time spinner HTMLDivElement.

    Returns HTMLDivElement

createGameLegend

  • Creates the game legend element.

    Returns

    The game legend HTMLDivElement.

    Returns HTMLDivElement

createSplashScreen

  • Creates the splash screen element.

    Returns

    The splash screen HTMLDivElement.

    Returns HTMLDivElement

destroy

  • Destroys the overlay and clears any timeouts.

    Returns void

isFullOverlay

  • Checks if the overlay is fully visible.

    Returns

    Whether the overlay is fully visible.

    Returns boolean

isLoading

  • Checks if the overlay is loading.

    Returns

    Whether the overlay is loading.

    Returns boolean

isSplashScreenVisible

  • Gets the visibility of the splash screen.

    Returns

    Whether the splash screen is visible.

    Returns boolean

isTopCenterLabelVisible

  • Checks if the top center label is visible.

    Returns

    Whether the top center label is visible.

    Returns boolean

isTopLeftLabelVisible

  • Checks if the top left label is visible.

    Returns

    Whether the top left label is visible.

    Returns boolean

redraw

  • Redraws the canvas.

    Returns void

removeDateTimeSpinner

  • Removes the date and time spinner element.

    Returns void

removeGameLegend

  • Removes the game legend element.

    Returns void

removeSplashScreen

  • Removes the splash screen element.

    Returns void

resize

  • Resizes the canvas and updates the overlay.

    Parameters

    • width: number

      The new width.

    • height: number

      The new height.

    Returns void

setDateTime

  • Sets the date and time displayed on the spinner.

    Parameters

    • dateTime: Date

      The date and time to display.

    Returns void

setFillMessage

  • Sets the fill message.

    Parameters

    • message: string

      The message to display.

    Returns void

setGameLegendVisible

  • Sets the visibility of the game legend.

    Parameters

    • visible: boolean

      Whether the game legend is visible.

    Returns void

setLoading

  • Sets the loading progress and message.

    Parameters

    • percentage: number

      The loading percentage.

    • text: string

      The loading message.

    Returns void

setScreenSpaceSymbol2D

  • Sets a 2D symbol on the canvas.

    Parameters

    • x: number

      The x-coordinate.

    • y: number

      The y-coordinate.

    • r: number

      The red color value.

    • g: number

      The green color value.

    • b: number

      The blue color value.

    • symbol_type: number

      The symbol type.

    • enable: number

      Whether the symbol is enabled.

    Returns void

setSplashScreenVisible

  • Sets the visibility of the splash screen.

    Parameters

    • url: string

      The background image URL.

    • visible: boolean

      Whether the splash screen is visible.

    Returns void

setTopCenterLabelVisible

  • Sets the visibility of the top center label.

    Parameters

    • val: boolean

      Whether the top center label is visible.

    Returns void

setTopCenterMessage

  • Sets the top center message.

    Parameters

    • message: string

      The message to display.

    Returns void

setTopLeftLabelVisible

  • Sets the visibility of the top left label.

    Parameters

    • val: boolean

      Whether the top left label is visible.

    Returns void

setTopLeftMessage

  • Sets the top left message.

    Parameters

    • message: string

      The message to display.

    • lineThrough: boolean = false

      Whether the message should have a line through it.

    Returns void

updateRubberband

  • Updates the rubberband selection area.

    Parameters

    • x: number

      The x-coordinate.

    • y: number

      The y-coordinate.

    • w: number

      The width.

    • h: number

      The height.

    Returns void

Settings

Member Visibility

Theme