Class SectionPlugin

Hierarchy

Plugin
- SectionPlugin

Index

Constructors

constructor

Properties

id

Methods

Constructors

constructor

new SectionPlugin(viewer: BaseViewer): SectionPlugin

Overrides Plugin.constructor
- Defined in plugins/sections/SectionPlugin.ts:14
Creates this Plugin and installs it into the given {@link Viewer}.

Parameters
- viewer: BaseViewer
Returns SectionPlugin

Properties

Readonly id

id: string

Methods

activate

activate(type: SectionType): void

- Defined in plugins/sections/SectionPlugin.ts:36
description
{en} Activates one of "ObjectsBoxSection", "AxisPlaneSection" or "PickPlaneSection" Section

description
{zh} 激活"剖切盒", "轴向剖切" 或者 "拾取面剖切"

Parameters
- type: SectionType
Returns void

deactivate

deactivate(): void

- Defined in plugins/sections/SectionPlugin.ts:47
description
Deactivate Section plugin

Returns void

destroy

destroy(): void

Overrides Plugin.destroy
- Defined in plugins/sections/SectionPlugin.ts:114
Destroys this Plugin and removes it from its viewer.

Returns void

getActiveSection

getActiveSection(): undefined | BaseSection

- Defined in plugins/sections/SectionPlugin.ts:81
Gets the active section.

Returns undefined | BaseSection

getActiveSectionType

getActiveSectionType(): undefined | SectionType

- Defined in plugins/sections/SectionPlugin.ts:74
Gets the active section type.

Returns undefined | SectionType

isActive

isActive(): boolean

- Defined in plugins/sections/SectionPlugin.ts:63
Returns boolean
Is Section active

resetSection

resetSection(): void

- Defined in plugins/sections/SectionPlugin.ts:55
Returns void

Generated using TypeDoc