Class: CSGPluginBSP

Plugins.CSGPluginBSP

Hierarchy

• CSGPluginBase

  ↳ CSGPluginBSP

Properties

PluginType

▪ Static Readonly PluginType: "CSGPluginBSP"

Defined in

webgi/src/plugins/CSGPluginBSP.ts:34

---

enabled

• enabled: boolean = true

Inherited from

CSGPluginBase.enabled

Defined in

webgi/src/plugins/CSGPluginBase.ts:15

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Inherited from

CSGPluginBase.uiConfig

Defined in

webgi/src/plugins/CSGPluginBase.ts:17

---

toJSON

• toJSON: any = undefined

Inherited from

CSGPluginBase.toJSON

Defined in

webgi/src/plugins/CSGPluginBase.ts:18

---

dependencies

• dependencies: typeof PickingPlugin[]

Inherited from

CSGPluginBase.dependencies

Defined in

webgi/src/plugins/CSGPluginBase.ts:20

---

rootObject

• Optional rootObject: Object3DModel

Inherited from

CSGPluginBase.rootObject

Defined in

webgi/src/plugins/CSGPluginBase.ts:34

---

rootMesh

• rootMesh: Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>

Inherited from

CSGPluginBase.rootMesh

Defined in

webgi/src/plugins/CSGPluginBase.ts:35

---

showResult

• showResult: boolean = false

Inherited from

CSGPluginBase.showResult

Defined in

webgi/src/plugins/CSGPluginBase.ts:50

---

csgSelectedEnabled

• csgSelectedEnabled: boolean = false

Inherited from

CSGPluginBase.csgSelectedEnabled

Defined in

webgi/src/plugins/CSGPluginBase.ts:77

---

csgSelectedOperation

• csgSelectedOperation: string = 'union'

Inherited from

CSGPluginBase.csgSelectedOperation

Defined in

webgi/src/plugins/CSGPluginBase.ts:83

---

_dirty

• Protected _dirty: boolean = false

Inherited from

CSGPluginBase._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

CSGPluginBase._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

CSGPluginBase.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

CSGPluginBase.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

viewer

• get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

CSGPluginBase.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

CSGPluginBase.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

CSGPluginBase.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:44

---

fromJSON

▸ fromJSON(data, meta?): null | CSGPluginBSP | Promise<null | CSGPluginBSP>

Parameters

Name	Type
data	any
meta?	any

Returns

null | CSGPluginBSP | Promise<null | CSGPluginBSP>

Inherited from

CSGPluginBase.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:56

---

exportState

▸ exportState(): any

Returns

any

Inherited from

CSGPluginBase.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

CSGPluginBase.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

CSGPluginBase.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

CSGPluginBase.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

CSGPluginBase.onAdded

Defined in

webgi/src/plugins/CSGPluginBase.ts:37

---

makeSelectedCSGBrush

▸ makeSelectedCSGBrush(): Promise<void>

Returns

Promise<void>

Inherited from

CSGPluginBase.makeSelectedCSGBrush

Defined in

webgi/src/plugins/CSGPluginBase.ts:56

---

refreshCSG

▸ refreshCSG(): void

Returns

void

Inherited from

CSGPluginBase.refreshCSG

Defined in

webgi/src/plugins/CSGPluginBase.ts:86

---

downloadObject

▸ downloadObject(): Promise<void>

Returns

Promise<void>

Inherited from

CSGPluginBase.downloadObject

Defined in

webgi/src/plugins/CSGPluginBase.ts:95

---

exportObject

▸ exportObject(): Promise<undefined | BlobExt>

Returns

Promise<undefined | BlobExt>

Inherited from

CSGPluginBase.exportObject

Defined in

webgi/src/plugins/CSGPluginBase.ts:100

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

CSGPluginBase._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

_buildCSGMesh

▸ Protected _buildCSGMesh(meshes): Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>

Parameters

Name	Type
meshes	[Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>, TCSGOperation][]

Returns

Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>

Overrides

CSGPluginBase._buildCSGMesh

Defined in

webgi/src/plugins/CSGPluginBSP.ts:36

Constructors

constructor

• new CSGPluginBSP()

Inherited from

CSGPluginBase.constructor

Defined in

webgi/src/plugins/CSGPluginBase.ts:22