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

A map of 3D models. Every model is drawn every frame. This map is not tiled. More...

Inheritance diagram for AltusUnified::ModelMap:
Collaboration diagram for AltusUnified::ModelMap:

Public Member Functions

 ModelMap (string name)
 Create a model map More...
 
void addModel (InstancedModel model)
 Adds a model to this map. More...
 
void removeModel (InstancedModel model)
 Removes a model from this map. More...
 
void setDelegate (ModelMapDelegate delegate)
 Sets the delegate for this map. This must be called before adding the map to the scene. More...
 
void setDepthWrite (BooleanState depthWrite)
 Set whether models in this map render to the depth buffer. The default is ON. You would only use this function to do specialty rendering. More...
 
uint addModelsFromJSONData (string jsonData, Transform rootTransform)
 Adds models using the Altus JSON file format. A separate tool is required to create JSON files from 3D models. 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

A map of 3D models. Every model is drawn every frame. This map is not tiled.

Constructor & Destructor Documentation

AltusUnified::ModelMap::ModelMap ( string  name)

Create a model map

Parameters
nameThe map name. This must be unique.

Member Function Documentation

void AltusUnified::ModelMap::addModel ( InstancedModel  model)

Adds a model to this map.

Parameters
modelThe model
uint AltusUnified::ModelMap::addModelsFromJSONData ( string  jsonData,
Transform  rootTransform 
)

Adds models using the Altus JSON file format. A separate tool is required to create JSON files from 3D models.

Parameters
jsonDataThe JSON data
rootTransformThe transform all models will be anchored to. This determines where the model will be placed on the Earth.
void AltusUnified::ModelMap::removeModel ( InstancedModel  model)

Removes a model from this map.

Parameters
modelThe model
void AltusUnified::ModelMap::setDelegate ( ModelMapDelegate  delegate)

Sets the delegate for this map. This must be called before adding the map to the scene.

void AltusUnified::ModelMap::setDepthWrite ( BooleanState  depthWrite)

Set whether models in this map render to the depth buffer. The default is ON. You would only use this function to do specialty rendering.