Class: CSGPluginBase

Plugins.CSGPluginBase

Hierarchy

• AViewerPlugin<"">

  ↳ CSGPluginBase

  ↳↳ CSGPluginBSP

  ↳↳ CSGPluginBVH

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | CSGPluginBase | Promise<null | CSGPluginBase>

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

makeSelectedCSGBrush

▸ makeSelectedCSGBrush(): Promise<void>

Returns

Promise<void>

---

refreshCSG

▸ refreshCSG(): void

Returns

void

---

downloadObject

▸ downloadObject(): Promise<void>

Returns

Promise<void>

---

exportObject

▸ exportObject(): Promise<undefined | BlobExt>

Returns

Promise<undefined | BlobExt>

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

---

_buildCSGMesh

▸ Protected Abstract _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>

Properties

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

---

toJSON

• toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

---

dependencies

• dependencies: typeof PickingPlugin[]

---

rootObject

• Optional rootObject: Object3DModel

---

rootMesh

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

---

showResult

• showResult: boolean = false

---

csgSelectedEnabled

• csgSelectedEnabled: boolean = false

---

csgSelectedOperation

• csgSelectedOperation: string = 'union'

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Constructors

constructor

• new CSGPluginBase()

Overrides

AViewerPlugin.constructor