Altus Mapping Engine JavaScript API Reference - v2.0.ut.2153.g60764257e - Tuesday May 16, 2022 SDK Documentation | Builds | BA3 Home
AltusUnified::DynamicVectorMap Class Reference

Represents a map of dynamic vector data. More...

Inheritance diagram for AltusUnified::DynamicVectorMap:
Collaboration diagram for AltusUnified::DynamicVectorMap:

Public Member Functions

 DynamicVectorMap (string name)
 Constructor More...
 
void addDynamicLine (DynamicLine line, LineStyle style)
 Adds a DynamicLine to this map, and do the cache (see RebuildMapUsingCachedShapes) More...
 
void addDynamicLine3D (DynamicLine3D line, LineStyle style)
 Adds a DynamicLine3D to this map, and do the cache (see RebuildMapUsingCachedShapes). More...
 
void addDynamicPolygon (DynamicPolygon polygon, PolygonStyle style)
 Adds a DynamicPolygon to this map, and do the cache (see RebuildMapUsingCachedShapes). More...
 
void addDynamicExtrudedPolygon (DynamicExtrudedPolygon polygon, PolygonStyle style)
 Adds a DynamicExtrudedPolygon to this map, and do the cache (see RebuildMapUsingCachedShapes). More...
 
void addDynamicPolygon3D (DynamicPolygon3D polygon, PolygonStyle style)
 Adds a DynamicPolygon3 to this map, and do the cache (see RebuildMapUsingCachedShapes). More...
 
void removeDynamicLineFromCache (DynamicLine line)
 Removes a DynamicLine from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called. More...
 
void removeDynamicLine3DFromCache (DynamicLine3D line)
 Removes a DynamicLine3D from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called. More...
 
void removeDynamicPolygonFromCache (DynamicPolygon polygon)
 Removes a DynamicPolygon from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called. More...
 
void removeDynamicExtrudedPolygonFromCache (DynamicExtrudedPolygon polygon)
 Removes a DynamicExtrudedPolygon from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called. More...
 
void removeDynamicPolygon3DFromCache (DynamicPolygon3D polygon)
 Removes a DynamicPolygon3D from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called. More...
 
DynamicLine findDynamicLineByShapeIDInCache (string name)
 Find a dynamic line in the cache by its shape ID. More...
 
DynamicLine3D findDynamicLine3DByShapeIDInCache (string name)
 Find a dynamic 3D line in the cache by its shape ID More...
 
DynamicPolygon findDynamicPolygonByShapeIDInCache (string name)
 Find a dynamic polygon in the cache by its shape ID More...
 
DynamicExtrudedPolygon findDynamicExtrudedPolygonByShapeIDInCache (string name)
 Find a dynamic extruded polygon in the cache by its shape ID More...
 
DynamicPolygon3D findDynamicPolygon3DByShapeIDInCache (string name)
 Find a dynamic 3D polygon in the cache by its shape ID More...
 
void rebuildMapUsingCachedShapes ()
 Rebuild the map using the cached shapes. The map will recreated with shapes in the cache and all shapes not in the cache will be removed. More...
 
void clearCache ()
 Clear the cache of shapes. If RebuildMapUsingCachedShapes is called after this, all shapes currently on the map will be removed. More...
 
 Public Member Functions inherited from AltusUnified::VectorMapBase
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...
 

Detailed Description

Represents a map of dynamic vector data.

Constructor & Destructor Documentation

AltusUnified::DynamicVectorMap::DynamicVectorMap ( string  name)

Constructor

Parameters
nameThe name of the map

Member Function Documentation

void AltusUnified::DynamicVectorMap::addDynamicExtrudedPolygon ( DynamicExtrudedPolygon  polygon,
PolygonStyle  style 
)

Adds a DynamicExtrudedPolygon to this map, and do the cache (see RebuildMapUsingCachedShapes).

void AltusUnified::DynamicVectorMap::addDynamicLine ( DynamicLine  line,
LineStyle  style 
)

Adds a DynamicLine to this map, and do the cache (see RebuildMapUsingCachedShapes)

void AltusUnified::DynamicVectorMap::addDynamicLine3D ( DynamicLine3D  line,
LineStyle  style 
)

Adds a DynamicLine3D to this map, and do the cache (see RebuildMapUsingCachedShapes).

void AltusUnified::DynamicVectorMap::addDynamicPolygon ( DynamicPolygon  polygon,
PolygonStyle  style 
)

Adds a DynamicPolygon to this map, and do the cache (see RebuildMapUsingCachedShapes).

void AltusUnified::DynamicVectorMap::addDynamicPolygon3D ( DynamicPolygon3D  polygon,
PolygonStyle  style 
)

Adds a DynamicPolygon3 to this map, and do the cache (see RebuildMapUsingCachedShapes).

void AltusUnified::DynamicVectorMap::clearCache ( )

Clear the cache of shapes. If RebuildMapUsingCachedShapes is called after this, all shapes currently on the map will be removed.

DynamicExtrudedPolygon AltusUnified::DynamicVectorMap::findDynamicExtrudedPolygonByShapeIDInCache ( string  name)

Find a dynamic extruded polygon in the cache by its shape ID

Parameters
namethe shape ID
DynamicLine3D AltusUnified::DynamicVectorMap::findDynamicLine3DByShapeIDInCache ( string  name)

Find a dynamic 3D line in the cache by its shape ID

Parameters
namethe shape ID
DynamicLine AltusUnified::DynamicVectorMap::findDynamicLineByShapeIDInCache ( string  name)

Find a dynamic line in the cache by its shape ID.

Parameters
namethe shape ID
DynamicPolygon3D AltusUnified::DynamicVectorMap::findDynamicPolygon3DByShapeIDInCache ( string  name)

Find a dynamic 3D polygon in the cache by its shape ID

Parameters
namethe shape ID
DynamicPolygon AltusUnified::DynamicVectorMap::findDynamicPolygonByShapeIDInCache ( string  name)

Find a dynamic polygon in the cache by its shape ID

Parameters
namethe shape ID
void AltusUnified::DynamicVectorMap::rebuildMapUsingCachedShapes ( )

Rebuild the map using the cached shapes. The map will recreated with shapes in the cache and all shapes not in the cache will be removed.

void AltusUnified::DynamicVectorMap::removeDynamicExtrudedPolygonFromCache ( DynamicExtrudedPolygon  polygon)

Removes a DynamicExtrudedPolygon from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called.

void AltusUnified::DynamicVectorMap::removeDynamicLine3DFromCache ( DynamicLine3D  line)

Removes a DynamicLine3D from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called.

void AltusUnified::DynamicVectorMap::removeDynamicLineFromCache ( DynamicLine  line)

Removes a DynamicLine from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called.

void AltusUnified::DynamicVectorMap::removeDynamicPolygon3DFromCache ( DynamicPolygon3D  polygon)

Removes a DynamicPolygon3D from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called.

void AltusUnified::DynamicVectorMap::removeDynamicPolygonFromCache ( DynamicPolygon  polygon)

Removes a DynamicPolygon from this map's cache. The map is not updated until RebuildMapUsingCachedShapes is called.