Class GeometryGeneratorPlugin

GeometryGeneratorPlugin

Geometry generator plugin to create updatable parametric objects/geometries. Built-in generators: plane, sphere, box, circle, torus, cylinder, tube, shape, tubeShape, line.

Additional generators (text) can be registered at runtime via the generators property or by using GeometryGeneratorExtrasPlugin from @threepipe/plugin-geometry-generator.

Hierarchy (View Summary)

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

Properties

`Protected`_dirty

_dirty: boolean = false

defaultMaterialClass

defaultMaterialClass: Class<IMaterial<IMaterialEventMap>> = PhysicalMaterial

defaultMeshClass

defaultMeshClass: Class<
    IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
> = Mesh2

enabled

enabled: boolean = true

generators

generators: IGeometryGeneratorMap = ...

isViewerPluginSync

isViewerPluginSync: true = ...

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

Methods

`Protected`_geometryUpdate

_geometryUpdate(
    e: { bubbleToParent: boolean; geometry: IGeometry; object: IObject3D } & AnyOptions & {
        bubbleToObject?: boolean;
    },
): void
Parameters
- e: { bubbleToParent: boolean; geometry: IGeometry; object: IObject3D } & AnyOptions & {
  bubbleToObject?: boolean;
  }
Returns void
- Defined in src/plugins/geometry/GeometryGeneratorPlugin.ts:161

`Protected`_onViewerEvent

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

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._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 AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.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 AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.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 AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

generateGeometry

generateGeometry(
    type: string,
    params: any,
    geometry?: IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
):
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
    | BufferGeometry2<NormalBufferAttributes, BufferGeometryEventMap>
Parameters
- type: string
- params: any
- Optionalgeometry: IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
Returns
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
| BufferGeometry2<NormalBufferAttributes, BufferGeometryEventMap>
- Defined in src/plugins/geometry/GeometryGeneratorPlugin.ts:97

generateObject

generateObject<
    T extends string = string,
    TGeometry extends
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap> = IGeometry<
        NormalBufferAttributes,
        BufferGeometryEventMap,
    >,
    TMaterial extends
        IMaterial<IMaterialEventMap> = IMaterial<IMaterialEventMap>,
    TG extends AGeometryGenerator<any, string> = IGeometryGeneratorMap[T],
>(
    type: T,
    __namedParameters?: Partial<TG["defaultParams"]> & {
        geometry?: TGeometry;
        material?: TMaterial;
        mesh?: IMesh<IObject3DEventMap, TGeometry, TMaterial>;
    },
): IMesh<IObject3DEventMap, TGeometry, TMaterial>
Type Parameters
- T extends string = string
- TGeometry extends IGeometry<NormalBufferAttributes, BufferGeometryEventMap> = IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
- TMaterial extends IMaterial<IMaterialEventMap> = IMaterial<IMaterialEventMap>
- TG extends AGeometryGenerator<any, string> = IGeometryGeneratorMap[T]
Parameters
- type: T
- __namedParameters: Partial<TG["defaultParams"]> & {
      geometry?: TGeometry;
      material?: TMaterial;
      mesh?: IMesh<IObject3DEventMap, TGeometry, TMaterial>;
  } = {}
Returns IMesh<IObject3DEventMap, TGeometry, TMaterial>
- Defined in src/plugins/geometry/GeometryGeneratorPlugin.ts:70

importState

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

isDisabled

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

onAdded

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

onRemove

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

`Optional`setDirty

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

updateGeometry

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

Class GeometryGeneratorPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GeometryGeneratorPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

defaultGeometryClass

defaultMaterialClass

defaultMeshClass

enabled

generators

isViewerPluginSync

toJSON

uiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_geometryUpdate

Parameters

Returns void

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>

generateGeometry

Parameters

Returns | IGeometry<NormalBufferAttributes, BufferGeometryEventMap> | BufferGeometry2<NormalBufferAttributes, BufferGeometryEventMap>

generateObject

Type Parameters

Parameters

Returns IMesh<IObject3DEventMap, TGeometry, TMaterial>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

updateGeometry

Parameters

Returns void

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_geometryUpdate

`Protected`_onViewerEvent

`Protected`_storeKey

Returns
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
| BufferGeometry2<NormalBufferAttributes, BufferGeometryEventMap>

`Optional`setDirty