Class GlobeControls

Camera controls for a entities.Globe. Internally, this wraps 3d-tiles-renderer's own GlobeControls.

Hierarchy

EventDispatcher<GlobeControlsEvents>
- GlobeControls

Index

Constructors

Accessors

dampingFactor enabled enableDamping maxDistance maxZoom minAltitude minDistance minZoom zoomSpeed

Methods

attach detach dispose resetState update

Constructors

constructor

new GlobeControls(params: GlobeControlsOptions): GlobeControls
Parameters
- params: GlobeControlsOptions
Returns GlobeControls
Overrides EventDispatcher<GlobeControlsEvents>.constructor
- Defined in controls/GlobeControls.ts:80

Accessors

dampingFactor

get dampingFactor(): number
Returns number
- Defined in controls/GlobeControls.ts:133
set dampingFactor(v: number): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:137

enabled

get enabled(): boolean
Returns boolean
- Defined in controls/GlobeControls.ts:117
set enabled(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in controls/GlobeControls.ts:121

enableDamping

get enableDamping(): boolean
Returns boolean
- Defined in controls/GlobeControls.ts:125
set enableDamping(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in controls/GlobeControls.ts:129

maxDistance

get maxDistance(): number
The maximal distance to the ellipsoid surface allowed for the controls.

Returns number
Default Value
```
infinity
```
- Defined in controls/GlobeControls.ts:177
set maxDistance(v: number): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:181

maxZoom

get maxZoom(): number
The maximum zoom value (orthographic cameras only).

Returns number
- Defined in controls/GlobeControls.ts:188
set maxZoom(v: number): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:192

minAltitude

get minAltitude(): number
Returns number
- Defined in controls/GlobeControls.ts:141
set minAltitude(v: number): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:145

minDistance

get minDistance(): number
The minimal distance to the ellipsoid surface allowed for the controls.

Returns number
Default Value
```
0 (the ellipsoid surface)
```
- Defined in controls/GlobeControls.ts:165
set minDistance(v: number): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:169

minZoom

get minZoom(): number
The minimum zoom value (orthographic cameras only).

Returns number
- Defined in controls/GlobeControls.ts:199
set minZoom(v: number): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:203

zoomSpeed

get zoomSpeed(): number
The zoom speed.

Returns number
Default Value
```
1
```
- Defined in controls/GlobeControls.ts:153
set zoomSpeed(v: number): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:157

Methods

attach

attach(): void
Attaches event listeners to the DOM element. If the event listeners are already attached, this will throw an error.

Returns void
- Defined in controls/GlobeControls.ts:223

detach

detach(): void
Detaches event listeners from the DOM element.

Returns void
- Defined in controls/GlobeControls.ts:230

dispose

dispose(): void
Returns void
- Defined in controls/GlobeControls.ts:234

resetState

resetState(): void
Returns void
- Defined in controls/GlobeControls.ts:240

update

update(deltaTime?: number): void
Parameters
- OptionaldeltaTime: number
Returns void
- Defined in controls/GlobeControls.ts:207