Package globus.glmap

Class GLMapVectorObject

java.lang.Object
globus.glmap.GLNativeObject
globus.glmap.GLMapVectorObject
All Implemented Interfaces:
GLMapTagsContainer
public class GLMapVectorObject extends GLNativeObject implements GLMapTagsContainer
GLMapVectorObject is a bridge class, to work with GLMap internal representation of vector object.

  • Field Details

    • drawAttributes

      @Nullable public GLMapVectorStyle drawAttributes
      Draw attributes of object. Filled by updateDrawAttributes functions.

  • Method Details

    • compare

      public int compare(@Nullable GLMapVectorObject other)
      Compare objects for sorting
      Parameters:
      other - other object
      Returns:
      0 if objects are equal. -1 if other is greater. 1 if other is less.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object other)
      Overrides:
      equals in class Object

    • createFromGeoJSONOrError

      public static Object createFromGeoJSONOrError(@NonNull String geoJSON)
      Creates an array of GLMapVectorObject from string
      Parameters:
      geoJSON - source string with geo JSON data
      Returns:
      objects constructed from geo JSON data

    • createFromGeoJSONOrThrow

      public static GLMapVectorObjectList createFromGeoJSONOrThrow(@NonNull String geoJSON) throws Exception
      Create objects from geo-json string throws if error happens
      Parameters:
      geoJSON - geo-json string
      Returns:
      vector objects
      Throws:
      Exception - if error happens

    • createFromGeoJSONStreamOrError

      @Nullable public static Object createFromGeoJSONStreamOrError(@NonNull InputStream geoJSON)
      Creates an array of GLMapVectorObject from stream
      Parameters:
      geoJSON - stream with geo JSON data
      Returns:
      objects constructed from geo JSON data

    • createFromGeoJSONStreamOrThrow

      @NonNull public static GLMapVectorObjectList createFromGeoJSONStreamOrThrow(@NonNull InputStream geoJSON) throws Exception
      Create objects from geo-json stream
      Parameters:
      geoJSON - geo-json stream
      Returns:
      vector objects
      Throws:
      Exception - if an error happens

    • createMultiline

      @NonNull public static GLMapVectorObject createMultiline(@NonNull MapPoint[][] multilinePoints)
      Loads multiline geometry to vector object 
      
 MapPoint[] line1 = new MapPoint[5];
 line1[0] = new MapPoint(27.7151, 53.8869); // Minsk
 line1[1] = new MapPoint(30.5186, 50.4339); // Kiev
 line1[2] = new MapPoint(21.0103, 52.2251); // Warsaw
 line1[3] = new MapPoint(13.4102, 52.5037); // Berlin
 line1[4] = new MapPoint(2.3343, 48.8505); // Paris
 MapPoint[] line2 = new MapPoint[3];
 line2[0] = new MapPoint(4.9021, 52.3690); // Amsterdam
 line2[1] = new MapPoint(4.3458, 50.8263); // Brussel
 line2[2] = new MapPoint(6.1296, 49.6072); // Luxembourg
 MapPoint[][] multiline = {line1, line2};
 obj.loadMultiline(multiline);
      Parameters:
      multilinePoints - Data to load to vector object
      Returns:
      Created vector object with multiline

    • createMultilineGeo

      @NonNull public static GLMapVectorObject createMultilineGeo(@NonNull MapGeoPoint[][] multilinePoints)
      Creates vector object with multiline geometry
      Parameters:
      multilinePoints - geo points of multiline
      Returns:
      vector object with multiline

    • createPoint

      @NonNull public static GLMapVectorObject createPoint(@NonNull MapPoint point)
      Loads point to vector object
      Parameters:
      point - Data to load to vector object
      Returns:
      Created vector object with multiline

    • createGeoPoint

      @NonNull public static GLMapVectorObject createGeoPoint(@NonNull MapGeoPoint point)
      Create vector object with point geometry
      Parameters:
      point - point of object
      Returns:
      vector object with point geometry

    • createPolygon

      @NonNull public static GLMapVectorObject createPolygon(@NonNull MapPoint[][] outerRings, @Nullable MapPoint[][] innerRings)
      Loads polygon geometry to vector object. 
      
 MapPoint[][] outerRings = {outerRing1, outerRing2};
 MapPoint[][] innerRings = {innerRing}, innerRing2};
 obj.loadPolygon(outerRings, innerRings);
      Parameters:
      outerRings - outer rings of polygon.
      innerRings - inner rings of polygons (holes).
      Returns:
      Created vector object with polygon.

    • createPolygonGeo

      @NonNull public static GLMapVectorObject createPolygonGeo(@NonNull MapGeoPoint[][] outerRings, @Nullable MapGeoPoint[][] innerRings)
      Creates vector object with polygon geometry
      Parameters:
      outerRings - outer rings of polygon
      innerRings - inner tings of polygon
      Returns:
      Created vector object with polygon geometry

    • createGeoLine

      @NonNull public static GLMapVectorObject createGeoLine(@NonNull MapGeoPoint start, @NonNull MapGeoPoint end, double quality)
      Adds big circle line from `start` to `end`. Useful to display plane routes. Should be used only on empty `GLMapVectorObject`
      Parameters:
      start - Start point
      end - End point
      quality - Maximum distance from point to line, used for simplification in Douglas Peucker algorithm. Units is map internal coordinates.
      Returns:
      Created vector object with geo-line.

    • getType

      public int getType()
      Retrieves the type of this vector object.
      Returns:
      The type of the object, which can be one of the constants defined in GLMapVectorObject.Type.

    • point

      @NonNull public MapPoint point()
      Retrieves a point associated with this vector object.
      Returns:
      A MapPoint representing a point belonging to the object.

    • getBBox

      @NonNull public GLMapBBox getBBox()
      Retrieves the bounding box of this vector object.
      Returns:
      A GLMapBBox representing the object's bounding box.

    • getMultilinePoints

      @Nullable public MapPoint[][] getMultilinePoints()
      Retrieves the points of a multiline for an object whose type is GLMapVectorObject.Type.Line.
      Returns:
      A two-dimensional array of MapPoint objects, or null if the object is not of type GLMapVectorObject.Type.Line.

    • getMultilineGeoPoints

      @Nullable public MapGeoPoint[][] getMultilineGeoPoints()
      Retrieves the geo-referenced points of a multiline for an object whose type is GLMapVectorObject.Type.Line.
      Returns:
      A two-dimensional array of MapGeoPoint objects, or null if the object is not of type GLMapVectorObject.Type.Line.

    • asGeoJSON

      @Nullable public String asGeoJSON()
      Serialize object as GeoJSON
      Returns:
      GeoJSON string

    • findNearestPoint

      @Nullable public MapPoint findNearestPoint(@NonNull GLMapViewRenderer renderer, @NonNull MapPoint point, double distanceInPoints)
      Calculates nearest point of vector object from given point
      Parameters:
      renderer - where track is displayed
      point - Point from where calculate nearest point
      distanceInPoints - maximum distance from track in points
      Returns:
      nearest point on track from given point or null if track is too far from given point

    • valueForKey

      @Nullable public GLMapValue valueForKey(String key)
      Description copied from interface: GLMapTagsContainer
      Returns value for the key
      Specified by:
      valueForKey in interface GLMapTagsContainer
      Parameters:
      key - Key of requested value
      Returns:
      value associated with given key. (if loaded from geo JSON get values from "properties" section)

    • valuesForKey

      @Nullable public GLMapValue[] valuesForKey(String key)
      Description copied from interface: GLMapTagsContainer
      Returns values for the key
      Specified by:
      valuesForKey in interface GLMapTagsContainer
      Parameters:
      key - Key of requested values
      Returns:
      array of values associated with given key

    • setValueForKey

      public void setValueForKey(@NonNull String key, @Nullable String value)
      Description copied from interface: GLMapTagsContainer
      Sets value for key
      Specified by:
      setValueForKey in interface GLMapTagsContainer
      Parameters:
      key - Key of value
      value - value to set

    • localizedName

      @Nullable public GLMapValue localizedName(@NonNull GLMapLocaleSettings localeSettings)
      Description copied from interface: GLMapTagsContainer
      Returns localized name.
      Specified by:
      localizedName in interface GLMapTagsContainer
      Parameters:
      localeSettings - locale settings to use
      Returns:
      name of object

    • copyProperties

      public void copyProperties(GLMapTagsContainer other)
      Description copied from interface: GLMapTagsContainer
      Copies all properties from another tags container object.
      Specified by:
      copyProperties in interface GLMapTagsContainer
      Parameters:
      other - Other tags container.

    • updateDrawAttributes

      public boolean updateDrawAttributes(@NonNull GLMapViewRenderer mapView, @Nullable GLMapVectorCascadeStyle style)
      Updates draw attributes
      Parameters:
      mapView - view where object is displayed
      style - style of object or null to use map view style
      Returns:
      true if visible

    • updateDrawAttributes

      public boolean updateDrawAttributes(@NonNull GLMapVectorCascadeStyle style, @NonNull GLMapLocaleSettings localeSettings, int zoomLevel)
      Updates draw attributes
      Parameters:
      style - style of object
      localeSettings - locale settings
      zoomLevel - zoom to test
      Returns:
      true if visible

    • updateDrawAttributes

      public boolean updateDrawAttributes(@NonNull GLMapViewRenderer mapView)
      Updates draw attributes
      Parameters:
      mapView - view where object is displayed
      Returns:
      true if visible