Class: PointerLockControlsPlugin

Plugins.PointerLockControlsPlugin

Hierarchy

• ACameraControlsPlugin

  ↳ PointerLockControlsPlugin

Properties

PluginType

▪ Static Readonly PluginType: "PointerLockControlsPlugin"

---

enabled

• Readonly enabled: true

Inherited from

ACameraControlsPlugin.enabled

---

toJSON

• toJSON: any = undefined

Inherited from

ACameraControlsPlugin.toJSON

---

controlsKey

• Readonly controlsKey: "pointerLock"

Overrides

ACameraControlsPlugin.controlsKey

---

_dirty

• Protected _dirty: boolean = false

Inherited from

ACameraControlsPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

ACameraControlsPlugin._viewer

---

_controlsCtor

• Protected _controlsCtor: TControlsCtor

Overrides

ACameraControlsPlugin._controlsCtor

Constructors

constructor

• new PointerLockControlsPlugin()

Inherited from

ACameraControlsPlugin.constructor

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

ACameraControlsPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

ACameraControlsPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

ACameraControlsPlugin.viewer

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.onDispose

---

fromJSON

▸ fromJSON(data, meta?): null | PointerLockControlsPlugin | Promise<null | PointerLockControlsPlugin>

Parameters

Name	Type
data	any
meta?	any

Returns

null | PointerLockControlsPlugin | Promise<null | PointerLockControlsPlugin>

Inherited from

ACameraControlsPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

ACameraControlsPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.importState

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

ACameraControlsPlugin.storeState

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.loadState

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.onRemove

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

ACameraControlsPlugin._storeKey