Skip to main content

Class: CSGPluginBase

Plugins.CSGPluginBase

Hierarchy

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | CSGPluginBase | Promise<null | CSGPluginBase>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/CSGPluginBase.ts:37


makeSelectedCSGBrush

makeSelectedCSGBrush(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/CSGPluginBase.ts:56


refreshCSG

refreshCSG(): void

Returns

void

Defined in

webgi/src/plugins/CSGPluginBase.ts:86


downloadObject

downloadObject(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/CSGPluginBase.ts:95


exportObject

exportObject(): Promise<undefined | BlobExt>

Returns

Promise<undefined | BlobExt>

Defined in

webgi/src/plugins/CSGPluginBase.ts:100


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60


_buildCSGMesh

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

Parameters

NameType
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>[]>

Defined in

webgi/src/plugins/CSGPluginBase.ts:129

Properties

enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/CSGPluginBase.ts:15


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/plugins/CSGPluginBase.ts:17


toJSON

toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/CSGPluginBase.ts:18


dependencies

dependencies: typeof PickingPlugin[]

Defined in

webgi/src/plugins/CSGPluginBase.ts:20


rootObject

Optional rootObject: Object3DModel

Defined in

webgi/src/plugins/CSGPluginBase.ts:34


rootMesh

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

Defined in

webgi/src/plugins/CSGPluginBase.ts:35


showResult

showResult: boolean = false

Defined in

webgi/src/plugins/CSGPluginBase.ts:50


csgSelectedEnabled

csgSelectedEnabled: boolean = false

Defined in

webgi/src/plugins/CSGPluginBase.ts:77


csgSelectedOperation

csgSelectedOperation: string = 'union'

Defined in

webgi/src/plugins/CSGPluginBase.ts:83


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Constructors

constructor

new CSGPluginBase()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/CSGPluginBase.ts:22