Class Object3DGeneratorPlugin

Adds support for generating different types of lights and camera objects in the viewer.

Hierarchy (view full)

AViewerPluginSync<"">
- Object3DGeneratorPlugin

Index

Constructors

constructor

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

Properties

`Protected` _dirty

_dirty: boolean = false

`Protected` _selectedType

_selectedType: string = ''

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

generators

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

Type declaration

- (params?): IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
- Parameters
  - Optional params: any
  Returns IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

toJSON

toJSON: any = undefined

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "Object3DGeneratorPlugin" = 'Object3DGeneratorPlugin'

Accessors

dirty

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

Methods

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

disable

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

dispose

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

enable

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

exportState

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

fromJSON

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

generate

generate(type?, params?, addToScene?): IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Parameters
- Optional type: string
- Optional params: any
- addToScene: boolean = true
Returns IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
- Defined in src/plugins/extras/Object3DGeneratorPlugin.ts:31

importState

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

isDisabled

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

onAdded

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

onRemove

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

`Optional` setDirty

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

Class Object3DGeneratorPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Object3DGeneratorPlugin

Properties

Protected _dirty

Protected _selectedType

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

enabled

generators

Type declaration

Parameters

Optional params: any

Returns IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

toJSON

Optional uiConfig

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

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 | Object3DGeneratorPlugin | Promise<null | Object3DGeneratorPlugin>

generate

Parameters

Optional type: string

Optional params: any

addToScene: boolean = true

Returns IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

importState

Parameters

state: any

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

viewer: ThreeViewer

Returns void

onRemove

Parameters

viewer: ThreeViewer

`Protected` _dirty

`Protected` _selectedType

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` params: any

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType

`Optional` type: string

`Optional` params: any

`Optional` setDirty

`Rest` ...args: any[]