Class GeometryGeneratorPlugin

GeometryGeneratorPlugin

Geometry generator plugin to create updatable parametric objects/geometries. Includes support for several primitive types from three.js

Hierarchy

AViewerPluginSync
- GeometryGeneratorPlugin

Constructors

constructor

new GeometryGeneratorPlugin(): GeometryGeneratorPlugin
Creates EventDispatcher object.

Returns GeometryGeneratorPlugin
Inherited from AViewerPluginSync.constructor
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:49

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

defaultGeometryClass

defaultGeometryClass: Class<BufferGeometry> = BufferGeometry2

defaultMaterialClass

defaultMaterialClass: Class<IMaterial> = PhysicalMaterial

enabled

enabled: boolean = true

generators

generators: Record<string, GeometryGenerator> = ...

toJSON

toJSON: any = undefined

uiConfig

uiConfig: {
    children: () => {
        label: string;
        type: string;
        uuid: string;
        value: () => Promise<void>;
    }[][];
    label: string;
    type: string;
} = ...

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "GeometryGeneratorPlugin" = 'GeometryGeneratorPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

Methods

`Protected`_onViewerEvent

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

`Protected`_removeObject3DGenerators

_removeObject3DGenerators(
refresh?: boolean,
): undefined | Object3DGeneratorPlugin
Parameters
- refresh: boolean = true
Returns undefined | Object3DGeneratorPlugin
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:78

`Protected`_sceneUpdate

_sceneUpdate(e: any): void
Parameters
- e: any
Returns void
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:100

`Protected`_storeKey

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

disable

disable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:75

dispose

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

enable

enable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:80

exportState

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

fromJSON

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

generateGeometry

generateGeometry(type: string, params: any, geometry?: IGeometry): IGeometry
Parameters
- type: string
- params: any
- Optionalgeometry: IGeometry
Returns IGeometry
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:53

generateObject

generateObject(type: string, params?: any): Mesh2<any, any>
Parameters
- type: string
- Optionalparams: any
Returns Mesh2<any, any>
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:44

importState

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

isDisabled

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

onAdded

onAdded(v: ThreeViewer): void
Parameters
- v: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:67

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:73

refreshObject3DGenerator

refreshObject3DGenerator(): void
Returns void
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:87

`Optional`setDirty

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

updateGeometry

updateGeometry(geometry: IGeometry, params: any): void
Parameters
- geometry: IGeometry
- params: any
Returns void
- Defined in plugins/geometry-generator/src/GeometryGeneratorPlugin.ts:60

Class GeometryGeneratorPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GeometryGeneratorPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

defaultGeometryClass

defaultMaterialClass

enabled

generators

toJSON

uiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_removeObject3DGenerators

Parameters

Returns undefined | Object3DGeneratorPlugin

Protected_sceneUpdate

Parameters

Returns void

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>

generateGeometry

Parameters

Returns IGeometry

generateObject

Parameters

Returns Mesh2<any, any>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

refreshObject3DGenerator

Returns void

OptionalsetDirty

Parameters

Returns any

updateGeometry

Parameters

Returns void

Settings

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_removeObject3DGenerators

`Protected`_sceneUpdate

`Protected`_storeKey

`Optional`setDirty