Class PointerLockControlsPlugin

Base Class for Sync Viewer Plugins

Hierarchy (View Summary)

ACameraControlsPlugin
- PointerLockControlsPlugin

Index

Constructors

Properties

_controlsCtor _dirty _viewer? _viewerListeners constructor controlsKey enabled toJSON uiConfig? OldPluginType? PluginType

Accessors

Methods

_onViewerEvent _storeKey disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove setDirty?

Constructors

constructor

new PointerLockControlsPlugin(): PointerLockControlsPlugin
Creates EventDispatcher object.

Returns PointerLockControlsPlugin
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: "pointerLock" = 'pointerLock'

`Readonly`enabled

enabled: true

toJSON

toJSON: any = undefined

`Optional`uiConfig

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "PointerLockControlsPlugin" = 'PointerLockControlsPlugin'

Accessors

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

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

dispose

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

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