Navigation

Extends: Control

Source: Navigation.ts:113

Navigation.

Fires

  • event:drag
  • event:zoom
  • event:rotate

Constructor

new Navigation(options?: INavigationParams): Navigation

Parameters

  • options (INavigationParams, optional) — Navigation options:
    • options.mode (NavigationMode, optional) — Navigation mode: "north" (keeps north fixed), "adaptive" (default, auto-detects arc mode), "free" (arc rotation mode)
    • options.inertia (number, optional) — inertia factor
    • options.minInertia (number, optional) — inertia factor at minInertiaAltitude. Default is 1
    • options.maxInertia (number, optional) — inertia factor at maximal camera altitude. Default is 1.1
    • options.minInertiaAltitude (number, optional) — minimal altitude where inertia interpolation starts. Default is 3000000
    • options.velInertia (number, optional) — base velocity inertia factor. Default is 0.89
    • options.dragInertia (number, optional) — drag inertia
    • options.mass (number, optional) — camera mass, affects velocity. Default is 1
    • options.minSlope (number, optional) — minimal slope for vertical camera movement. Default is 0.35
    • options.poleThreshold (number, optional) — Vertical rotation is reduced when camera is close to poles
    • options.disableRotation (boolean, optional) — Disables horizontal rotation controls (right mouse button and touchpad). Default is false
    • options.disableTilt (boolean, optional) — Disables vertical tilt controls (right mouse button and touchpad). Default is false

Instance Methods

isMoving(): boolean

Returns true while the inertia has not been damped yet.

Returns

  • boolean

oninit()

Inherited from Control#oninit

Overrides: Control#oninit

Control initialization function have to be overridden.

onadd()

Inherited from Control#onadd

Overrides: Control#onadd

Control renderer assigning function have to be overridden.

onremove()

Inherited from Control#onremove

Overrides: Control#onremove

Control remove function have to be overridden.

onactivate()

Inherited from Control#onactivate

Overrides: Control#onactivate

Control activation function have to be overridden.

ondeactivate()

Inherited from Control#ondeactivate

Overrides: Control#ondeactivate

Control deactivation function have to be overriden.

addTo()

Inherited from Control#addTo

Overrides: Control#addTo

Assign renderer to the control.

remove()

Inherited from Control#remove

Overrides: Control#remove

Removes control.

activate()

Inherited from Control#activate

Overrides: Control#activate

Activate control.

deactivate()

Inherited from Control#deactivate

Overrides: Control#deactivate

Deactivate control.

isActive()

Inherited from Control#isActive

Overrides: Control#isActive

Is control active.

Instance Fields

name

Inherited from Control#name

Overrides: Control#name

Returns control name.

Returns

  • string