Class GeometryGeneratorPlugin

Deprecated

Basic generators and line generator have moved to core threepipe. Import GeometryGeneratorPlugin from 'threepipe' for the core plugin. Use GeometryGeneratorExtrasPlugin from this package to add the text generator. This class is a compatibility shim that works like GeometryGeneratorExtrasPlugin with a deprecation warning.

Hierarchy (View Summary)

GeometryGeneratorExtrasPlugin
- GeometryGeneratorPlugin

Index

Constructors

constructor

new GeometryGeneratorPlugin(): GeometryGeneratorPlugin
Returns GeometryGeneratorPlugin
Overrides GeometryGeneratorExtrasPlugin.constructor
- Defined in plugins/geometry-generator/src/GeometryGeneratorExtrasPlugin.ts:56

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof GeometryGeneratorPlugin[] = ...

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

toJSON

toJSON: any = undefined

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "GeometryGeneratorExtrasPlugin" = 'GeometryGeneratorExtrasPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from GeometryGeneratorExtrasPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from GeometryGeneratorExtrasPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from GeometryGeneratorExtrasPlugin._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from GeometryGeneratorExtrasPlugin._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from GeometryGeneratorExtrasPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from GeometryGeneratorExtrasPlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from GeometryGeneratorExtrasPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from GeometryGeneratorExtrasPlugin.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): null | GeometryGeneratorPlugin | Promise<null | GeometryGeneratorPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | GeometryGeneratorPlugin | Promise<null | GeometryGeneratorPlugin>
Inherited from GeometryGeneratorExtrasPlugin.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from GeometryGeneratorExtrasPlugin.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from GeometryGeneratorExtrasPlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from GeometryGeneratorExtrasPlugin.onAdded
- Defined in plugins/geometry-generator/src/GeometryGeneratorExtrasPlugin.ts:23

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from GeometryGeneratorExtrasPlugin.onRemove
- Defined in plugins/geometry-generator/src/GeometryGeneratorExtrasPlugin.ts:40

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from GeometryGeneratorExtrasPlugin.setDirty
- Defined in src/viewer/AViewerPlugin.ts:90

Class GeometryGeneratorPlugin

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GeometryGeneratorPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

isViewerPluginSync

toJSON

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | GeometryGeneratorPlugin | Promise<null | GeometryGeneratorPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty