Package globus.glmap

Class GLMapViewRenderer

java.lang.Object
globus.glmap.GLNativeObject
globus.glmap.GLMapViewRenderer
All Implemented Interfaces:
android.view.SurfaceHolder.Callback, android.view.SurfaceHolder.Callback2, android.view.TextureView.SurfaceTextureListener
public class GLMapViewRenderer extends GLNativeObject implements android.view.SurfaceHolder.Callback2, android.view.TextureView.SurfaceTextureListener
Renderer of map

  • Field Details

    • screenScale

      public float screenScale
      Screen scale

    • attachedView

      public android.view.View attachedView
      View where this render is attached

    • surfaceWidth

      public int surfaceWidth
      Surface width

    • surfaceHeight

      public int surfaceHeight
      Surface height

  • Constructor Details

    • GLMapViewRenderer

      public GLMapViewRenderer(android.content.Context context)
      Default constructor
      Parameters:
      context - context

  • Method Details

    • dispose

      public void dispose()
      Description copied from class: GLNativeObject
      Call this method to explicitly release native resources held by the object. While the garbage collector will eventually free these resources, invoking dispose() when the object is no longer needed can speed up native memory deallocation.
      Overrides:
      dispose in class GLNativeObject

    • setSurface

      public void setSurface(@NonNull android.view.Surface surface, int width, int height, float scale)
      Set surface for rendering
      Parameters:
      surface - rendering surface
      width - width of surface
      height - height of surface
      scale - screen scale

    • destroySurface

      public void destroySurface()
      Stops rendering and destroy rendering surface

    • attachToTextureView

      public boolean attachToTextureView(@NonNull android.view.TextureView textureView)
      Attach renderer to texture view
      Parameters:
      textureView - texture view where renderer will be attached
      Returns:
      true if restored. false if creates new surface

    • attachToSurfaceView

      public void attachToSurfaceView(@NonNull android.view.SurfaceView surfaceView)
      Attach renderer to surface view
      Parameters:
      surfaceView - surface view where renderer will be attached

    • surfaceChanged

      public void surfaceChanged(android.view.SurfaceHolder holder, int format, int width, int height)
      Specified by:
      surfaceChanged in interface android.view.SurfaceHolder.Callback

    • surfaceCreated

      public void surfaceCreated(android.view.SurfaceHolder holder)
      Specified by:
      surfaceCreated in interface android.view.SurfaceHolder.Callback

    • surfaceDestroyed

      public void surfaceDestroyed(@NonNull android.view.SurfaceHolder holder)
      Specified by:
      surfaceDestroyed in interface android.view.SurfaceHolder.Callback

    • surfaceRedrawNeededAsync

      public void surfaceRedrawNeededAsync(@NonNull android.view.SurfaceHolder holder, Runnable drawingFinished)
      Specified by:
      surfaceRedrawNeededAsync in interface android.view.SurfaceHolder.Callback2

    • surfaceRedrawNeeded

      public void surfaceRedrawNeeded(@NonNull android.view.SurfaceHolder holder)
      Specified by:
      surfaceRedrawNeeded in interface android.view.SurfaceHolder.Callback2

    • onSurfaceTextureAvailable

      public void onSurfaceTextureAvailable(@NonNull android.graphics.SurfaceTexture surfaceTexture, int width, int height)
      Specified by:
      onSurfaceTextureAvailable in interface android.view.TextureView.SurfaceTextureListener

    • onSurfaceTextureSizeChanged

      public void onSurfaceTextureSizeChanged(@NonNull android.graphics.SurfaceTexture surfaceTexture, int width, int height)
      Specified by:
      onSurfaceTextureSizeChanged in interface android.view.TextureView.SurfaceTextureListener

    • onSurfaceTextureDestroyed

      public boolean onSurfaceTextureDestroyed(@NonNull android.graphics.SurfaceTexture surfaceTexture)
      Specified by:
      onSurfaceTextureDestroyed in interface android.view.TextureView.SurfaceTextureListener

    • onSurfaceTextureUpdated

      public void onSurfaceTextureUpdated(@NonNull android.graphics.SurfaceTexture surfaceTexture)
      Specified by:
      onSurfaceTextureUpdated in interface android.view.TextureView.SurfaceTextureListener

    • getFps

      public float getFps()
      Returns fps
      Returns:
      fps

    • setFps

      public void setFps(float fps)
      Sets fps
      Parameters:
      fps - fps to set

    • setCenterTileStateChangedCallback

      public void setCenterTileStateChangedCallback(@Nullable Runnable callback)
      Set callback that will be called when center tile state is changed
      Parameters:
      callback - Runnable that will be post to main thread when center tile state is changed

    • getCenterTileState

      public int getCenterTileState()
      Return state of center tile
      Returns:
      state of center tile

    • convertDisplayDeltaToInternal

      @NonNull public MapPoint convertDisplayDeltaToInternal(double dx, double dy)
      Converts a screen-space distance (pixels) to a map-space delta using the view’s current zoom level and rotation.
      Parameters:
      dx - horizontal distance on the screen, in pixels
      dy - vertical distance on the screen, in pixels
      Returns:
      a new MapPoint whose coordinates represent the delta in map units
      See Also:

    • convertDisplayDeltaToInternal

      @NonNull public MapPoint convertDisplayDeltaToInternal(double dx, double dy, @NonNull MapPoint result)
      Same as convertDisplayDeltaToInternal(double,double) but writes the result into result to avoid object allocation.
      Parameters:
      dx - horizontal distance on the screen, in pixels
      dy - vertical distance on the screen, in pixels
      result - destination for the computed delta (must be non-null)
      Returns:
      result (for call-chaining)

    • convertDisplayDeltaToInternal

      @NonNull public MapPoint convertDisplayDeltaToInternal(double dx, double dy, double mapZoom, float mapAngle, @NonNull MapPoint result)
      Low-level variant that converts a screen-space distance to a map-space delta with explicit zoom and rotation.
      Parameters:
      dx - horizontal distance on the screen, in pixels
      dy - vertical distance on the screen, in pixels
      mapZoom - zoom level to use (same scale as getMapZoom())
      mapAngle - map rotation in degrees counter-clockwise
      result - destination for the computed delta (must be non-null)
      Returns:
      result
      See Also:

    • convertDisplayToInternal

      @NonNull public MapPoint convertDisplayToInternal(double x, double y)
      Converts a screen-space point (pixels) to a map coordinate.
      Parameters:
      x - screen x-coordinate, in pixels
      y - screen y-coordinate, in pixels
      Returns:
      a new MapPoint whose coordinates are in map units
      See Also:

    • convertDisplayToInternal

      @NonNull public MapPoint convertDisplayToInternal(double x, double y, @NonNull MapPoint result)
      Same as convertDisplayToInternal(double,double) but writes the result into result.
      Parameters:
      x - screen x-coordinate, in pixels
      y - screen y-coordinate, in pixels
      result - destination for the converted point
      Returns:
      result

    • convertInternalToDisplay

      @NonNull public android.graphics.PointF convertInternalToDisplay(@NonNull MapPoint val, @NonNull android.graphics.PointF result)
      Converts a map coordinate to screen pixels.
      Parameters:
      val - map coordinate to convert (map-space units)
      result - destination for the converted point
      Returns:
      a new PointF whose x and y are in screen pixels
      See Also:

    • convertInternalToDisplay

      @NonNull public android.graphics.PointF convertInternalToDisplay(@NonNull MapPoint val)
      Converts a map coordinate to screen pixels.
      Parameters:
      val - map coordinate to convert (map-space units)
      Returns:
      a new PointF whose x and y are in screen pixels
      See Also:

    • convertMetersToInternal

      public double convertMetersToInternal(double meters)
      Converts meters distance to internal distance
      Parameters:
      meters - The value to be converted
      Returns:
      Returns distance in internal units

    • doWhenSurfaceCreated

      public void doWhenSurfaceCreated(@NonNull @WorkerThread Runnable r)
      Runs command on internal rendering thread. If surface does not exists at this moment Runnable will be executed when it will be created. 
      
 final GLMapView mapView = (GLMapView) this.findViewById(R.id.map_view);
 mapView.doWhenSurfaceCreated(new Runnable() {
 public void run() {
 mapView.setMapCenter(center, false);
 mapView.scaleMap(scaleChange, null, false);
 }
 });
      Parameters:
      r - The Runnable to be executed at internal thread when surface will be created

    • setStyle

      public void setStyle(@NonNull GLMapVectorCascadeStyle style)
      Sets map style
      Parameters:
      style - style to use for map

    • setLocaleSettings

      public void setLocaleSettings(@NonNull GLMapLocaleSettings localeSettings)
      Sets map locale settings
      Parameters:
      localeSettings - New locale settings to use for translating map labels

    • getLocaleSettings

      @NonNull public GLMapLocaleSettings getLocaleSettings()
      Retrieves the previously set locale settings.
      Returns:
      The GLMapLocaleSettings instance that was previously set.

    • setBase

      public void setBase(@NonNull GLMapTileSource base)
      Sets the base tile source. By default, the base is a vector tile source.
      Parameters:
      base - The GLMapTileSource to use as the base tile source.

    • setOverlays

      public void setOverlays(@Nullable GLMapTileSource[] overlays)
      Sets the overlay tile sources. By default, overlays are null.
      Parameters:
      overlays - An array of GLMapTileSource instances to use as overlays, or null to remove overlays.

    • getOverlays

      @Nullable public GLMapTileSource[] getOverlays()
      Retrieves the overlay tile sources that were previously set.
      Returns:
      An array of GLMapTileSource instances representing the current overlays, or null if no overlays were set.

    • getBase

      @Nullable public GLMapTileSource getBase()
      Retrieves the base tile source that was previously set.
      Returns:
      The GLMapTileSource instance representing the current base tile source, or null if no base source was set.

    • setDrawElevationLines

      public void setDrawElevationLines(boolean drawElevationLines)
      Sets the visibility of elevation lines. By default, elevation lines are not drawn (false).
      Parameters:
      drawElevationLines - true to enable elevation line visibility, false to disable it.

    • getDrawElevationLines

      public boolean getDrawElevationLines()
      Retrieves the visibility state of elevation lines.
      Returns:
      true if elevation lines are visible, false otherwise.

    • setDrawHillshades

      public void setDrawHillshades(boolean drawHillshades)
      Sets the visibility of hill shades. By default, hill shades are not drawn (false).
      Parameters:
      drawHillshades - true to enable hill shade visibility, false to disable it.

    • getDrawHillshades

      public boolean getDrawHillshades()
      Retrieves the visibility state of hill shades.
      Returns:
      true if hill shades are visible, false otherwise.

    • setDrawSlopes

      public void setDrawSlopes(boolean drawSlopes)
      Sets the visibility of slopes. By default, slopes are not drawn (false).
      Parameters:
      drawSlopes - true to enable slope visibility, false to disable it.

    • getDrawSlopes

      public boolean getDrawSlopes()
      Retrieves the visibility state of slopes.
      Returns:
      true if slopes are visible, false otherwise.

    • captureFrameWhenFinish

      public void captureFrameWhenFinish(@NonNull GLMapViewRenderer.ScreenCaptureCallback callback)
      Captures frame when surface will be created and loading of resources finished. ScreenCaptureCallback provides Bitmap as a result
      Parameters:
      callback - ScreenCaptureCallback to call with result

    • mapZoomForBBox

      public double mapZoomForBBox(@NonNull GLMapBBox bbox, int mapWidth, int mapHeight)
      Calculates zoom of map to fit given bbox
      Parameters:
      bbox - bbox that you wish to fit
      mapWidth - width of visible area
      mapHeight - height of visible area
      Returns:
      zoom of map to fit given bbox or NaN if bbox is empty.

    • getMapCenter

      @NonNull public MapPoint getMapCenter(@NonNull MapPoint point)
      Gets coordinates of the origin point of the map. If animation is in progress - this value returns final value. 
      MapPoint pt = mapView.getMapCenter(new MapPoint());
      Parameters:
      point - The point to be filled with values.
      Returns:
      The same object that was passed to method call.
      See Also:

    • getCurrentMapCenter

      @NonNull public MapPoint getCurrentMapCenter(@NonNull MapPoint point)
      Gets current coordinates of the origin point of the map.
      Parameters:
      point - The point to be filled with values.
      Returns:
      The same object that was passed to method call.

    • getMapCenter

      @NonNull public MapPoint getMapCenter()
      Retrieves the coordinates of the center point of the map.

      Example usage:

      
 MapPoint pt = mapView.getMapCenter();
      Returns:
      A MapPoint object representing the coordinates of the map's center point.
      See Also:

    • setMapCenter

      public void setMapCenter(MapPoint center)
      Sets the coordinates of the center point of the map.

      Example usage:

      
 mapView.setMapCenter(center);
      Parameters:
      center - A MapPoint object representing the new center coordinates of the map.
      See Also:

    • getMapGeoCenter

      @NonNull public MapGeoPoint getMapGeoCenter()
      Retrieves the coordinates of the center point of the map.

      Example usage:

      
 MapPoint pt = mapView.getMapGeoCenter();
      Returns:
      A MapGeoPoint object representing the coordinates of the map's center point.
      See Also:

    • setMapGeoCenter

      public void setMapGeoCenter(@NonNull MapGeoPoint geoCenter)
      Sets the coordinates of the center point of the map.

      Example usage:

      
 mapView.setMapGeoCenter(center);
      Parameters:
      geoCenter - A MapGeoPoint object representing the new center coordinates of the map.
      See Also:

    • getMapOrigin

      @NonNull public MapPoint getMapOrigin(@NonNull MapPoint point)
      Retrieves the origin point of the map coordinate system and fills the provided MapPoint object with its values.
      Parameters:
      point - The MapPoint object to populate with the origin coordinates.
      Returns:
      The same MapPoint object that was passed as a parameter, now containing the origin coordinates.

    • getMapOrigin

      @NonNull public MapPoint getMapOrigin()
      Retrieves the origin point of the map coordinate system.
      Returns:
      A new MapPoint object containing the origin coordinates of the map.

    • setMapOrigin

      public void setMapOrigin(float x, float y)
      Sets the origin point of the map coordinate system (X, Y).

      Changing the values within the range [0, 1] in relative coordinates specifies the point in the GLMapView that is considered the center point for `mapCenter` and `setMapCenter`.

      Parameters:
      x - The X-coordinate of the origin point, in relative coordinates.
      y - The Y-coordinate of the origin point, in relative coordinates.

    • setSafeArea

      public void setSafeArea(int left, int top, int right, int bottom)
      Sets the safe area insets for the scale ruler and other map objects.

      The safe area defines the padding around the map view where interactive or visual elements like the scale ruler should not be placed.

      Parameters:
      left - The left inset, in pixels.
      top - The top inset, in pixels.
      right - The right inset, in pixels.
      bottom - The bottom inset, in pixels.

    • getBBox

      @NonNull public GLMapBBox getBBox()
      Retrieves the bounding box (BBox) of the currently visible part of the GLMapView.
      Returns:
      A GLMapBBox object representing the visible portion of the map.

    • getBBoxWithInsets

      @NonNull public GLMapBBox getBBoxWithInsets(int left, int right, int top, int bottom)
      Retrieves the bounding box (BBox) of the visible part of the GLMapView with applied insets.

      If an animation is in progress, the method returns the final BBox value as it will appear after the animation completes.

      Parameters:
      left - The left inset, in pixels.
      right - The right inset, in pixels.
      top - The top inset, in pixels.
      bottom - The bottom inset, in pixels.
      Returns:
      A GLMapBBox object representing the visible portion of the map with the specified insets applied.

    • enableClipping

      public void enableClipping(GLMapBBox bbox, float minLevel, float maxLevel)
      Enables clipping of the visible map area using the specified bounding box (BBox) and zoom levels.
      Parameters:
      bbox - The GLMapBBox object defining the area to clip.
      minLevel - The minimum zoom level where the clipping is active.
      maxLevel - The maximum zoom level where the clipping is active.

    • disableClipping

      public void disableClipping()
      Disables clipping of visible map area

    • isClippingEnabled

      public boolean isClippingEnabled()
      Checks if clipping is enabled
      Returns:
      true if enabled

    • setFontScale

      public void setFontScale(float scale)
      Sets the scale of the font used in the map. This method will automatically trigger a tile reload.
      Parameters:
      scale - The new font scale. The default value is 1.

    • getFontScale

      public float getFontScale()
      Retrieves the current font scale.
      Returns:
      The current font scale as a float.

    • getMapAngle

      public float getMapAngle()
      Gets current angle of the map.
      Returns:
      Current angle of the map.

    • setMapAngle

      public void setMapAngle(float newAngle)
      Sets angle of the map.
      Parameters:
      newAngle - new angle for map.
      See Also:

    • getMapPitch

      public float getMapPitch()
      Gets current pitch of the map.
      Returns:
      Current pitch of the map.

    • setMapPitch

      public void setMapPitch(float newAngle)
      Sets pitch of the map.
      Parameters:
      newAngle - new pitch for map.
      See Also:

    • getMapZoom

      public double getMapZoom()
      Get zoom level of the map. If animation is in progress final value will return. 
      double zoom = mapView.getMapZoom();
      Returns:
      Current zoom of the map.
      See Also:

    • getCurrentMapZoom

      public double getCurrentMapZoom()
      Gets current zoom level of the map. 
      double zoom = mapView.getCurrentMapZoom();
      Returns:
      Current zoom of the map.
      See Also:

    • getCurrentMapScale

      public double getCurrentMapScale()
      Gets current scale of the map.
      Returns:
      current scale of the map

    • getMapScale

      public double getMapScale()
      Gets scale of the map.
      Returns:
      scale of the map
      See Also:

    • setMapZoom

      public void setMapZoom(double newZoom)
      Sets zoom level of the map. 
      mapView.setMapZoom(16);
      Parameters:
      newZoom - new zoom level for map.
      See Also:

    • setMaxScale

      public void setMaxScale(double maxScale)
      Sets maximum scale of the map
      Parameters:
      maxScale - max scale to set

    • getMaxScale

      public double getMaxScale()
      Gets maximum scale of the map
      Returns:
      maximum scale of the map

    • setMapScale

      public void setMapScale(double newScale)
      Set scale of the map. Same as setMapZoom(pow(2, zoomLevel))
      Parameters:
      newScale - new scale for map.
      See Also:

    • setAttributionPosition

      public void setAttributionPosition(int placement)
      Sets the position of the map attribution. The default attribution text is "GLOBUS | © OpenStreetMap". If you are using map data from another provider, you should specify the appropriate attribution text.

      Note: You may choose to hide the attribution on the map by setting the position to `GLMapPlacement_Hidden`. However, in this case, it is mandatory to display the attribution within the application's settings. When the attribution is tapped, it may navigate to https://globus.software/about/ and https://www.openstreetmap.org/about/ See Interactive Maps 
      mapView.setAttributionPosition(GLMapPlacement.TopCenter);
      Parameters:
      placement - placement of attribution

    • removeAllObjects

      public void removeAllObjects()
      Removes all images, image groups, tracks, and marker layers from the map.
      See Also:

    • add

      public void add(@NonNull GLMapDrawObject drawObject)
      Adds a GLMapDrawObject to the map.
      Parameters:
      drawObject - The GLMapDrawObject to add to the map.
      See Also:

    • remove

      public void remove(@NonNull GLMapDrawObject drawObject)
      Removes a GLMapDrawObject from the map.
      Parameters:
      drawObject - The GLMapDrawObject to remove from the map.
      See Also:

    • changeDrawOrder

      public void changeDrawOrder(@NonNull GLMapDrawObject drawObject, int drawOrder)
      Changes the draw order of the specified GLMapDrawObject.
      Parameters:
      drawObject - The GLMapDrawObject whose draw order should be modified.
      drawOrder - The new draw order value for the object.
      See Also:

    • startAnimation

      public void startAnimation(@NonNull GLMapAnimation animation)
      Starts the specified animation on the map.
      Parameters:
      animation - The GLMapAnimation to start.

    • cancelMapAnimations

      public void cancelMapAnimations()
      Cancels all active animations on the map.

    • addTextForbiddenArea

      public void addTextForbiddenArea(int name, MapPoint origin, int offsetX, int offsetY, int width, int height)
      Adds or updates area where text (and associated icon) must not draw
      Parameters:
      name - unique name for area
      origin - origin of area
      offsetX - x offset of area from origin (in points)
      offsetY - y offset of area from origin (in points)
      width - width of area (in points)
      height - height of area (in points)

    • removeTextForbiddenArea

      public void removeTextForbiddenArea(int name)
      Removes area
      Parameters:
      name - name of area

    • animate

      @NonNull public GLMapAnimation animate(@NonNull GLMapViewRenderer.AnimateCallback callback)
      Create and starts animation using provided callback
      Parameters:
      callback - Callback that will configure animation
      Returns:
      created animation.

    • animate

      @NonNull public GLMapAnimation animate(@NonNull GLMapViewRenderer.AnimateCallback callback, @Nullable Runnable onFinish)
      Create and starts animation using provided callback
      Parameters:
      callback - Callback that will configure animation
      onFinish - Callback that will be called when animation is finished
      Returns:
      created animation.

    • reloadTiles

      public void reloadTiles()
      Force reloading of all tiles.

    • setNeedRedraw

      public void setNeedRedraw()
      Force redraw

    • setMapDidMoveCallback

      public void setMapDidMoveCallback(@Nullable Runnable callback)
      Sets callback that will be called after move animation finished
      Parameters:
      callback - callback that will be post to ui thread after animation finished

    • ForceOpenGL2

      public static void ForceOpenGL2()
      After calling this function any new GLMapView will use OpenGL 2.0 even if device supports OpenGL 3.0 Some cheap Android devices have problems with drivers.

    • DisableOpenGLBackgroundLoading

      public static void DisableOpenGLBackgroundLoading()
      Call this function before creating GLMapView to disable background loading of resources. In most cases this greatly speedup application, but some cheap Android devices can not handle it properly and this leads to lags or even crashes.

    • crashNDK

      public static void crashNDK()
      Function to test native crashes

    • crashNDK2

      public static void crashNDK2()
      Function to test native crashes