Class ZonePlugin

Plugin that lets users create zones (box, sphere, or object-shaped markup meshes) batched into shared geometry containers.

Hierarchy

PluginBaseClass
- ZonePlugin

Index

Constructors

Properties

name settings viewer

Methods

clear dependencies getBatchedEdgeGeometry getBatchedMesh hasSettings onRegister onUnregister Create

Constructors

constructor

new ZonePlugin(
viewer: Viewer,
cfg?: RecursivePartial<ExtractValues<{ color: ColorController }>>,
): ZonePlugin
Parameters
- viewer: Viewer
- Optionalcfg: RecursivePartial<ExtractValues<{ color: ColorController }>>
Returns ZonePlugin
Inherited from PluginBaseClass.constructor
- Defined in viewer/src/core/ViewerPlugin.ts:114

Properties

`Readonly`name

name: string

Display name of the plugin

`Readonly`settings

settings: { color: ColorController }

Plugin settings

`Readonly`viewer

viewer: Viewer

Methods

clear

clear(): void
Returns void
Inherited from PluginBaseClass.clear
- Defined in viewer/src/core/ViewerPlugin.ts:105

dependencies

dependencies(): readonly (keyof ViewerPluginRegistry)[]
List of plugins this plugin depends on

Returns readonly (keyof ViewerPluginRegistry)[]
Overrides PluginBaseClass.dependencies
- Defined in plugins/src/ZonePlugin/ZonePlugin.tsx:32

`Readonly`getBatchedEdgeGeometry

getBatchedEdgeGeometry(geometry: BufferGeometry): BatchedLineGeometry
Parameters
- geometry: BufferGeometry
Returns BatchedLineGeometry
- Defined in plugins/src/ZonePlugin/ZonePlugin.tsx:69

`Readonly`getBatchedMesh

getBatchedMesh(geometry: BufferGeometry): BatchedGeometry
Parameters
- geometry: BufferGeometry
Returns BatchedGeometry
- Defined in plugins/src/ZonePlugin/ZonePlugin.tsx:36

hasSettings

hasSettings(): boolean
Indicates whether the plugin has settings

Returns boolean
Inherited from PluginBaseClass.hasSettings
- Defined in viewer/src/core/ViewerPlugin.ts:79

onRegister

onRegister(): void
Called when the plugin is registered in the viewer.

Returns void
Overrides PluginBaseClass.onRegister
- Defined in plugins/src/ZonePlugin/ZonePlugin.tsx:99

onUnregister

onUnregister(): void
Called when the plugin is unregistred from the viewer.

Returns void
Overrides PluginBaseClass.onUnregister
- Defined in plugins/src/ZonePlugin/ZonePlugin.tsx:105

`Static`Create

Create<S extends SettingsRecord = Record<string, never>>(
name: string,
settingFunc?: PluginSettingBuildFunction<S>,
): typeof PluginClass
Type Parameters
- S extends SettingsRecord = Record<string, never>
Parameters
- name: string
- settingFunc: PluginSettingBuildFunction<S> = ...
Returns typeof PluginClass
Inherited from TeiaPlugin.Create
- Defined in viewer/src/core/ViewerPlugin.ts:109