Class BimCTSettingsWindow

Class representing the settings window in BimCT.

Hierarchy

BimCTModalWindow
- BimCTSettingsWindow

Constructors

constructor

new BimCTSettingsWindow(
renderer: BaseRenderer,
rendererElement: HTMLDivElement,
): BimCTSettingsWindow
Constructor for BimCTSettingsWindow.
Parameters
- renderer: BaseRenderer
  The renderer.
- rendererElement: HTMLDivElement
  The renderer element.
Returns BimCTSettingsWindow
Overrides BimCTModalWindow.constructor
- Defined in gui/bimct-settings.ts:3243

Accessors

locked

get locked(): boolean
Gets the locked state of the settings window.

Returns boolean
The locked state.
- Defined in gui/bimct-settings.ts:3272
set locked(locked: boolean): void
Sets the locked state of the settings window.
Parameters
- locked: boolean
  The locked state.
Returns void
- Defined in gui/bimct-settings.ts:3264

settingsTabsBar

get settingsTabsBar(): HTMLDivElement
Gets the settings tabs bar element.

Returns HTMLDivElement
The settings tabs bar element.
- Defined in gui/bimct-settings.ts:3396

settingsTabsContainer

get settingsTabsContainer(): HTMLDivElement
Gets the settings tabs container element.

Returns HTMLDivElement
The settings tabs container element.
- Defined in gui/bimct-settings.ts:3404

windowResizedEvent

get windowResizedEvent(): IEvent<number, number>
Returns IEvent<number, number>
Inherited from BimCTModalWindow.windowResizedEvent
- Defined in gui/bimct-window.ts:290

windowStateChangedEvent

get windowStateChangedEvent(): IEvent<BaseRenderer, BimCTWindow>
Returns IEvent<BaseRenderer, BimCTWindow>
Inherited from BimCTModalWindow.windowStateChangedEvent
- Defined in gui/bimct-window.ts:294

windowElement

get windowElement(): HTMLElement
Returns HTMLElement
Inherited from BimCTModalWindow.windowElement
- Defined in gui/bimct-window.ts:298

index

get index(): number
Returns number
Inherited from BimCTModalWindow.index
- Defined in gui/bimct-window.ts:306
set index(index: number): void
Parameters
- index: number
Returns void
Inherited from BimCTModalWindow.index
- Defined in gui/bimct-window.ts:310

leafRowHeight

get leafRowHeight(): number
Returns number
Inherited from BimCTModalWindow.leafRowHeight
- Defined in gui/bimct-window.ts:314

zIndex

get zIndex(): number
Returns number
Inherited from BimCTModalWindow.zIndex
- Defined in gui/bimct-window.ts:318
set zIndex(zIndex: number): void
Parameters
- zIndex: number
Returns void
Inherited from BimCTModalWindow.zIndex
- Defined in gui/bimct-window.ts:322

active

get active(): boolean
Returns boolean
Inherited from BimCTModalWindow.active
- Defined in gui/bimct-window.ts:326
set active(active: boolean): void
Parameters
- active: boolean
Returns void
Inherited from BimCTModalWindow.active
- Defined in gui/bimct-window.ts:330

resetWindowStyle

get resetWindowStyle(): string
Returns string
Inherited from BimCTModalWindow.resetWindowStyle
- Defined in gui/bimct-window.ts:334
set resetWindowStyle(val: string): void
Parameters
- val: string
Returns void
Inherited from BimCTModalWindow.resetWindowStyle
- Defined in gui/bimct-window.ts:338

title

get title(): string
Returns string
Inherited from BimCTModalWindow.title
- Defined in gui/bimct-window.ts:568
set title(title: string): void
Parameters
- title: string
Returns void
Inherited from BimCTModalWindow.title
- Defined in gui/bimct-window.ts:572

footerText

get footerText(): string
Returns string
Inherited from BimCTModalWindow.footerText
- Defined in gui/bimct-window.ts:579
set footerText(footerText: string): void
Parameters
- footerText: string
Returns void
Inherited from BimCTModalWindow.footerText
- Defined in gui/bimct-window.ts:583

renderer

get renderer(): BaseRenderer
Gets the renderer associated with the window.

Returns BaseRenderer
The renderer.
Inherited from BimCTModalWindow.renderer
- Defined in gui/bimct-window.ts:1273

Methods

show

show(): boolean
Shows the settings window.

Returns boolean
Whether the settings window was shown.
Overrides BimCTModalWindow.show
- Defined in gui/bimct-settings.ts:3354

hide

hide(): boolean
Hides the settings window.

Returns boolean
Whether the settings window was hidden.
Overrides BimCTModalWindow.hide
- Defined in gui/bimct-settings.ts:3378

fireSettingsChanged

fireSettingsChanged(): void
Fires the settings changed event.

Returns void
- Defined in gui/bimct-settings.ts:3411

activateWindow

activateWindow(activate: boolean, refresh?: boolean): void
Activates or deactivates the window.
Parameters
- activate: boolean
  Whether to activate the window.
- Optionalrefresh: boolean = true
  Whether to refresh the UI.
Returns void
Inherited from BimCTModalWindow.activateWindow
- Defined in gui/bimct-window.ts:347

setWindowLoading

setWindowLoading(on: boolean): void
Sets the loading state of the window.
Parameters
- on: boolean
  Whether to show the loading state.
Returns void
Inherited from BimCTModalWindow.setWindowLoading
- Defined in gui/bimct-window.ts:506

restoreWindow

restoreWindow(): void
Restores the window to its original size and position.

Returns void
Inherited from BimCTModalWindow.restoreWindow
- Defined in gui/bimct-window.ts:1047

maximizeWindow

maximizeWindow(): void
Maximizes the window to fill the screen.

Returns void
Inherited from BimCTModalWindow.maximizeWindow
- Defined in gui/bimct-window.ts:1080

isShowing

isShowing(): boolean
Checks if the window is currently showing.

Returns boolean
True if the window is showing, otherwise false.
Inherited from BimCTModalWindow.isShowing
- Defined in gui/bimct-window.ts:1101

resetToDefault

resetToDefault(force: boolean): void
Resets the window to its default style.
Parameters
- force: boolean
  Whether to force the reset.
Returns void
Inherited from BimCTModalWindow.resetToDefault
- Defined in gui/bimct-window.ts:1109

moveHorizontally

moveHorizontally(pixels: number): void
Moves the window horizontally by a specified number of pixels. Only if already moved one time
Parameters
- pixels: number
  The number of pixels to move the window.
Returns void
Inherited from BimCTModalWindow.moveHorizontally
- Defined in gui/bimct-window.ts:1133

refreshUI

refreshUI(): void
Refreshes the UI of the modal window.

Returns void
Inherited from BimCTModalWindow.refreshUI
- Defined in gui/bimct-window.ts:1318

setTempHide

setTempHide(val: boolean): void
Temporarily hides or shows the modal window.
Parameters
- val: boolean
  Whether to hide the window.
Returns void
Inherited from BimCTModalWindow.setTempHide
- Defined in gui/bimct-window.ts:1330