worldwind-ui API / worldwind-kit / CameraController

Class: CameraController

Defined in: kit/src/camera.ts:51

Reads and drives the WorldWindow navigator, with animated goTo and change subscriptions.

Constructors

Constructor

new CameraController(worldWind, wwd): CameraController

Defined in: kit/src/camera.ts:56

Parameters

worldWind

WorldWindStatic

wwd

WWWorldWindow

Returns

CameraController

Methods

destroy()

destroy(): void

Defined in: kit/src/camera.ts:175

Returns

void

---

get()

get(): CameraState

Defined in: kit/src/camera.ts:82

Returns

CameraState

---

goTo()

goTo(target, options?): Promise<CameraState>

Defined in: kit/src/camera.ts:111

Flies to a location with WorldWind's GoToAnimator. Resolves with the final state when the animation completes, or shortly after duration if the user interrupts it.

Parameters

target

CameraTarget

options?

GoToOptions = {}

Returns

Promise<CameraState>

---

resetNorth()

resetNorth(): CameraState

Defined in: kit/src/camera.ts:160

Returns

CameraState

---

resetOrientation()

resetOrientation(): CameraState

Defined in: kit/src/camera.ts:165

Heading, tilt and roll back to zero; position and range unchanged.

Returns

CameraState

---

rotateBy()

rotateBy(deltaHeadingDegrees): CameraState

Defined in: kit/src/camera.ts:152

Parameters

deltaHeadingDegrees

number

Returns

CameraState

---

set()

set(target, options?): CameraState

Defined in: kit/src/camera.ts:95

Applies the given fields immediately and requests a redraw.

Parameters

target

Partial<CameraState>

options?

redraw?

boolean

Returns

CameraState

---

snapshot()

snapshot(): CameraState

Defined in: kit/src/camera.ts:76

Like get, but returns the same object instance for as long as the camera has not moved. Use it as an external-store snapshot (React's useSyncExternalStore, etc.).

Returns

CameraState

---

subscribe()

subscribe(listener): Unsubscribe

Defined in: kit/src/camera.ts:170

Notifies after any frame in which the camera changed (user gestures included).

Parameters

listener

(state) => void

Returns

Unsubscribe

---

tiltBy()

tiltBy(deltaTiltDegrees): CameraState

Defined in: kit/src/camera.ts:156

Parameters

deltaTiltDegrees

number

Returns

CameraState

---

zoomBy()

zoomBy(factor): CameraState

Defined in: kit/src/camera.ts:140

Parameters

factor

number

Returns

CameraState

---

zoomIn()

zoomIn(factor?): CameraState

Defined in: kit/src/camera.ts:144

Parameters

factor?

number = 0.5

Returns

CameraState

---

zoomOut()

zoomOut(factor?): CameraState

Defined in: kit/src/camera.ts:148

Parameters

factor?

number = 2

Returns

CameraState