flywave-mapview

Home > @flywave/flywave-mapview

flywave-mapview package

Functionality needed to render a map.

Remarks

This module provides all the functionality needed to display a map, including: - Map view management (MapView) - Data source handling (DataSource) - Camera utilities (CameraUtils) - Clipping planes evaluation (ClipPlanesEvaluator) - Text rendering capabilities - Map anchors for overlaying objects - Picking and interaction handling - Theme management - Tile management and rendering

Classes

Class	Description
AnimatedExtrusionHandler	Handles animated extrusion effect of the buildings in MapView.
BackgroundDataSource	Provides background geometry for all tiles.
BufferedGeometryLineAccessor	Accessor for nonindexed line geometry.
BufferedGeometryObject3dAccessor	Accessor for nonindexed unspecified (Object3D) geometry.
CameraMovementDetector	The CameraMovementDetector class checks for changes in camera position and orientation, to detect continuous movements without the animation mode activated in MapView. If the interaction is not continuous enough, you can use a throttling timer to reduce the number of callbacks.
ColorCache	Use ColorCache to reuse a color specified by name and save allocation as well as setup time. Implemented as a singleton. Do not modify colors after getting them from the ColorCache.
ConcurrentDecoderFacade	Default concurrent decoder helper. A convenient singleton that maintains a separate [[ConcurrentWorkerSet]] for each bundle requested. Provides easy access to WorkerBasedDecoders for data sources.
ConcurrentTilerFacade	Default concurrent tiler helper. A convenient singleton that maintains a separate [[ConcurrentWorkerSet]] for each bundle requested. Provides easy access to WorkerBasedTilers for data sources.
CopyrightElementHandler	Helper class that maintains up-to-date MapView copyright information in DOM element.
EventDispatcher
FixedClipPlanesEvaluator	Provides the most basic evaluation concept giving fixed values with some constraints.
FrameStatsArray	Only exported for testing.
ImageItem	ImageItem is used to identify an image in the .
IndexedBufferedGeometryLineAccessor	Accessor for lines in an indexed geometry.
MapAnchors	Container holding [[MapAnchor]] objects.
MapRenderingManager
MapView	The core class of the library to call in order to create a map visualization. It needs to be linked to datasources.
MapViewAtmosphere	Class that provides MapView's atmospheric scattering effect.
MapViewEnvironment	Class handling the Scene Environment, like fog, sky, background datasource, clearColor etc for MapView
MapViewFog	Manages the fog display in MapView.
MapViewImageCache	Cache images wrapped into ImageItems for a MapView.
MapViewThemeManager	Class handling theme updates for MapView
Pass	The base class to extend for further passes in MapView, like the ,
PoiManager	POI manager class, responsible for loading the objects from the , and preparing them for rendering.
PoiTable	The PoiTable stores individual information for each POI type.
PoiTableManager	The PoiTableManager manages the list of [[PoiTables]] that can be defined in the sfile.
PolarTileDataSource	DataSource providing geometry for poles
RingBuffer	A simple ring buffer to store the last n values of the timer. The buffer works on a First-In-First-Out (FIFO) basis.
TextElementsRenderer	Internal class to manage all text rendering.
TextStyleCache
TextureLoader	A texture loader that supports request headers(e.g. for Authorization)
ThemeLoader	Loads and validates a theme from URL objects.
Tile	The class that holds the tiled data for a DataSource.
TileDataAccessor	An accessor for all geometries in a tile.
TileKeyEntry	Represents a unique TileKey and the area it takes up on screen. Note, in certain tiling projections, it is possible to have an offset, which represents a tile which has fully wrapped around, hence this defaults to 0 to simplify usage for projections which don't require it.
TiltViewClipPlanesEvaluator	Evaluates camera clipping planes taking into account ground distance and camera tilt (pitch) angle (angle between look-at vector and ground surface normal).
TopViewClipPlanesEvaluator	Top view, clip planes evaluator that computes view ranges based on ground distance and elevation.
UrlCopyrightProvider	Copyright provider which retrieves copyright coverage information from provided URL.
VisibleTileSet	Manages visible Tiles for MapView. Responsible for election of rendered tiles: - quad-tree traversal - frustum culling - sorting tiles by relevance (visible area) to prioritize load - limiting number of visible tiles - caching tiles - searching cache to replace visible but yet empty tiles with already loaded siblings in nearby zoom levels
WorkerBasedDecoder	Decoder based on [[ConcurrentWorkerSet]]. Decodes tiles using workers running in separate contexts (also known as WebWorkers): - connection establishment, - sends decode requests, - configuration.
WorkerBasedTiler	Tiler based on [[ConcurrentWorkerSet]]. Tiles payloads using workers running in separate contexts (also known as WebWorkers): - connection establishment, - sends tile requests, - configuration.
WorkerLoader	Set of Worker loading and initialization helpers: - starting Worker from URL with fallback to XHR+blob WorkerLoader.startWorker() - waiting for proper worker initialization, see WorkerLoader.waitWorkerInitialized()

Abstract Classes

Abstract Class	Description
BufferedGeometryAccessor	Abstract base class of an accessor for nonindexed geometry.
BufferedGeometryAccessorBase	Geometry accessor for both indexed and nonindexed BufferedGeometry.
CopyrightCoverageProvider	Base class to provide copyrights based on copyright coverage information, defined by geographical bounding boxes and relevant zoom level ranges.
DataSource	Derive a class from DataSource to contribute data and geometries to the MapView.
ElevationBasedClipPlanesEvaluator	Abstract evaluator class that adds support for elevation constraints.
IndexedBufferedGeometryAccessor	Abstract base class of indexed geometry.

Enumerations

Enumeration	Description
AnimatedExtrusionState	Animation states for extrusion effect
AtmosphereLightMode	Lists light modes.
AtmosphereShadingVariant	Atmosphere shader variants.
AtmosphereVariant	Atmosphere effect variants.
CalculationStatus	Status of the elevation range calculation.
ClassificationType	Enum representing classification types for rendered objects. These values are used as stencil references in depth reading operations to filter results by object classification.
LoadingState	State of loading.
MapViewEventNames
MapViewPowerPreference	Hint for the WebGL implementation on which power mode to prefer.
PickObjectType	Describes the general type of a picked object.
ResourceComputationType	Way the memory consumption of a tile is computed. Either in number of tiles, or in MegaBytes. If it is in MB, an estimation is used.
TileLoaderState	The state the ITileLoader.
TileTaskGroups

Interfaces

Interface	Description
AreaCopyrightInfo	Schema of [Map Tile API copyright endpoint](https://developer.here.com/documentation/map-tile/topics/resource-copyright.html) JSON response.
ClipPlanesEvaluator
CopyrightInfo	Copyright info attached to data displayed on map. Provided by DataSource and attached to Tiles. In most cases, an application should display this information on MapView to conform with licencing terms of its map data providers.
CopyrightProvider	CopyrightProvider is an interface to retrieve copyrights information for geographic region specified by bounding box.
DataSourceOptions	Options for a DataSource.
DataSourceTileList	List of visible tiles for a DataSource.
DispatcherEvent	JavaScript events for custom objects. Stores all listeners to allow removing all listeners for housekeeping. Will be replaced by THREE.EventDispatcher once https://github.com/mrdoob/three.js/pull/19844 is released.
DisplacementMap
ElevationProvider
ElevationRange	Elevation range with an optional calculation status.
ElevationRangeSource	Source for elevation ranges per tile. The returned elevation ranges will be used in the visible tile computation to calculate proper bounding boxes.
FovCalculation	Specifies how the FOV (Field of View) should be calculated.
IGeometryAccessor	Basic interface for geometry accessors.
ILineAccessor	Interface to access lines. Allows read access for some important attributes.
IMapAntialiasSettings
IMapRenderingManager
IObject3dAccessor	Accessor for unspecified 3D objects, like landmarks.
IPass	The interface for the Pass class.
IPassManager	IPassManager provides a base interface for Pass managers like MapRenderingManager.
ITileDataVisitor	Interface for a client visitor that is used to visit all THREE.Objects in a tile.
ITileLoader	The interface for managing tile loading.
LookAtParams	Parameters for .
MapViewOptions	User configuration for the MapView.
MaterialOptions	The structure of the options to pass into [[createMaterial]].
PickResult	A general pick result. You can access the details of a picked geometry from the property intersection, which is available if a geometry was hit. If a road was hit, a [[RoadPickResult]] is returned, which has additional information, but no intersection.
PolarTileDataSourceOptions
RenderEvent	The type of RenderEvent.
TerrainDataSource
TextElementStyle	TextElementsRenderer representation of a 's TextStyle.
TextPickResult
ThemeLoadOptions	Options to customize loading process.
TileDataAccessorOptions	An interface that provides options for TileDataAccessor.
TileDisplacementMap
TileFeatureData	An interface for optional feature data that is saved in a THREE.Object3D's userData property.
TileResourceInfo	Simple information about resource usage by the Tile.
TileResourceUsage	An object that contains information about resources used by a tile.
VisibleTileSetOptions	Limited set of MapViewOptions used for VisibleTileSet.

Namespaces

Namespace	Description
CameraUtils
CopyrightInfo
MapViewUtils	MapView utilities: View transformations, camera setup, view bounds computation...
RingBuffer
TileOffsetUtils

Variables

Variable	Description
ATMOSPHERE_GROUND_RENDER_ORDER
ATMOSPHERE_SKY_RENDER_ORDER
DEFAULT_CLEAR_COLOR
DEFAULT_FONT_CATALOG_NAME
DEFAULT_FOV_CALCULATION
MAX_FOV_DEG
MAX_FOV_RAD
MIN_FOV_DEG
MIN_FOV_RAD
TERRAIN_ZOOM_LEVEL	Zoom level to request terrain tiles for getting the height of the camera above terrain.

Type Aliases

Type Alias	Description
CopyrightCoverageResponse	Schema of [Map Tile API copyright endpoint](https://developer.here.com/documentation/map-tile/topics/resource-copyright.html) JSON response.
MapAnchor	An interface describing [[THREE.Object3D]]s anchored on given .
MapViewEnvironmentOptions
RequestHeaders
TextCanvases
TexturizableImage	Any type supported by WebGLRenderingContext.texImage2D() for texture creation
TileObject