Class EnvironmentControlsPlugin

Hierarchy

ACameraControlsPlugin
- EnvironmentControlsPlugin

Index

Constructors

Constructors

constructor

new EnvironmentControlsPlugin(): EnvironmentControlsPlugin
Creates THREE.EventDispatcher | EventDispatcher object.

Returns EnvironmentControlsPlugin
Inherited from ACameraControlsPlugin.constructor
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:55

Properties

`Protected`_controlsCtor

_controlsCtor: TControlsCtor = ...

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Readonly`controlsKey

controlsKey: "environment" = 'environment'

`Readonly`enabled

enabled: true

isViewerPluginSync

isViewerPluginSync: true = ...

toJSON

toJSON: any = undefined

`Optional`uiConfig

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "EnvironmentControlsPlugin" = 'EnvironmentControlsPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from ACameraControlsPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ACameraControlsPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

dispose

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from ACameraControlsPlugin.onAdded
- Defined in src/plugins/base/ACameraControlsPlugin.ts:11

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from ACameraControlsPlugin.onRemove
- Defined in src/plugins/base/ACameraControlsPlugin.ts:18

`Optional`setDirty

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

Class EnvironmentControlsPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns EnvironmentControlsPlugin

Properties

Protected_controlsCtor

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

ReadonlycontrolsKey

Readonlyenabled

isViewerPluginSync

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

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | EnvironmentControlsPlugin | Promise<null | EnvironmentControlsPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

Settings

On This Page

`Protected`_controlsCtor

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`controlsKey

`Readonly`enabled

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty