Altus Mapping Engine JavaScript API Reference - v2.0.ut.2153.g60764257e - Tuesday May 16, 2022 | SDK Documentation | Builds | BA3 Home |
Represents a map of vector data. More...
Public Member Functions | |
void | setDelegate (VectorMapDelegate delegate) |
void | setTesselationThreshold (double thresholdInMeters) |
Sets the tesselation threshold for this map, in meters. Lines longer than this threshold are split up. More... | |
void | setForce3DLines (bool enabled) |
Promotes all 2D lines and polygon outlines to use the 3D line rendering path, defaults to false; More... | |
VectorGeometryHit | triggerLineHitDetection (vec2d point, double maxPointDistanceToVertex, double maxPointDistanceToLine) |
Trigger line hit detection on this map (must be called after adding the map to the scene). This returns the hit line/vertex and also calls the map delegate, if set. More... | |
VectorString | getPolygonHitShapeIds (vec2d point) |
Retrieve the ShapeIds of the polygons below a screen pointl More... | |
void | updateLineStyle (LineStyle style, double animationDuration) |
Updates the line style for this map. All lines using this style will be updated More... | |
void | updatePolygonStyle (PolygonStyle style, double animationDuration) |
Updates the polygon style for this map. All polygons using this style will be updated More... | |
void | setVectorWindingOrder (VectorWindingOrder windingOrder) |
Sets the vector winding order for this map. Polygons have a front face and a back face and this determines which is which. More... | |
void | setDepthRead (BooleanState depthRead) |
Turns depth testing on or off for this map. When on, vectors can be occluded by other geometry, such as terrain. It is very likely that this should only be changed for maps containing only 3D vectors. 2D vectors can lie below the surface of the Earth sphere and if depth testing is enabled, will not be visible. More... | |
Public Member Functions inherited from AltusUnified::Map | |
string | getName () |
Retrieves the name of this map. More... | |
void | setAlpha (double alpha) |
Sets the alpha transparency of the map. More... | |
void | setOrder (uint order) |
Set the map order (which maps get drawn first). More... | |
void | setPriority (int priority) |
Set the map priority, used for queing downloads, for example. More... | |
void | setMaxLevel (uint level) |
Sets the maximum level of the map. The higher the level, the more detail the map will display as you zoom in. More... | |
void | setVisibility (bool visible) |
Sets the visibility of the map. More... | |
void | setLightingParameters (float minLightness, bool nightAlphaMaskEnabled) |
Sets lighting parameters. More... | |
MapType | getMapType () |
Retrieves the type of this map. More... | |
void | reload () |
Reload this map. More... | |
void | reloadRegion (BoundingBox boundingBox) |
Reload a region of this map. More... | |
Represents a map of vector data.
VectorString AltusUnified::VectorMapBase::getPolygonHitShapeIds | ( | vec2d | point | ) |
Retrieve the ShapeIds of the polygons below a screen pointl
point | Screen space position, in points. |
void AltusUnified::VectorMapBase::setDelegate | ( | VectorMapDelegate | delegate | ) |
void AltusUnified::VectorMapBase::setDepthRead | ( | BooleanState | depthRead | ) |
Turns depth testing on or off for this map. When on, vectors can be occluded by other geometry, such as terrain. It is very likely that this should only be changed for maps containing only 3D vectors. 2D vectors can lie below the surface of the Earth sphere and if depth testing is enabled, will not be visible.
void AltusUnified::VectorMapBase::setForce3DLines | ( | bool | enabled | ) |
Promotes all 2D lines and polygon outlines to use the 3D line rendering path, defaults to false;
void AltusUnified::VectorMapBase::setTesselationThreshold | ( | double | thresholdInMeters | ) |
Sets the tesselation threshold for this map, in meters. Lines longer than this threshold are split up.
thresholdInMeters | tesselation threshold in meters |
void AltusUnified::VectorMapBase::setVectorWindingOrder | ( | VectorWindingOrder | windingOrder | ) |
Sets the vector winding order for this map. Polygons have a front face and a back face and this determines which is which.
windingOrder | the winding order of this map, either clockwise or counter-clockwise. |
VectorGeometryHit AltusUnified::VectorMapBase::triggerLineHitDetection | ( | vec2d | point, |
double | maxPointDistanceToVertex, | ||
double | maxPointDistanceToLine | ||
) |
Trigger line hit detection on this map (must be called after adding the map to the scene). This returns the hit line/vertex and also calls the map delegate, if set.
point | Screen space position, in points. |
maxPointDistanceToVertex | the maximum allowable screen space distance between a click and the line vertex for a hit to be registered, in points. |
maxPointDistanceToLine | the maximum allowable screen space distance between a click and the line for a hit to be registered, in points. |
void AltusUnified::VectorMapBase::updateLineStyle | ( | LineStyle | style, |
double | animationDuration | ||
) |
Updates the line style for this map. All lines using this style will be updated
animationDuration | The length of time it takes for this change to fully apply, in seconds. (defaults to 0) |
void AltusUnified::VectorMapBase::updatePolygonStyle | ( | PolygonStyle | style, |
double | animationDuration | ||
) |
Updates the polygon style for this map. All polygons using this style will be updated
animationDuration | The length of time it takes for this change to fully apply, in seconds. (defaults to 0) |