Class Object3DGeneratorPlugin

Adds support for generating different types of lights and camera objects in the viewer, along with UI to do so.

Custom generators can be added for more object types, check GeometryGeneratorPlugin for reference.

Hierarchy (View Summary)

AViewerPluginSync
- Object3DGeneratorPlugin

Constructors

constructor

new Object3DGeneratorPlugin(): Object3DGeneratorPlugin
Returns Object3DGeneratorPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/extras/Object3DGeneratorPlugin.ts:169

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_selectedType

_selectedType: string = ''

enabled

enabled: boolean = true

generators

generators: Record<string, (params?: any) => IObject3D> = ...

toJSON

toJSON: any = undefined

`Optional`uiConfig

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "Object3DGeneratorPlugin" = 'Object3DGeneratorPlugin'

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`_storeKey

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

addObject3DGenerator

addObject3DGenerator(
    key: string,
    generator: (params: any) => IObject3D,
    refresh?: boolean,
): void
Parameters
- key: string
- generator: (params: any) => IObject3D
- refresh: boolean = true
Returns void
- Defined in src/plugins/extras/Object3DGeneratorPlugin.ts:194

addObject3DGenerators

addObject3DGenerators(
    prefix: string,
    generators: Record<string, (params: any) => IObject3D>,
    refresh?: boolean,
): void
Parameters
- prefix: string
- generators: Record<string, (params: any) => IObject3D>
- refresh: boolean = true
Returns void
- Defined in src/plugins/extras/Object3DGeneratorPlugin.ts:187

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

dispose

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

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: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 | Object3DGeneratorPlugin | Promise<null | Object3DGeneratorPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | Object3DGeneratorPlugin | Promise<null | Object3DGeneratorPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:46

generate

generate(
    type?: string,
    params?: any,
    addToScene?: boolean,
    select?: boolean,
): IObject3D<
    IObject3DEventMap,
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>
Parameters
- Optionaltype: string
- Optionalparams: any
- addToScene: boolean = true
- select: boolean = true
Returns IObject3D<
    IObject3DEventMap,
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>
- Defined in src/plugins/extras/Object3DGeneratorPlugin.ts:35

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(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onAdded
- Defined in src/viewer/AViewerPlugin.ts:146

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onRemove
- Defined in src/viewer/AViewerPlugin.ts:150

removeObject3DGenerator

removeObject3DGenerator(key: string, refresh?: boolean): Object3DGeneratorPlugin
Parameters
- key: string
- refresh: boolean = true
Returns Object3DGeneratorPlugin
- Defined in src/plugins/extras/Object3DGeneratorPlugin.ts:181

removeObject3DGenerators

removeObject3DGenerators(
prefix: string,
refresh?: boolean,
): Object3DGeneratorPlugin
Parameters
- prefix: string
- refresh: boolean = true
Returns Object3DGeneratorPlugin
- Defined in src/plugins/extras/Object3DGeneratorPlugin.ts:174

`Optional`setDirty

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

Class Object3DGeneratorPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Object3DGeneratorPlugin

Properties

Protected_dirty

Protected_selectedType

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

generators

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

addObject3DGenerator

Parameters

Returns void

addObject3DGenerators

Parameters

Returns void

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | Object3DGeneratorPlugin | Promise<null | Object3DGeneratorPlugin>

generate

Parameters

Returns IObject3D< IObject3DEventMap, undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>, undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

removeObject3DGenerator

Parameters

Returns Object3DGeneratorPlugin

removeObject3DGenerators

Parameters

Returns Object3DGeneratorPlugin

OptionalsetDirty

Parameters

Returns any

Settings

On This Page

`Protected`_dirty

`Protected`_selectedType

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

Returns IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>

`Optional`setDirty