Class PointerLockControlsPlugin

Base Class for Sync Viewer Plugins

Hierarchy (view full)

ACameraControlsPlugin
- PointerLockControlsPlugin

Index

Constructors

constructor

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

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

Properties

`Protected` _controlsCtor

_controlsCtor: TControlsCtor = ...

`Protected` _dirty

_dirty: boolean = false

`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

`Readonly` controlsKey

controlsKey: "pointerLock" = 'pointerLock'

`Readonly` enabled

enabled: true = true

toJSON

toJSON: any = undefined

`Optional` uiConfig

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

`Static` `Readonly` PluginType

PluginType: "PointerLockControlsPlugin" = 'PointerLockControlsPlugin'

Accessors

dirty

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

Methods

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

disable

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

dispose

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

enable

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

`Optional` setDirty

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

Class PointerLockControlsPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PointerLockControlsPlugin

Properties

Protected _controlsCtor

Protected _dirty

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

Readonly controlsKey

Readonly enabled

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

importState

Parameters

state: any

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

viewer: ThreeViewer

Returns void

onRemove

Parameters

viewer: ThreeViewer

Returns void

Optional setDirty

Parameters

Rest ...args: any[]

Returns any

Settings

Member Visibility

Theme

On This Page

`Protected` _controlsCtor

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Readonly` controlsKey

`Readonly` enabled

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: SerializationMetaType

`Optional` setDirty

`Rest` ...args: any[]