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:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:42


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:54


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


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


_buildCSGMesh

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

Parameters

NameType
meshes[Mesh<BufferGeometry, Material | Material[]>, TCSGOperation][]

Returns

Mesh<BufferGeometry, Material | Material[]>

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, Material | Material[]>

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:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Constructors

constructor

new CSGPluginBase()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/CSGPluginBase.ts:22