Optionalparams: SphericalPanoramaOptionsProtected_distanceReadonlyextentReadonlyhasReadonly flag to check if a given object implements HasDefaultPointOfView.
ReadonlyhasRead-only flag to check if a given object is of type HasLayers.
ReadonlyidThe unique identifier of this entity.
ReadonlyisRead-only flag to check if a given object is of type Entity.
ReadonlyisRead-only flag to check if a given object is of type Entity3D.
ReadonlyisReadonlyisReadonly flag to indicate that his object implements MemoryUsage.
ReadonlyisReadonlyisReadonlyisReadonlymaxThe name of this entity.
ReadonlytypeThe name of the type of this object.
ReadonlyuserAn object that can be used to store custom data about the Entity.
Gets or sets the background opacity.
Toggles the .castShadow property on objects generated by this entity.
Gets or sets the clipping planes set on this entity. Default is null (no clipping planes).
Note: custom entities must ensure that the materials and shaders used do support the clipping plane feature of three.js. Refer to the three.js documentation for more information.
Gets or sets colorimetry options.
Gets or sets contour line options.
Gets or sets depth testing on materials.
Toggles discard no-data pixels.
Gets or sets elevation range.
Gets or sets the frozen status of this entity. A frozen entity is still visible but will not be updated automatically.
Useful for debugging purposes.
Gets or sets graticule options.
Shows volumes of tiles.
ProtectedisReturns the number of layers currently in this object.
Gets or sets lighting options.
Returns true if this map is currently processing data.
Returns the root object of this entity.
Gets or sets the opacity of this entity.
Gets the loading progress (between 0 and 1) of the map. This is the average progress of all
layers in this map.
Note: if no layer is present, this will always be 1.
Note: This value is only meaningful is loading is true.
Determine if this entity is ready to use.
Toggles the .receiveShadow property on objects generated by this entity.
Note that map tiles will receive shadows only if lighting mode is set to MapLightingMode.LightBased.
Gets or sets the render order of this entity.
Gets the tiles at the root of the hierarchy (i.e LOD 0).
Shows volumes of tiles.
Shows volumes of tiles.
Shows meshes used for raycasting purposes.
Shows tile outlines.
Gets or sets the sidedness of the map surface:
FrontSide will only display the "above ground" side of the map (in cartesian maps),
or the outer shell of the map (in globe settings).BackSide will only display the "underground" side of the map (in cartesian maps),
or the inner shell of the map (in globe settings).DoubleSide will display both sides of the map.The global factor that drives SSE (screen space error) computation. The lower this value, the sooner a tile is subdivided. Note: changing this scale to a value less than 1 can drastically increase the number of tiles displayed in the scene, and can even lead to WebGL crashes.
Gets or sets the terrain options.
Gets or sets tile outline color.
Gets or sets the visibility of this entity. A non-visible entity will not be automatically updated.
Displays the map tiles in wireframe.
Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Adds a layer, then returns the created layer. Before using this method, make sure that the map is added in an instance. If the extent or the projection of the layer is not provided, those values will be inherited from the map.
the layer to add
a promise resolving when the layer is ready
ProtectedassignAssigns the render order of this object.
This may be overriden to perform custom logic.
ProtectedcreateFire an event type.
The event that gets fired.
Filters what objects need to be updated, based on updatedSources.
The returned objects are then passed to preUpdate and postUpdate.
Inherited classes should override shouldFullUpdate and shouldUpdate if they need to change this behavior.
Sources that triggered an update
Set of objects to update
Applies the callback to each layer in the object.
Gets all color layers in this map.
the color layers
ProtectedgetProtectedgetProtectedgetSample the elevation at the specified coordinate.
Note: this method does nothing if no elevation layer is present on the map, or if the sampling coordinate is not inside the map's extent.
Note: sampling might return more than one sample for any given coordinate. You can sort them by entities.ElevationSample.resolution | resolution to select the best sample for your needs.
The options.
The result object to populate with the samples. If none is provided, a new empty result is created. The existing samples in the array are not removed. Useful to cumulate samples across different maps.
The GetElevationResult containing the updated sample array. If the map has no elevation layer, this array is left untouched.
Gets all elevation layers in this map.
the elevation layers
Returns the minimal and maximal elevation values in this map, in meters.
If there is no elevation layer present, returns { min: 0, max: 0 }.
The min/max value.
Gets the elevation range of visible tiles, or null if no tile is visible.
If there are no elevation layers on this map, returns null as well.
ProtectedgetReturns the position of the layer in the layer list, or -1 if it is not found.
The layer to search.
The index of the layer.
Gets all layers that satisfy the filter predicate.
Optionalpredicate: ((arg0: Layer<LayerEvents, LayerUserData>) => boolean)the optional predicate.
the layers that matched the predicate or all layers if no predicate was provided.
Returns an approximation of the memory used by this object, in bytes.
The graphics context.
ProtectedgetProtectedgetProtectedgetChecks if listener is added to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Moves the specified layer after the other layer in the list.
The layer to move.
The target layer. If null, then the layer is put at the
beginning of the layer list.
ProtectedisMoves the layer closer to the background.
Note: this only applies to color layers.
The layer to move.
Moves the layer closer to the foreground.
Note: this only applies to color layers.
The layer to move.
ProtectednotifyProtectedonApplies entity-level setup on a new object.
Note: this method should be called from the subclassed entity to notify the parent class that a new 3D object has just been created, so that it can be setup with entity-wide parameters.
The object to prepare.
Coordinates on the rendering canvas
Optionaloptions: PickOptionsOptions
Target
Given a PickResult, returns and assigns its features.
Implementations must set pickedResult.features to the returned result.
Picked result
Optionaloptions: PickOptionsOptions
Features
Method called after Entity.update.
the update context.
Asynchronously preprocess the entity. This method may be overriden to perform any operation that must be done before the entity can be used in the scene, such as fetching metadata about a dataset, etc.
A promise that resolves when the entity is ready to be used.
This method is called just before update() to filter and select
which elements should be actually updated. For example, in the
case of complex entities made of a hierarchy of elements, the entire
hierarchy may not need to be updated.
Use this method to optimize the update step by reducing the number of elements to process.
Note: if this functions returns nothing, update() will not be called.
the update context.
the objects that triggered an update step. This is useful to filter out unnecessary updates if no sources are relevant to this entity. For example, if one of the sources is a camera that moved during the previous frame, any entity that depends on the camera's field of view should be updated.
the elements to update during update().
Perform raycasting on visible tiles.
The THREE raycaster.
The intersections array to populate with intersections.
Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Removes a layer from the map.
the layer to remove
The options.
OptionaldisposeIf true, the layer is also disposed.
true if the layer was present, false otherwise.
Sets the orientation of the sphere.
Note: this overrides the current orientation of the root object.
Optionalparams: { The parameters. If undefined, the orientation is reset to the default orientation.
Optionalheading?: numberThe heading (azimuth), in degrees. Zero is north, 90 is east, and so on.
Optionalpitch?: numberThe pitch, in degrees. Positive values raise the image up.
Optionalroll?: numberThe roll, in degrees. Positives values tilt the image on the right.
ProtectedsetupApplies entity-level setup on new object's material.
Subclasses can override this to setup custom logic, for instance if the entity can produce objects that are naturally transparent.
the material of the newly created object
This method is called before update to check if the MainLoop
should try to update this entity or not. For better performances,
it should return false if the entity has no impact on the
rendering (e.g. the element is not visible).
The inherited child can completely ignore this value if it makes sense.
true if should check for update
This method is called at the beginning of the update step to determine
if we should do a full render of the object. This should be the case if, for
instance, the source is the camera.
You can override this depending on your needs. The inherited child should
not ignore this value, it should do a boolean OR, e.g.:
return super.shouldFullUpdate(updateSource) || this.contains(updateSource);
Source of change
true if requires a full update of this object
ProtectedshouldThis method is called at the beginning of the update step to determine
if we should re-render updateSource.
Not used when shouldFullUpdate returns true.
You can override this depending on your needs. The inherited child should
not ignore this value, it should do a boolean OR, e.g.:
return super.shouldUpdate(updateSource) || this.contains(updateSource);
Source of change
true if requires an update of updateSource
Sort the color layers according to the comparator function.
The comparator function.
ProtectedtestTraverses all objects in the hierarchy of this entity.
The callback.
The traversal root. If undefined, the traversal starts at the root object of this entity.
Traverses all materials in the hierarchy of this entity.
The callback.
The traversal root. If undefined, the traversal starts at the root object of this entity.
Traverses all meshes in the hierarchy of this entity.
The callback.
The raversal root. If undefined, the traversal starts at the root object of this entity.
Traverses all tiles in the hierarchy of this entity.
The callback.
The raversal root. If undefined, the traversal starts at the root object of this entity.
Performs an update on an element of the entity.
Note: this method will be called for each element returned by preUpdate().
the update context.
This is the same object that the entity whose update() is being called.
New elements to update
An entity that can display spherical panoramas in an equirectangular projection.
The equirectangular projection
The panoramic image is mapped into a sphere using in the equirectangular projection.
The units are the degrees. This is the same projection that is used for the EPSG:4326 coordinate system.
In this projection:
The
'equirectangular'coordinate systemThis special coordinate system is used for layers that are added to this entity. It is technically equivalent to the EPSG:4326 system, but since the images projected into the sphere are not georeferenced in an actual cartographic coordinate system, we use this special CRS.
All image sources must express extents in this coordinate system.
How to load panoramic images
This entity is a subclass of Map. To load a panoramic images, you must add it as a ColorLayer with addLayer.
For simple images, such as JPG, PNG and WebP, use a StaticImageSource. Note that the image dimensions cannot exceed WebGL's
MAX_TEXTURE_SIZE(4096 pixels), and that the extent of this source must be expressed in the'equirectangular'CRS (see note below).For images that exceed WebGL's
MAX_TEXTURE_SIZE, you can convert them to GeoTIFF / COG with GDAL, in the EPSG:4326 coordinate system and appropriate georeferencing parameters (i.e if the image uses the entire equirectangular projection, its extent would be -180, -90, +180, +90), then load it through a GeoTIFFSource. It will be streamed efficiently to save memory and HTTP bandwidth. Again, the CRS of this source must be'equirectangular'.You can also load arbitrary vector features in the
'equirectangular'coordinate system using a VectorSource, and they will be positioned accordingly on the surface of the sphere. This can be used for example to digitize geometries from features visible in the panoramic image. If the features are already expressed in the equirectangular projection, no need to mention it in the constructor of the source.Orientation of the panorama
Panoramic images generally have an orientation expressed in heading, pitch and roll (typically in degrees).
Use the setOrientation method to set the orientation of the image for a given coordinate system.
In planar coordinate systems, the rotation angles are applied to the local XYZ axes of the entity.
In the EPSG:4978 coordinate system, the sphere is first rotated to match the local reference East, North, Up (ENU) reference frame at the coordinate of the center of the sphere, then the angles are applied.