Skip to content

worldwind-ui API / react-worldwind / UseCameraResult

Interface: UseCameraResult ​

Defined in: react/src/hooks.ts:78

Properties ​

controller ​

controller: CameraController

Defined in: react/src/hooks.ts:80


goTo ​

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

Defined in: react/src/hooks.ts:82

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: react/src/hooks.ts:88

Returns ​

CameraState


resetOrientation ​

resetOrientation: () => CameraState

Defined in: react/src/hooks.ts:89

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

Returns ​

CameraState


rotateBy ​

rotateBy: (deltaHeadingDegrees) => CameraState

Defined in: react/src/hooks.ts:86

Parameters ​

deltaHeadingDegrees ​

number

Returns ​

CameraState


set ​

set: (target, options) => CameraState

Defined in: react/src/hooks.ts:81

Applies the given fields immediately and requests a redraw.

Parameters ​

target ​

Partial<CameraState>

options? ​
redraw? ​

boolean

Returns ​

CameraState


state ​

state: CameraState

Defined in: react/src/hooks.ts:79


tiltBy ​

tiltBy: (deltaTiltDegrees) => CameraState

Defined in: react/src/hooks.ts:87

Parameters ​

deltaTiltDegrees ​

number

Returns ​

CameraState


zoomBy ​

zoomBy: (factor) => CameraState

Defined in: react/src/hooks.ts:83

Parameters ​

factor ​

number

Returns ​

CameraState


zoomIn ​

zoomIn: (factor) => CameraState

Defined in: react/src/hooks.ts:84

Parameters ​

factor? ​

number = 0.5

Returns ​

CameraState


zoomOut ​

zoomOut: (factor) => CameraState

Defined in: react/src/hooks.ts:85

Parameters ​

factor? ​

number = 2

Returns ​

CameraState

MIT licensed. Not affiliated with NASA; WorldWind is NASA's open-source virtual globe.