Class: CSGPluginBSP

Plugins.CSGPluginBSP

Hierarchy

• CSGPluginBase

  ↳ CSGPluginBSP

Properties

PluginType

▪ Static Readonly PluginType: "CSGPluginBSP"

---

enabled

• enabled: boolean = true

Inherited from

CSGPluginBase.enabled

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Inherited from

CSGPluginBase.uiConfig

---

toJSON

• toJSON: any = undefined

Inherited from

CSGPluginBase.toJSON

---

dependencies

• dependencies: typeof PickingPlugin[]

Inherited from

CSGPluginBase.dependencies

---

rootObject

• Optional rootObject: Object3DModel

Inherited from

CSGPluginBase.rootObject

---

rootMesh

• rootMesh: Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

Inherited from

CSGPluginBase.rootMesh

---

showResult

• showResult: boolean = false

Inherited from

CSGPluginBase.showResult

---

csgSelectedEnabled

• csgSelectedEnabled: boolean = false

Inherited from

CSGPluginBase.csgSelectedEnabled

---

csgSelectedOperation

• csgSelectedOperation: string = 'union'

Inherited from

CSGPluginBase.csgSelectedOperation

---

_dirty

• Protected _dirty: boolean = false

Inherited from

CSGPluginBase._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

CSGPluginBase._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

CSGPluginBase.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

CSGPluginBase.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

CSGPluginBase.viewer

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

CSGPluginBase.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

CSGPluginBase.onRemove

---

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

---

exportState

▸ exportState(): any

Returns

any

Inherited from

CSGPluginBase.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

CSGPluginBase.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

CSGPluginBase.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

CSGPluginBase.loadState

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

CSGPluginBase.onAdded

---

makeSelectedCSGBrush

▸ makeSelectedCSGBrush(): Promise<void>

Returns

Promise<void>

Inherited from

CSGPluginBase.makeSelectedCSGBrush

---

refreshCSG

▸ refreshCSG(): void

Returns

void

Inherited from

CSGPluginBase.refreshCSG

---

downloadObject

▸ downloadObject(): Promise<void>

Returns

Promise<void>

Inherited from

CSGPluginBase.downloadObject

---

exportObject

▸ exportObject(): Promise<undefined | BlobExt>

Returns

Promise<undefined | BlobExt>

Inherited from

CSGPluginBase.exportObject

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

CSGPluginBase._storeKey

---

_buildCSGMesh

▸ Protected _buildCSGMesh(meshes): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

Parameters

Name	Type
meshes	[Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>, TCSGOperation][]

Returns

Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

Overrides

CSGPluginBase._buildCSGMesh

Constructors

constructor

• new CSGPluginBSP()

Inherited from

CSGPluginBase.constructor