-
- All Implemented Interfaces:
public interface ClusterMapViewClusterMapView is the interface for displaying map information on cluster device. It supports basic map/traffic functions, such as annotation rendering, vehicle rendering or traffic rendering.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classClusterMapView.Companion
-
Method Summary
Modifier and Type Method Description abstract Unitinitialize(ClusterMapViewParams clusterMapViewParams)It initializes the ClusterMapView with the given parameters. abstract BooleanisFinishedLoading(Integer featureCategoryMask)Check the engine initialization status for specified features abstract UnitonSurfaceCreated()Lifecycle hooks, call this api when surface is first created. abstract UnitonSurfaceChanged(Integer width, Integer height)Lifecycle hooks, call this api after any structural changes (format or size) have been made to the surface abstract UnitonSurfaceDestroyed()Lifecycle hooks, call this api when a surface is being destroyed abstract UnitonPause()Lifecycle hooks, call to pause the cluster view rendering abstract UnitonResume()Lifecycle hooks, call to resume the cluster view rendering abstract UnitonDestroy()Lifecycle hooks, call to destroy the cluster view instance abstract UnitsetFPS(Integer fps)Set the preferred frames-per-second for the cluster map view renderer. abstract UnitaddMapViewListener(MapView.MapViewListener listener)Register the mapView listener abstract UnitremoveMapViewListener(MapView.MapViewListener listener)Remove the mapView listener abstract VehicleControllervehicleController()abstract RoutesControllerroutesController()abstract AnnotationsControllerannotationsController()abstract CameraControllercameraController()abstract FeaturesControllerfeaturesController()Warning! abstract ShapesControllershapesController()Warning! abstract ThemeControllerthemeController()abstract LayoutControllerlayoutController()abstract MapDiagnosismapDiagnosis()-
-
Method Detail
-
initialize
abstract Unit initialize(ClusterMapViewParams clusterMapViewParams)
It initializes the ClusterMapView with the given parameters.
- Parameters:
clusterMapViewParams- ClusterMapViewParams
-
isFinishedLoading
abstract Boolean isFinishedLoading(Integer featureCategoryMask)
Check the engine initialization status for specified features
- Parameters:
featureCategoryMask- represents the features of the render engine that are required to be loaded(features are describe above)
-
onSurfaceCreated
abstract Unit onSurfaceCreated()
Lifecycle hooks, call this api when surface is first created. The map will start drawing after this call
-
onSurfaceChanged
abstract Unit onSurfaceChanged(Integer width, Integer height)
Lifecycle hooks, call this api after any structural changes (format or size) have been made to the surface
-
onSurfaceDestroyed
abstract Unit onSurfaceDestroyed()
Lifecycle hooks, call this api when a surface is being destroyed
-
setFPS
abstract Unit setFPS(Integer fps)
Set the preferred frames-per-second for the cluster map view renderer. Default fps is 30.
- Parameters:
fps- the preferred frames-per-second
-
addMapViewListener
abstract Unit addMapViewListener(MapView.MapViewListener listener)
Register the mapView listener
- Parameters:
listener- The mapView listener MapView.MapViewListener
-
removeMapViewListener
abstract Unit removeMapViewListener(MapView.MapViewListener listener)
Remove the mapView listener
- Parameters:
listener- The mapThe mapView listener MapView.MapViewListener
-
vehicleController
abstract VehicleController vehicleController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate the vehicle representation for the ClusterMapView VehicleController
-
routesController
abstract RoutesController routesController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate routes for the ClusterMapView RoutesController
-
annotationsController
abstract AnnotationsController annotationsController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate annotations for the ClusterMapView AnnotationsController
-
cameraController
abstract CameraController cameraController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate the point of focus for the ClusterMapView CameraController
-
featuresController
abstract FeaturesController featuresController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate renderable features for the ClusterMapView FeaturesController
-
shapesController
abstract ShapesController shapesController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate API-fed shape data for rendering on the ClusterMapView ShapesController
-
themeController
abstract ThemeController themeController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate the ClusterMapView theme ThemeController
-
layoutController
abstract LayoutController layoutController()
Warning! Using Controllers before the MapViewReadyListener notification will result in a crash This method is used to return the object used to manipulate the layout of the ClusterMapView LayoutController
-
mapDiagnosis
abstract MapDiagnosis mapDiagnosis()
This method is used to return the object used to diagnose ClusterMapView
-
-
-
-