Class: PointerLockControlsPlugin
Plugins.PointerLockControlsPlugin
Hierarchy
↳
PointerLockControlsPlugin
Properties
PluginType
▪ Static
Readonly
PluginType: "PointerLockControlsPlugin"
Defined in
webgi/src/plugins/PointerLockControlsPlugin.ts:6
enabled
• Readonly
enabled: true
Inherited from
Defined in
webgi/src/plugins/ACameraControlsPlugin.ts:6
toJSON
• toJSON: any
= undefined
Inherited from
Defined in
webgi/src/plugins/ACameraControlsPlugin.ts:7
controlsKey
• Readonly
controlsKey: "pointerLock"
Overrides
ACameraControlsPlugin.controlsKey
Defined in
webgi/src/plugins/PointerLockControlsPlugin.ts:7
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
_controlsCtor
• Protected
_controlsCtor: TControlsCtor
Overrides
ACameraControlsPlugin._controlsCtor
Defined in
webgi/src/plugins/PointerLockControlsPlugin.ts:9
Constructors
constructor
• new PointerLockControlsPlugin()
Inherited from
ACameraControlsPlugin.constructor
Defined in
webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Inherited from
ACameraControlsPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
ACameraControlsPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
Methods
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
ACameraControlsPlugin.onDispose
Defined in
webgi/src/core/AViewerPlugin.ts:36
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
Defined in
webgi/src/core/AViewerPlugin.ts:52
exportState
▸ exportState(): any
Returns
any
Inherited from
ACameraControlsPlugin.exportState
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
ACameraControlsPlugin.importState
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
ACameraControlsPlugin.storeState
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Inherited from
ACameraControlsPlugin.loadState
Defined in
webgi/src/core/AViewerPlugin.ts:84
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/plugins/ACameraControlsPlugin.ts:11
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
ACameraControlsPlugin.onRemove
Defined in
webgi/src/plugins/ACameraControlsPlugin.ts:17
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
ACameraControlsPlugin._storeKey