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 THREE.EventDispatcher | EventDispatcher object.

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

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) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

defaultGeometryClass

defaultGeometryClass: Class<BufferGeometry<NormalBufferAttributes, Event, string>> = BufferGeometry2

defaultMaterialClass

defaultMaterialClass: Class<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>> = PhysicalMaterial

enabled

enabled: boolean = true

generators

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

toJSON

toJSON: any = undefined

uiConfig

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

Type declaration

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:107
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected` _onViewerEvent

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

`Protected` _removeObject3DGenerators

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

`Protected` _sceneUpdate

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

`Protected` _storeKey

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

disable

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

dispose

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

enable

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

exportState

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

fromJSON

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

generateGeometry

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

generateObject

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

importState

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

isDisabled

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

onAdded

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

onRemove

onRemove(viewer): 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
Parameters
- Rest ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

updateGeometry

updateGeometry(geometry, params): void
Parameters
- geometry: IGeometry<NormalBufferAttributes>
- 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

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

defaultGeometryClass

defaultMaterialClass

enabled

generators

toJSON

uiConfig

Type declaration

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

label: string

type: string

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _removeObject3DGenerators

Parameters

refresh: boolean = true

Returns undefined | Object3DGeneratorPlugin

Protected _sceneUpdate

Parameters

e: any

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | GeometryGeneratorPlugin | Promise<null | GeometryGeneratorPlugin>

generateGeometry

Parameters

type: string

params: any

Optional geometry: IGeometry<NormalBufferAttributes>

Returns IGeometry<NormalBufferAttributes>

generateObject

Parameters

type: string

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

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

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Protected` _removeObject3DGenerators

`Protected` _sceneUpdate

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType

`Optional` geometry: IGeometry<NormalBufferAttributes>

`Optional` params: any

`Optional` setDirty

`Rest` ...args: any[]