Class SectionPlanesPlugin

SectionPlanesPlugin is a Viewer plugin that manages SectionPlanes.

Hierarchy

Plugin
- SectionPlanesPlugin

Index

Constructors

constructor

Properties

Accessors

sectionPlanes

Methods

Constructors

constructor

new SectionPlanesPlugin(viewer: Viewer, cfg?: SectionPlanesPluginConfiguration): SectionPlanesPlugin

Overrides Plugin.constructor
- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:22
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: SectionPlanesPluginConfiguration
  
  Plugin configuration.
Returns SectionPlanesPlugin

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Accessors

sectionPlanes

get sectionPlanes(): {}

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:43
Returns a map of the SectionPlanes created by this SectionPlanesPlugin.

Returns {}
A map containing the SectionPlanes, each mapped to its SectionPlane.id.
- [key: string]: SectionPlane

Methods

clear

clear(): void

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:102
Destroys all SectionPlanes created by this SectionPlanesPlugin.

Returns void

createSectionPlane

createSectionPlane(params?: { active?: boolean; dir?: number[]; id?: string; pos?: number[] }): SectionPlane

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:57
Creates a SectionPlane.

The SectionPlane will be registered by SectionPlane.id in SectionPlanesPlugin.sectionPlanes.

Parameters
- Optional params: { active?: boolean; dir?: number[]; id?: string; pos?: number[] }
  
  SectionPlane configuration.
  - Optional active?: boolean
  - Optional dir?: number[]
  - Optional id?: string
  - Optional pos?: number[]
Returns SectionPlane
The new SectionPlane.

destroy

destroy(): void

Inherited from Plugin.destroy
- Defined in viewer/Plugin.d.ts:68
Destroys this Plugin and removes it from its Viewer.

Returns void

destroySectionPlane

destroySectionPlane(id: string): void

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:97
Destroys a SectionPlane created by this SectionPlanesPlugin.

Parameters
- id: string
  
  ID of the SectionPlane.
Returns void

error

error(msg: string): void

Inherited from Plugin.error
- Defined in viewer/Plugin.d.ts:63
Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

fire

fire(event: string, value: any): void

Inherited from Plugin.fire
- Defined in viewer/Plugin.d.ts:42
Fires an event at this Plugin.

Parameters
- event: string
  
  The event type name
- value: any
  
  The event parameters
Returns void

flipSectionPlanes

flipSectionPlanes(): void

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:69
Inverts the direction of SectionPlane.dir on every existing SectionPlane.

Inverts all SectionPlanes, including those that were not created with SectionPlanesPlugin.

Returns void

getOverviewVisible

getOverviewVisible(): boolean

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:36
Gets if the overview canvas is visible.

Returns boolean
True when the overview canvas is visible.

getShownControl

getShownControl(): string

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:85
Gets the ID of the SectionPlane that the 3D editing gizmo is shown for.

Returns null when the editing gizmo is not shown.

Returns string
ID of the the SectionPlane that the 3D editing gizmo is shown for, if shown, else null.

hideControl

hideControl(): void

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:90
Hides the 3D SectionPlane editing gizmo if shown.

Returns void

log

log(msg: string): void

Inherited from Plugin.log
- Defined in viewer/Plugin.d.ts:49
Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

on

on(event: string, callback: () => void): void

Inherited from Plugin.on
- Defined in viewer/Plugin.d.ts:35
Subscribes to an event fired at this Plugin.

Parameters
- event: string
  
  The event
- callback: () => void
  
  Callback fired on the event
  - - (): void
    - Returns void
Returns void

setOverviewVisible

setOverviewVisible(visible: boolean): void

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:29
Sets if the overview canvas is visible.

Parameters
- visible: boolean
  
  Whether or not the overview canvas is visible.
Returns void

showControl

showControl(id: string): void

- Defined in plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts:76
Shows the 3D editing gizmo for a SectionPlane.

Parameters
- id: string
  
  ID of the SectionPlane.
Returns void

warn

warn(msg: string): void

Inherited from Plugin.warn
- Defined in viewer/Plugin.d.ts:56
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

Generated using TypeDoc