Documentation

---

Class: FlyControllerExtension

Fly controller extension for camera. Provides walk/fly movement and rotation actions.

Extends

• ControllerExtensionBase

Constructors

Constructor

new FlyControllerExtension(viewerName, options): FlyControllerExtension

Parameters

viewerName

string

Owner viewer name for extension.

options

FlyExtensionOptions

extension options.

Returns

FlyControllerExtension

Overrides

ControllerExtensionBase.constructor

Properties

controllerDesc

readonly controllerDesc: string

Controller description or name.

Inherited from

ControllerExtensionBase.controllerDesc

---

controllerIcon

readonly controllerIcon: string

Controller icon name. Icon name will be used by viewer Toolbar UI component for displaying mode buttons.

Inherited from

ControllerExtensionBase.controllerIcon

---

getName()

getName: () => string

Get unique extension name.

Returns

string

Inherited from

ControllerExtensionBase.getName

---

helpDesc

readonly helpDesc: string

Optional description for placing on HelpToolbar.

Inherited from

ControllerExtensionBase.helpDesc

---

helpIcon

readonly helpIcon: string

Optional icon for placing on HelpToolbar.

Inherited from

ControllerExtensionBase.helpIcon

---

hideToolbar

hideToolbar: boolean

Is extension need to hide toolbar or not.

Inherited from

ControllerExtensionBase.hideToolbar

---

isUpdated

isUpdated: boolean

Is controller updated or not.

Inherited from

ControllerExtensionBase.isUpdated

---

maxPolarAngle

maxPolarAngle: number

How far you can orbit vertically, upper and lower in radians(range is 0 to Math.PI radians).

---

minPolarAngle

minPolarAngle: number

How near you can orbit vertically, upper and lower in radians(range is 0 to Math.PI radians).

---

pointerSpeed

pointerSpeed: number

Speed of camera movement.

---

state

state: any

Any extension data which can be stored in browser local storage and restored after (any extension settings, buttons state and so one). State will be saved in local storage with 'tangl-ext-extensionName' key.

Inherited from

ControllerExtensionBase.state

---

type

readonly type: string

Extension type (ext, mode, control)

Inherited from

ControllerExtensionBase.type

---

viewerName

readonly viewerName: string

Owner viewer name.

Inherited from

ControllerExtensionBase.viewerName

---

getName()

static getName: () => string

Get unique extension name.

Returns

string

Overrides

ControllerExtensionBase.getName

Methods

getRenderManager()

getRenderManager(): RenderManager

Get current RenderManager instance.

Returns

RenderManager

Inherited from

ControllerExtensionBase.getRenderManager

---

getTargetClone()

getTargetClone(): Vector3

Get camera target point clone.

Returns

Vector3

Overrides

ControllerExtensionBase.getTargetClone

---

restoreState()

restoreState(): Promise<void>

Restore extension state from the local storage.

Returns

Promise<void>

Inherited from

ControllerExtensionBase.restoreState

---

saveState()

saveState(): Promise<void>

Save extension state in the local storage.

Returns

Promise<void>

Inherited from

ControllerExtensionBase.saveState

---

setMouseButtonsActions()

setMouseButtonsActions(left, right, middle): void

Sets mouse button bindings for controller actions.

Parameters

left

MOUSE

Left button binding.

right

MOUSE

Right button binding.

middle

MOUSE

Middle button binding.

Returns

void

---

setRestoreStateHandler()

setRestoreStateHandler(handler): this

Sets external hook handler for restoring extension state in the local storage.

Parameters

handler

(stateName, state) => Promise<any>

handler hook function.

Returns

this

Inherited from

ControllerExtensionBase.setRestoreStateHandler

---

setSaveStateHandler()

setSaveStateHandler(handler): this

Sets external hook handler for storing extension state in the local storage.

Parameters

handler

(stateName, state) => void

handler hook function.

Returns

this

Inherited from

ControllerExtensionBase.setSaveStateHandler

Hooks

added()

added(): void

Hook when extension is added to ExtensionManager. Called by ExtensionManager.addExtension().

Returns

void

Overrides

ControllerExtensionBase.added

---

cameraModeChanged()

cameraModeChanged(perspective): boolean

Hook when RenderManager wants change camera mode. Called by ThreeManager.animate().

Parameters

perspective

boolean

camera mode state for applying (perspective or orthogonal).

Returns

boolean

Allow RenderManager change camera mode or not.

Overrides

ControllerExtensionBase.cameraModeChanged

---

commandChanged()

commandChanged(newCommand): void

Hook when current extension command is changed or finished. Called by ExtensionManager.setCurrentCommandExtension().

Parameters

newCommand

ExtensionBase

Returns

void

Inherited from

ControllerExtensionBase.commandChanged

---

dedicatedToolbarRender()

dedicatedToolbarRender(container): void

Render function for rendering dedicated toolbar content.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ControllerExtensionBase.dedicatedToolbarRender

---

deleted()

deleted(): void

Hook when extension is deleted from ExtensionManager. Called by ExtensionManager.clear().

Returns

void

Overrides

ControllerExtensionBase.deleted

---

selected()

selected(): void

Hook when extension is activated (selected as current controller). Called by ExtensionManager.selectControllerExtension().

Returns

void

Overrides

ControllerExtensionBase.selected

---

sharedToolbarRender()

sharedToolbarRender(container): void

Render function for rendering shared toolbar content.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ControllerExtensionBase.sharedToolbarRender

---

uiRender()

uiRender(container): void

Render function for rendering additional UI above viewer canvas.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ControllerExtensionBase.uiRender

---

unselected()

unselected(): void

Hook when extension is deactivated. Called by ExtensionManager.selectControllerExtension()

Returns

void

Overrides

ControllerExtensionBase.unselected

---

updated()

updated(delta): void

Hook when controller extension needs updating and transforming camera for next renderer frame. Called by ThreeManager.animate().

Parameters

delta

number

Time delta between last frame and new frame.

Returns

void

Overrides

ControllerExtensionBase.updated