-
- All Implemented Interfaces:
public interface ClusterMapView
ClusterMapView 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.
-
-
Method Summary
Modifier and Type Method Description abstract void
initialize(@NonNull() ClusterMapViewParams clusterMapViewParams)
It initializes the ClusterMapView with the given parameters. abstract boolean
isFinishedLoading(int featureCategoryMask)
Check the engine initialization status for specified features abstract void
onSurfaceCreated()
Lifecycle hooks, call this api when surface is first created. abstract void
onSurfaceChanged(int width, int height)
Lifecycle hooks, call this api after any structural changes (format or size) have been made to the surface abstract void
onSurfaceDestroyed()
Lifecycle hooks, call this api when a surface is being destroyed abstract void
onPause()
Lifecycle hooks, call to pause the cluster view rendering abstract void
onResume()
Lifecycle hooks, call to resume the cluster view rendering abstract void
onDestroy()
Lifecycle hooks, call to destroy the cluster view instance abstract void
setFPS(int fps)
Set the preferred frames-per-second for the cluster map view renderer. abstract void
addMapViewListener(@NonNull() MapView.MapViewListener listener)
Register the mapView listener abstract void
removeMapViewListener(@NonNull() MapView.MapViewListener listener)
Remove the mapView listener abstract void
setOnCurrentRenderModeChangedListener(@Nullable() CurrentRenderModeChangeListener currentRenderModeChangeListener)
* sets the listener for the current rendering mode changes(between 2D and 3D) abstract void
setOnTargetRenderModeChangedListener(@Nullable() TargetRenderModeChangeListener targetRenderModeChangedListener)
* sets the listener for the target rendering mode changes(between 2D and 3D) abstract VehicleController
vehicleController()
* Warning! abstract RoutesController
routesController()
* Warning! abstract AnnotationsController
annotationsController()
* Warning! abstract CameraController
cameraController()
* Warning! abstract FeaturesController
featuresController()
Warning! abstract ShapesController
shapesController()
Warning! abstract ThemeController
themeController()
* Warning! abstract LayoutController
layoutController()
* Warning! abstract MapDiagnosis
mapDiagnosis()
* This method is used to return the object used to diagnose ClusterMapView -
-
Method Detail
-
initialize
abstract void initialize(@NonNull() ClusterMapViewParams clusterMapViewParams)
It initializes the ClusterMapView with the given parameters.
- Parameters:
clusterMapViewParams
- ClusterMapViewParams config object with information for creating a cluster map view
-
isFinishedLoading
abstract boolean isFinishedLoading(int 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 void onSurfaceCreated()
Lifecycle hooks, call this api when surface is first created. The map will start drawing after this call
-
onSurfaceChanged
abstract void onSurfaceChanged(int width, int height)
Lifecycle hooks, call this api after any structural changes (format or size) have been made to the surface
-
onSurfaceDestroyed
abstract void onSurfaceDestroyed()
Lifecycle hooks, call this api when a surface is being destroyed
-
onPause
abstract void onPause()
Lifecycle hooks, call to pause the cluster view rendering
-
onResume
abstract void onResume()
Lifecycle hooks, call to resume the cluster view rendering
-
onDestroy
abstract void onDestroy()
Lifecycle hooks, call to destroy the cluster view instance
-
setFPS
abstract void setFPS(int 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 void addMapViewListener(@NonNull() MapView.MapViewListener listener)
Register the mapView listener
- Parameters:
listener
- The mapView listener MapView.MapViewListener
-
removeMapViewListener
abstract void removeMapViewListener(@NonNull() MapView.MapViewListener listener)
Remove the mapView listener
- Parameters:
listener
- The mapThe mapView listener MapView.MapViewListener
-
setOnCurrentRenderModeChangedListener
abstract void setOnCurrentRenderModeChangedListener(@Nullable() CurrentRenderModeChangeListener currentRenderModeChangeListener)
* sets the listener for the current rendering mode changes(between 2D and 3D)
- Parameters:
currentRenderModeChangeListener
- the listener that will be used to notify the change
-
setOnTargetRenderModeChangedListener
abstract void setOnTargetRenderModeChangedListener(@Nullable() TargetRenderModeChangeListener targetRenderModeChangedListener)
* sets the listener for the target rendering mode changes(between 2D and 3D)
- Parameters:
targetRenderModeChangedListener
- the listener that will be used to notify the change
-
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
-
-
-
-