Class GlobeControls

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

Hierarchy (view full)

EventDispatcher<GlobeControlsEvents>
- GlobeControls

Index

Constructors

constructor

new GlobeControls(params): GlobeControls
Parameters
- params: GlobeControlsOptions
Returns GlobeControls
Overrides EventDispatcher.constructor
- Defined in controls/GlobeControls.ts:108

Accessors

dampingFactor

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

enabled

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

enableDamping

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

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:211
set maxDistance(v): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:215

maxZoom

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

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

minAltitude

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

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:199
set minDistance(v): void
Parameters
- v: number
Returns void
- Defined in controls/GlobeControls.ts:203

minZoom

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

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

zoomSpeed

get zoomSpeed(): number
The zoom speed.

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

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof GlobeControlsEvents
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<GlobeControlsEvents[T], T, GlobeControls>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52

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:257

detach

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

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

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof GlobeControlsEvents
Parameters
- event: BaseEvent<T> & GlobeControlsEvents[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

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

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof GlobeControlsEvents
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<GlobeControlsEvents[T], T, GlobeControls>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:62

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof GlobeControlsEvents
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<GlobeControlsEvents[T], T, GlobeControls>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:72

resetState

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

update

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

Class GlobeControls

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns GlobeControls

Accessors

dampingFactor

Returns number

Parameters

Returns void

enabled

Returns boolean

Parameters

Returns void

enableDamping

Returns boolean

Parameters

Returns void

maxDistance

Returns number

Default Value

Parameters

Returns void

maxZoom

Returns number

Parameters

Returns void

minAltitude

Returns number

Parameters

Returns void

minDistance

Returns number

Default Value

Parameters

Returns void

minZoom

Returns number

Parameters

Returns void

zoomSpeed

Returns number

Default Value

Parameters

Returns void

Methods

addEventListener

Type Parameters

Parameters

Returns void

attach

Returns void

detach

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

resetState

Returns void

update

Parameters

Returns void

Settings

On This Page