Classes | Public Member Functions | List of all members
com.sygic.sdk.map.MapView Class Reference
Inheritance diagram for com.sygic.sdk.map.MapView:
Inheritance graph
[legend]
Collaboration diagram for com.sygic.sdk.map.MapView:
Collaboration graph
[legend]

Classes

interface  CountrySignage
 
interface  DataReadyListener
 
interface  DataState
 
interface  GeoCoordinateToScreenPointCallback
 
class  MapDataModel
 
interface  MapLayerCategory
 
interface  OnInitListener
 
interface  SpeedUnits
 
class  State
 
interface  WarningsType
 

Public Member Functions

Pair< Float, Float > getMinMaxZoomLevel ()
 
boolean isValid ()
 
void addMapGestureListener (final MapGesturesDetector.MapGestureListener listener)
 
boolean removeMapGestureListener (MapGesturesDetector.MapGestureListener listener)
 
Camera.CameraModel getCameraModel ()
 
View getView ()
 
void setZOrderOnTop (final boolean isOnTop)
 
void setZOrderMediaOverlay (final boolean isMediaOverlay)
 
void setPixelFormat (final int pixelFormat)
 
void addEglCallback (@NonNull final GlSurfaceListener.EglCallback callback)
 
void removeEglCallback (@NonNull final GlSurfaceListener.EglCallback callback)
 
PositionIndicator getPositionIndicator ()
 
CameraState.PositionOrientation calculateFromMapRectangle (@NonNull final MapRectangle mapRectangle, @NonNull final MapCenter mapCenter, @FloatRange(from=-180.0, to=180.0) final float rotation, final float tilt, @FloatRange(from=0.0, to=Float.MAX_VALUE) final float maxZoomLevel)
 
CameraState calculateFromMapRectangle (@NonNull final MapRectangle mapRectangle, @NonNull final MapCenter mapCenter, @FloatRange(from=-180.0, to=180.0) final float rotation, final float tilt, @FloatRange(from=0.0, to=Float.MAX_VALUE) final float maxZoomLevel, final @Nullable CameraState sourceState)
 
GeoCoordinates geoCoordinatesFromPoint (final int x, final int y)
 
List< GeoCoordinates > geoCoordinatesFromPoints (final @NonNull List< Point > points)
 
List< Point > screenPointsFromGeoCoordinates (final @NonNull List< GeoCoordinates > geoCoordinates)
 
MapDataModel getMapDataModel ()
 
boolean addClusterLayer (final ClusterLayer cluster)
 
boolean removeClusterLayer (final ClusterLayer cluster)
 
synchronized void addGeoCoordinateToScreenPointListener (final GeoCoordinateToScreenPointCallback callback)
 
synchronized void removeGeoCoordinateToScreenPointListener (final GeoCoordinateToScreenPointCallback callback)
 
List< String > getActiveSkins ()
 
List< String > getAvailableSkins ()
 
void setMapLanguage (final @NonNull Locale locale)
 
void setMapLanguageInternal (final @NonNull Locale locale)
 
void setMapSpeedUnits (final @SpeedUnits int units)
 
void setMapSpeedUnitsInternal (final @SpeedUnits int units)
 
void setMapLayerCategoryVisibility (final @MapLayerCategory int category, final boolean enable)
 
void setMapLayerCategoryVisibilityInternal (final @MapLayerCategory int category, final boolean enable)
 
void setWarningsTypeVisibilityInternal (final @WarningsType int type, final boolean enable)
 
boolean getWarningsTypeVisibilityInternal (final @WarningsType int type)
 
void setIncidentWarningSettings (@NonNull final IncidentWarningSettings settings)
 
void setIncidentWarningSettingsInternal (@Nullable final IncidentWarningSettings settings)
 
void setMapWarningSettings (@NonNull final MapWarningSettings settings)
 
void setMapWarningSettingsInternal (@Nullable final MapWarningSettings settings)
 
void setLogisticInfoSettings (@NonNull final LogisticInfoSettings settings)
 
void showDebugView (final boolean enable)
 
void setFpsLimit (final FpsConfig fpsConfig)
 
FpsConfig getFpsLimit ()
 
void enableRendering (final boolean enable)
 
int requestObjectsAtPoint (final float x, final float y, final RequestObjectCallback callback)
 
void addValidityListener (final MapValidityListener listener)
 
void removeValidityListener (final MapValidityListener listener)
 
void addDataReadyListener (final DataReadyListener listener)
 
void addDataReadyListener (final DataReadyListener listener, @Nullable final Executor executor)
 
void removeDataReadyListener (final DataReadyListener listener)
 
float scaleScreenToView (final float value)
 
int scaleScreenToView (final int value)
 

Detailed Description

A class used by an application to display a map.

Member Function Documentation

◆ addClusterLayer()

boolean com.sygic.sdk.map.MapView.addClusterLayer ( final ClusterLayer  cluster)

Add cluster of markers to map. By the time the cluster is added to map, all markers have to be added in map, otherwise an exception will be thrown.

◆ addDataReadyListener() [1/2]

void com.sygic.sdk.map.MapView.addDataReadyListener ( final DataReadyListener  listener)

◆ addDataReadyListener() [2/2]

void com.sygic.sdk.map.MapView.addDataReadyListener ( final DataReadyListener  listener,
@Nullable final Executor  executor 
)

◆ addEglCallback()

void com.sygic.sdk.map.MapView.addEglCallback ( @NonNull final GlSurfaceListener.EglCallback  callback)

Adds callback for underlying OpenGL calls of swap buffers.

Parameters
callbackGlSurfaceListener.EglCallback callback to handle GlSurfaceListener.EglCallback#eglSwapBuffers() event.

◆ addGeoCoordinateToScreenPointListener()

synchronized void com.sygic.sdk.map.MapView.addGeoCoordinateToScreenPointListener ( final GeoCoordinateToScreenPointCallback  callback)

◆ addMapGestureListener()

void com.sygic.sdk.map.MapView.addMapGestureListener ( final MapGesturesDetector.MapGestureListener  listener)

Adds the map gesture listener.

◆ addValidityListener()

void com.sygic.sdk.map.MapView.addValidityListener ( final MapValidityListener  listener)

◆ calculateFromMapRectangle() [1/2]

CameraState.PositionOrientation com.sygic.sdk.map.MapView.calculateFromMapRectangle ( @NonNull final MapRectangle  mapRectangle,
@NonNull final MapCenter  mapCenter,
@FloatRange(from=-180.0, to=180.0) final float  rotation,
final float  tilt,
@FloatRange(from=0.0, to=Float.MAX_VALUE) final float  maxZoomLevel 
)

Calculates CameraState.PositionOrientation to animate Camera with, given mapRectangle and camera states

Parameters
mapRectangleRectangle with margins to be zoomed to
mapCenterWanted map center state
rotationWanted rotation state
tiltWanted tilt state
maxZoomLevelMaximum zoom level allowed (ie. limits zoom in of the map)
Returns
CameraState.PositionOrientation with calculated values to animate the camera

◆ calculateFromMapRectangle() [2/2]

CameraState com.sygic.sdk.map.MapView.calculateFromMapRectangle ( @NonNull final MapRectangle  mapRectangle,
@NonNull final MapCenter  mapCenter,
@FloatRange(from=-180.0, to=180.0) final float  rotation,
final float  tilt,
@FloatRange(from=0.0, to=Float.MAX_VALUE) final float  maxZoomLevel,
final @Nullable CameraState  sourceState 
)

Calculates CameraState to animate Camera with, given mapRectangle and camera states

Parameters
mapRectangleRectangle with margins to be zoomed to
mapCenterWanted map center state
rotationWanted rotation state
tiltWanted tilt state
maxZoomLevelMaximum zoom level allowed (ie. limits zoom in of the map)
sourceStateSource camera state to get non-calculated parameters from
Returns
CameraState with calculated values to animate the camera

◆ enableRendering()

void com.sygic.sdk.map.MapView.enableRendering ( final boolean  enable)

◆ geoCoordinatesFromPoint()

GeoCoordinates com.sygic.sdk.map.MapView.geoCoordinatesFromPoint ( final int  x,
final int  y 
)

Returns geo coordinates of the point on the map regarding of screen coordinates.

Parameters
xX screen coordinate
yY screen coordinate
Returns
Geo coordinates of the point on the map or null if is not possible to translate.

◆ geoCoordinatesFromPoints()

List<GeoCoordinates> com.sygic.sdk.map.MapView.geoCoordinatesFromPoints ( final @NonNull List< Point >  points)

Returns geo coordinates of the points on the map regarding of screen coordinates.

Parameters
pointslist of X and Y screen coordinates.
Returns
List of geo coordinates of the point on the map or it is empty if it cannot be translated.

◆ getActiveSkins()

List<String> com.sygic.sdk.map.MapView.getActiveSkins ( )

Returns list of names of skins which are set for current map.

Returns
List of skins which are set for current map.

◆ getAvailableSkins()

List<String> com.sygic.sdk.map.MapView.getAvailableSkins ( )

Returns list of names of available skins.

Returns
List of available skins.

◆ getCameraModel()

Camera.CameraModel com.sygic.sdk.map.MapView.getCameraModel ( )

◆ getFpsLimit()

FpsConfig com.sygic.sdk.map.MapView.getFpsLimit ( )

◆ getMapDataModel()

MapDataModel com.sygic.sdk.map.MapView.getMapDataModel ( )

Returns MapDataModel backing up the MapView

Returns
active map model

◆ getMinMaxZoomLevel()

Pair<Float, Float> com.sygic.sdk.map.MapView.getMinMaxZoomLevel ( )

◆ getPositionIndicator()

PositionIndicator com.sygic.sdk.map.MapView.getPositionIndicator ( )

Returns the PositionIndicator.

◆ getView()

View com.sygic.sdk.map.MapView.getView ( )

Returns object represents display surface for OpenGL rendering It may be android.view.SurfaceView or android.view.TextureView, depends on surface type while creating fragment

Returns
Object represents display surface for OpenGL rendering. May return null, after MapFragment is destroyed.

◆ getWarningsTypeVisibilityInternal()

boolean com.sygic.sdk.map.MapView.getWarningsTypeVisibilityInternal ( final @WarningsType int  type)

◆ isValid()

boolean com.sygic.sdk.map.MapView.isValid ( )

Checks if Mapview is valid. It becomes invalid after MapFragment gets destroyed. If invalid, all setters do nothing and all getters return 0, null or invalid objects.

Returns
true if valid

◆ removeClusterLayer()

boolean com.sygic.sdk.map.MapView.removeClusterLayer ( final ClusterLayer  cluster)

Remove cluster of markers from map

◆ removeDataReadyListener()

void com.sygic.sdk.map.MapView.removeDataReadyListener ( final DataReadyListener  listener)

◆ removeEglCallback()

void com.sygic.sdk.map.MapView.removeEglCallback ( @NonNull final GlSurfaceListener.EglCallback  callback)

Removes callback for underlying OpenGL calls of swap buffers.

Parameters
callbackGlSurfaceListener.EglCallback callback to unregister.

◆ removeGeoCoordinateToScreenPointListener()

synchronized void com.sygic.sdk.map.MapView.removeGeoCoordinateToScreenPointListener ( final GeoCoordinateToScreenPointCallback  callback)

◆ removeMapGestureListener()

boolean com.sygic.sdk.map.MapView.removeMapGestureListener ( MapGesturesDetector.MapGestureListener  listener)

Removes the map gesture listener.

Returns
true
if the listener was found and removed

◆ removeValidityListener()

void com.sygic.sdk.map.MapView.removeValidityListener ( final MapValidityListener  listener)

◆ requestObjectsAtPoint()

int com.sygic.sdk.map.MapView.requestObjectsAtPoint ( final float  x,
final float  y,
final RequestObjectCallback  callback 
)

Requests the information about point on map

Parameters
xX screen coordinate
yY screen coordinate
callbackRequestObjectCallback
Returns
unique id of the request

◆ scaleScreenToView() [1/2]

float com.sygic.sdk.map.MapView.scaleScreenToView ( final float  value)

◆ scaleScreenToView() [2/2]

int com.sygic.sdk.map.MapView.scaleScreenToView ( final int  value)

◆ screenPointsFromGeoCoordinates()

List<Point> com.sygic.sdk.map.MapView.screenPointsFromGeoCoordinates ( final @NonNull List< GeoCoordinates >  geoCoordinates)

Returns geo coordinates of the point on the map regarding of screen coordinates.

Parameters
geoCoordinateslist of geo coordinates
Returns
List of screen points on the map or empty if is not possible to translate.

◆ setFpsLimit()

void com.sygic.sdk.map.MapView.setFpsLimit ( final FpsConfig  fpsConfig)

◆ setIncidentWarningSettings()

void com.sygic.sdk.map.MapView.setIncidentWarningSettings ( @NonNull final IncidentWarningSettings  settings)

◆ setIncidentWarningSettingsInternal()

void com.sygic.sdk.map.MapView.setIncidentWarningSettingsInternal ( @Nullable final IncidentWarningSettings  settings)

◆ setLogisticInfoSettings()

void com.sygic.sdk.map.MapView.setLogisticInfoSettings ( @NonNull final LogisticInfoSettings  settings)

◆ setMapLanguage()

void com.sygic.sdk.map.MapView.setMapLanguage ( final @NonNull Locale  locale)

Sets the language for map This will affect language of displayed names on map

Parameters
localeThe language for map

◆ setMapLanguageInternal()

void com.sygic.sdk.map.MapView.setMapLanguageInternal ( final @NonNull Locale  locale)

◆ setMapLayerCategoryVisibility()

void com.sygic.sdk.map.MapView.setMapLayerCategoryVisibility ( final @MapLayerCategory int  category,
final boolean  enable 
)

◆ setMapLayerCategoryVisibilityInternal()

void com.sygic.sdk.map.MapView.setMapLayerCategoryVisibilityInternal ( final @MapLayerCategory int  category,
final boolean  enable 
)

◆ setMapSpeedUnits()

void com.sygic.sdk.map.MapView.setMapSpeedUnits ( final @SpeedUnits int  units)

◆ setMapSpeedUnitsInternal()

void com.sygic.sdk.map.MapView.setMapSpeedUnitsInternal ( final @SpeedUnits int  units)

◆ setMapWarningSettings()

void com.sygic.sdk.map.MapView.setMapWarningSettings ( @NonNull final MapWarningSettings  settings)

◆ setMapWarningSettingsInternal()

void com.sygic.sdk.map.MapView.setMapWarningSettingsInternal ( @Nullable final MapWarningSettings  settings)

◆ setPixelFormat()

void com.sygic.sdk.map.MapView.setPixelFormat ( final int  pixelFormat)

◆ setWarningsTypeVisibilityInternal()

void com.sygic.sdk.map.MapView.setWarningsTypeVisibilityInternal ( final @WarningsType int  type,
final boolean  enable 
)

◆ setZOrderMediaOverlay()

void com.sygic.sdk.map.MapView.setZOrderMediaOverlay ( final boolean  isMediaOverlay)

◆ setZOrderOnTop()

void com.sygic.sdk.map.MapView.setZOrderOnTop ( final boolean  isOnTop)

◆ showDebugView()

void com.sygic.sdk.map.MapView.showDebugView ( final boolean  enable)
The documentation for this class was generated from the following file: