Class: VisibilityExtension

Extension for manage elements visibility. Extension can hide, isolate selected elements and show all elements in scene.

Hierarchy

• ExtensionBase

  ↳ VisibilityExtension

Constructors

constructor

• new VisibilityExtension(viewerName): VisibilityExtension

Parameters

Name	Type	Description
viewerName	string	Owner viewer name.

Returns

VisibilityExtension

Overrides

ExtensionBase.constructor

Properties

getName

• getName: () => string

Get unique extension name.

Type declaration

▸ (): string

Get unique extension name.

Returns

string

Inherited from

ExtensionBase.getName

---

helpDesc

• Readonly helpDesc: string

Optional description for placing on HelpToolbar.

Inherited from

ExtensionBase.helpDesc

---

helpIcon

• Readonly helpIcon: string

Optional icon for placing on HelpToolbar.

Inherited from

ExtensionBase.helpIcon

---

hideToolbar

• hideToolbar: boolean

Is extension need to hide toolbar or not.

Inherited from

ExtensionBase.hideToolbar

---

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

ExtensionBase.state

---

type

• Readonly type: string

Extension type (ext, mode, control).

Inherited from

ExtensionBase.type

---

viewerName

• Readonly viewerName: string

Owner viewer name.

Inherited from

ExtensionBase.viewerName

Methods

activateAll

▸ activateAll(): void

Make unselected elements to inactive state.

Returns

void

---

getRenderManager

▸ getRenderManager(): RenderManager

Get current RenderManager instance.

Returns

RenderManager

Inherited from

ExtensionBase.getRenderManager

---

hideSelected

▸ hideSelected(): void

Hide selected elements in scene.

Returns

void

---

inactivateSelected

▸ inactivateSelected(): void

Make selected elements to inactive state.

Returns

void

---

inactivateUnselected

▸ inactivateUnselected(): void

Make unselected elements to inactive state.

Returns

void

---

isolateSelected

▸ isolateSelected(): void

Isolate selected elements in scene.

Returns

void

---

restoreState

▸ restoreState(): void

Restore extension state from the local storage.

Returns

void

Inherited from

ExtensionBase.restoreState

---

saveState

▸ saveState(): void

Save extension state in the local storage.

Returns

void

Inherited from

ExtensionBase.saveState

---

setRestoreStateHandler

▸ setRestoreStateHandler(handler): this

Sets external hook handler for restoring extension state in the local storage.

Parameters

Name	Type	Description
handler	Function	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

Name	Type	Description
handler	Function	handler hook function.

Returns

this

Inherited from

ExtensionBase.setSaveStateHandler

---

showAll

▸ showAll(): void

Show all elements in scene.

Returns

void

Hooks

commandChanged

▸ commandChanged(newCommand): void

Hook when current extension command is changed or finished. Called by ExtensionManager.setCurrentCommandExtension().

Parameters

Name	Type
newCommand	ExtensionBase

Returns

void

Inherited from

ExtensionBase.commandChanged

---

dedicatedToolbarRender

▸ dedicatedToolbarRender(container): void

Render function for rendering dedicated toolbar content.

Parameters

Name	Type	Description
container	HTMLElement	Parent DOM container.

Returns

void

Inherited from

ExtensionBase.dedicatedToolbarRender

---

uiRender

▸ uiRender(container): void

Render function for rendering additional UI above viewer canvas.

Parameters

Name	Type	Description
container	HTMLElement	Parent DOM container.

Returns

void

Inherited from

ExtensionBase.uiRender