Geoportal Extension for Itowns API Reference

Class: GlobeViewExtended

Extended itowns.GlobeView.

new GlobeViewExtended()

Itowns/GlobeViewExtended.js, line 14

Extends

  • itowns.GlobeView

Members

constructor

Constructor (alias)

Methods

_getEventTarget(type){Object}

Itowns/GlobeViewExtended.js, line 204

Returns the target of a given event type

Name Type Description
type String

the event type. Can be any of EVENTS

Returns:
- The event target.

_initEventMap()

Itowns/GlobeViewExtended.js, line 73

intializes the evenements map

addLayer(layer){Promise}

Itowns/GlobeViewExtended.js, line 280

Overload itowns.GlobeView addLayer method

Name Type Description
layer Object

The itowns layer.

addLayerListener(layer, type, callback){Object}

Itowns/GlobeViewExtended.js, line 184

Associates a function to trigger when a layer event is received.

Name Type Description
layer Object

The itowns layer.

type String

the event type. Can be any of EVENTS.

callback function

The function to execute when the event occures.

Returns:
- The event key

addWidget(widget)

Itowns/GlobeViewExtended.js, line 522

Add a widget to the globe

Name Type Description
widget Object

The Widget object to add

forget(type)

Itowns/GlobeViewExtended.js, line 262

Cancels an event listening

Name Type Description
type Object

The event type.

forgetByKey(key)

Itowns/GlobeViewExtended.js, line 232

Cancels an event listening

Name Type Description
key Object

The event key.

freezeControl()

Itowns/GlobeViewExtended.js, line 134

Disables globe controls until the globe rendering is completed

getAzimuth(){Number}

Itowns/GlobeViewExtended.js, line 605

Returns azimuth

getCenter(){Object}

Itowns/GlobeViewExtended.js, line 685

Retuns the coordinates of the central point on screen in lat,lon and alt

getColorLayerById(layerId){Object}

Itowns/GlobeViewExtended.js, line 413

Get color layer by its id

Name Type Description
layerId String

Color layer id

Returns:
Object

getColorLayers(){Array}

Itowns/GlobeViewExtended.js, line 431

Get imagery layers

Returns:
layers

getCoordinateFromMouseEvent(mouseEvent){Coordinates}

Itowns/GlobeViewExtended.js, line 629

Gets the coordinate in lat,lon for a given mouse position.

Name Type Description
mouseEvent MouseEvent

A mouse event.

getCoordinateFromPixel(x, y){Coordinates}

Itowns/GlobeViewExtended.js, line 616

Gets the coordinate in lat,lon for a given pixel.

Name Type Description
x Number

The pixel x-position inside the Globe element.

y Number

The pixel y-position inside the Globe element.

getElevationLayers(){Array}

Itowns/GlobeViewExtended.js, line 457

Get elevation layers

Returns:
layers

getExtent(){Array}

Itowns/GlobeViewExtended.js, line 470

Get the current view extent

Returns:
view extent

getFeaturesAtMousePosition(mouseEvent){Array}

Itowns/GlobeViewExtended.js, line 640

Get all visible features that intersect a pixel

Name Type Description
mouseEvent MouseEvent

A mouse event.

Returns:
- The array of visible features.

getGlobeView()

Itowns/GlobeViewExtended.js, line 102

Get GlobeViex Object (parent)

getLayerById(layerId){Object}

Itowns/GlobeViewExtended.js, line 394

Get layer by its id

Name Type Description
layerId String

Layer id

Returns:
Object

getLayerEventInfos()

Itowns/GlobeViewExtended.js, line 750

To get the layer event infos

getRange(){Number}

Itowns/GlobeViewExtended.js, line 736

Returns the "range": the distance in meters between the camera and the current central point on the screen.

getScale(){Number}

Itowns/GlobeViewExtended.js, line 567

Returns current view scale

getTargetElement(){HTMLElement}

Itowns/GlobeViewExtended.js, line 558

Get html target element

Returns:
container element

getTilt(){Number}

Itowns/GlobeViewExtended.js, line 586

Returns tilt

getVectorLayers(){Array}

Itowns/GlobeViewExtended.js, line 444

Get vector layers

Returns:
layers

getWidgets(){Array}

Itowns/GlobeViewExtended.js, line 535

Returns all widgets.

Returns:
- The array of widgets.

getZoom(){Number}

Itowns/GlobeViewExtended.js, line 700

Returns the actual zoom.

isInitialized(){Boolean}

Itowns/GlobeViewExtended.js, line 112

Indicates if the globe is initialized or not

listen(type, callback){Object}

Itowns/GlobeViewExtended.js, line 151

Associates a function to trigger when an event is received.

Name Type Description
type String

the event type. Can be any of EVENTS

callback function

The function to execute when the event occures.

Returns:
- The event key

lookAt(target)

Itowns/GlobeViewExtended.js, line 782

Sets camera orientation to look at specified target

Name Type Description
target THREE.Vector3

Target position

metersToPixels(value){Number}

Itowns/GlobeViewExtended.js, line 728

Projection on screen in pixels of length in meter on globe

Name Type Description
value Number

Length in meter on globe

Returns:
in pixels on screen

moveLayerToIndex(layerId, index)

Itowns/GlobeViewExtended.js, line 322

Move layer to the specified index

Name Type Description
layerId String

Layer id

index Boolean

new index of the layer

moveTarget(){THREE.Vector3}

Itowns/GlobeViewExtended.js, line 743

notifyChange()

Itowns/GlobeViewExtended.js, line 789

Notifies the scene it needs to be updated

onCameraMoveStop(cb)

Itowns/GlobeViewExtended.js, line 122

Detects when the camera movement stops, then launch the callback given as parameter

Name Type Description
cb function

The function to execute when the event occures.

pixelsToMeters(pixels){Number}

Itowns/GlobeViewExtended.js, line 719

To convert the projection in meters on the globe of a number of pixels of screen

Name Type Description
pixels Number

count pixels to project

Returns:
in meters on globe

preRenderEventFetchColorLayersDisplayed()

Itowns/GlobeViewExtended.js, line 360

Defines if the list of the color layers displayed have to be computed on pre-render event

preRenderEventFetchElevationLayersDisplayed()

Itowns/GlobeViewExtended.js, line 370

Defines if the list of the elevation layers displayed have to be computed on pre-render event

preRenderEventFetchLayersDisplayed()

Itowns/GlobeViewExtended.js, line 380

Defines if the list of the layers of all types displayed have to be computed on pre-render event

preRenderEventFetchViewExtent()

Itowns/GlobeViewExtended.js, line 350

Defines if the current view extent have to be computed on pre-render event

removeEventListener(type, callback)

Itowns/GlobeViewExtended.js, line 333

Remove event listener from the globe

Name Type Description
type String

event type

callback Boolean

event handler

removeLayer()

Itowns/GlobeViewExtended.js, line 289

Overload itowns.GlobeView removeLayer method

removeLayerListener(layer, type, callback)

Itowns/GlobeViewExtended.js, line 248

Cancels an layer event listening

Name Type Description
layer Object

The itowns layer.

type String

the event type.

callback function

The function to execute when the event occures.

removeWidget(widget)

Itowns/GlobeViewExtended.js, line 544

Removes a widget.

Name Type Description
widget Object

The Widget object to remove

resize()

Itowns/GlobeViewExtended.js, line 796

Resizes itowns

setAzimuth(azimuth){Promise}

Itowns/GlobeViewExtended.js, line 596

Sets azimuth

Name Type Description
azimuth Number

Azimuth value

setBackground()

Itowns/GlobeViewExtended.js, line 762

Sets background (specific to miniglobe)

setCameraPosition(target, distance)

Itowns/GlobeViewExtended.js, line 774

Sets camera position

Name Type Description
target THREE.Vector3

Target position

distance Number

Distance from target

setCameraTargetGeoPosition(center){Promise}

Itowns/GlobeViewExtended.js, line 676

Changes the center of the scene on screen to the specified in lat, lon.

Name Type Description
center Object

Center object

Name Type Description
longitude Number

Coordinate longitude WGS84 in degree

latitude Number

Coordinate latitude WGS84 in degree

Returns:
promise that resolves when the next 'globe initilazed' event fires.

setLayerOpacity(layerId, opacityValue)

Itowns/GlobeViewExtended.js, line 300

Set layer opacity

Name Type Description
layerId String

Layer id

opacityValue Number

opacity value in [0 1]

setLayerVisibility(layerId, visible)

Itowns/GlobeViewExtended.js, line 311

Set layer visibility

Name Type Description
layerId String

Layer id

visible Boolean

New visibility of the layer

setTilt(tilt){Promise}

Itowns/GlobeViewExtended.js, line 577

Sets tilt

Name Type Description
tilt Number

Tilt value

setZoom(zoom){Promise}

Itowns/GlobeViewExtended.js, line 710

Sets the current zoom.

Name Type Description
zoom Number

The zoom