Skip to main content

Class: FirstPersonControlsPlugin

Plugins.FirstPersonControlsPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "FirstPersonControlsPlugin"

Defined in

webgi/src/plugins/FirstPersonControlsPlugin.ts:6


enabled

Readonly enabled: true

Inherited from

ACameraControlsPlugin.enabled

Defined in

webgi/src/plugins/ACameraControlsPlugin.ts:6


toJSON

toJSON: any = undefined

Inherited from

ACameraControlsPlugin.toJSON

Defined in

webgi/src/plugins/ACameraControlsPlugin.ts:7


controlsKey

Readonly controlsKey: "firstPerson"

Overrides

ACameraControlsPlugin.controlsKey

Defined in

webgi/src/plugins/FirstPersonControlsPlugin.ts:7


_dirty

Protected _dirty: boolean = false

Inherited from

ACameraControlsPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

ACameraControlsPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


_controlsCtor

Protected _controlsCtor: TControlsCtor

Overrides

ACameraControlsPlugin._controlsCtor

Defined in

webgi/src/plugins/FirstPersonControlsPlugin.ts:9

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

ACameraControlsPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

ACameraControlsPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | FirstPersonControlsPlugin | Promise<null | FirstPersonControlsPlugin>

Inherited from

ACameraControlsPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:54


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

ACameraControlsPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Inherited from

ACameraControlsPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

ACameraControlsPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

ACameraControlsPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.onAdded

Defined in

webgi/src/plugins/ACameraControlsPlugin.ts:11


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

ACameraControlsPlugin.onRemove

Defined in

webgi/src/plugins/ACameraControlsPlugin.ts:17

Constructors

constructor

new FirstPersonControlsPlugin()

Inherited from

ACameraControlsPlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39