Class: LevelsExtension
Class: LevelsExtension
Extension for controlling clipping planes based on model floor levels. Follows the same plane management pattern as SliceExtension.
Extends
Properties
actions
actions:
ToolbarActionGroup[]
Toolbar action groups exposed by this extension (shown as dropdown buttons). Populate in added or update dynamically at runtime.
Inherited from
compactModeSettings
compactModeSettings:
CompactModeSettings
Get compact mode settings.
Inherited from
ExtensionBase.compactModeSettings
defaultLevelHeight
defaultLevelHeight:
number
Fallback top clipping offset (in metres) when the level has no next floor.
getName
getName: () =>
string
Get unique extension name.
Returns
string
Inherited from
helpers
helpers:
HelperAction[]
Helper dialog actions exposed by this extension. Populate in added or update dynamically at runtime.
Inherited from
hideToolbar
hideToolbar:
boolean
Is extension need to hide toolbar or not.
Inherited from
isLevelsSliceOn
isLevelsSliceOn:
boolean
Whether level-based clipping is currently active.
state
state:
any
Any extension data which can be stored in browser local storage and restored after (any extension settings, buttons state and so one). State will be saved in local storage with 'tangl-ext-extensionName' key.
Inherited from
title
title:
string
Get extension title.
Inherited from
type
readonlytype:string
Extension type (ext, mode, control).
Inherited from
viewerName
readonlyviewerName:string
Owner viewer name.
Inherited from
getName
staticgetName: () =>string
Get unique extension name.
Returns
string
Overrides
Methods
clearClipping()
clearClipping():
void
Remove all level clipping planes and reset state.
Returns
void
getRenderManager()
getRenderManager():
RenderManager
Get current RenderManager instance.
Returns
Inherited from
ExtensionBase.getRenderManager
restoreState()
restoreState():
Promise<void>
Restore extension state from the local storage.
Returns
Promise<void>
Inherited from
saveState()
saveState():
Promise<void>
Save extension state in the local storage.
Returns
Promise<void>
Inherited from
setRestoreStateHandler()
setRestoreStateHandler(
handler):this
Sets external hook handler for restoring extension state in the local storage.
Parameters
handler
(stateName, state) => Promise<any>
handler hook function.
Returns
this
Inherited from
ExtensionBase.setRestoreStateHandler
setSaveStateHandler()
setSaveStateHandler(
handler):this
Sets external hook handler for storing extension state in the local storage.
Parameters
handler
(stateName, state) => void
handler hook function.
Returns
this
Inherited from
ExtensionBase.setSaveStateHandler
sliceByLevel()
sliceByLevel(
level):void
Configures bottom and top clipping planes for the given floor level.
Parameters
level
any
A SceneLevel object with elevation data.
Returns
void
Hooks
added()
added():
void
Called when the extension is added to the viewer.
Returns
void
Overrides
commandChanged()
commandChanged(
oldCommandName,newCommandName):void
Hook when current extension command is changed or finished. Called by ExtensionManager.setCurrentCommandExtension().
Parameters
oldCommandName
string
newCommandName
string
Returns
void
Inherited from
dedicatedToolbarRender()
dedicatedToolbarRender(
container):void
Render function for rendering dedicated toolbar content.
Parameters
container
HTMLElement
Parent DOM container.
Returns
void
Inherited from
ExtensionBase.dedicatedToolbarRender
deleted()
deleted():
void
Called when the extension is removed from the viewer.
Returns
void
Overrides
sharedToolbarRender()
sharedToolbarRender(
container):void
Render function for rendering shared toolbar content.
Parameters
container
HTMLElement
Parent DOM container.
Returns
void
Inherited from
ExtensionBase.sharedToolbarRender
uiRender()
uiRender(
container):void
Render function for rendering additional UI above viewer canvas.
Parameters
container
HTMLElement
Parent DOM container.
Returns
void