com.amap.api.maps.model

## 类 GroundOverlay

- java.lang.Object
- - com.amap.api.maps.model.BaseOverlay
  - - com.amap.api.maps.model.GroundOverlay

-     public final class GroundOverlay
      extends BaseOverlay

  定义在地图上绘制一个 Ground 覆盖物（一张图片以合适的大小贴在地图上的图片层）
  - 位置： 可以通过设置中心点或者图片区域来确定图片层的位置。在添加图片层之前，如果不设置中心点或者图片区域，会报IllegalArgumentException异常。
  - 图片： 覆盖物的贴图。在添加图片层之前，如果没有设置图片，会报IllegalArgumentException 异常。
  - 角度： 图片从正北开始，顺时针方向旋转，中心点为锚点。
  - Z轴 ： Z轴是控制地图覆盖物（overlay）之间的绘制层次的参数。这个参数能够控制Circles、Polygons、Polyline的绘制层次，但不会影响marker。Z轴数值越大的覆盖物（overlay）将会绘制在更上层。如果两个及两个以上覆盖物（overlay）的Z轴数值相同，则最后的绘制结果是随机的 。覆盖物（overlay）的默认为Z轴为0。
  - 可见：这个属性表示了线段是否可以显示在地图上。如果设置为不可见，则绘制地图时不会绘制此线段，但其他属性不受影响。默认为可见。

    线段属性的修改必须在主线程里调用，否则将会抛出IllegalStateException。

  Define a Ground overlay on the map (an image layer of a picture pasted on the map at an appropriate size)
  - Location: The position of the image layer can be determined by setting the center point or the image area. Before adding the image layer, if the center point or image area is not set, an IllegalArgumentException exception will be thrown.
  - Image: The texture of the overlay. Before adding the image layer, if the image is not set, an IllegalArgumentException exception will be thrown.
  - Angle: The image rotates clockwise from true north, with the center point as the anchor.
  - Z-axis: The Z-axis is a parameter that controls the drawing hierarchy between map overlays. This parameter can control the drawing hierarchy of Circles, Polygons, and Polylines, but it will not affect markers. Overlays with larger Z-axis values will be drawn on top. If two or more overlays have the same Z-axis value, the final drawing result is random. The default Z-axis for overlays is 0.
  - Visibility: This attribute indicates whether the line segment can be displayed on the map. If set to invisible, the line segment will not be drawn when the map is drawn, but other attributes are not affected. The default is visible.

    Modifications to the line segment attributes must be called in the main thread, otherwise an IllegalStateException will be thrown.

  从以下版本开始:
    2.1.4

- - ### 字段概要

    - ### 从类继承的字段 com.amap.api.maps.model.BaseOverlay

      `Field1, Field2, overlayName`

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `void` | `destroy()` 销毁地面覆盖物资源 Destroy ground overlay resources
    `float` | `getBearing()` 获取ground 覆盖物旋转的角度。
    `LatLngBounds` | `getBounds()` 获取ground 覆盖物的地理坐标范围。
    `float` | `getHeight()` 获取ground 覆盖物的高。
    `java.lang.String` | `getId()` 得到Ground 覆盖物的Id，一个地图上的每个图片层都有自己的ID。
    `LatLng` | `getPosition()` 获取 ground 覆盖物位置。
    `float` | `getTransparency()` 获取ground 覆盖物的透明度。
    `float` | `getWidth()` 获取 ground 覆盖物的宽度。
    `float` | `getZIndex()` 获取ground 覆盖物的z轴指数。
    `boolean` | `isVisible()` 得到当前ground 覆盖物的可见性。
    `void` | `remove()` 从地图中删除当前 Ground 覆盖物，删除后它的所有方法不可用。
    `void` | `setBearing(float bearing)` 设置ground 覆盖物从正北开始顺时针旋转的角度，中心点为锚点。
    `void` | `setDimensions(float width)` 设置ground 覆盖物的宽度，ground 覆盖物的高度根据图片的比例自动变化。
    `void` | `setDimensions(float width, float height)` 设置ground 覆盖物的宽度和高度，图片会被拉伸，可能不会保留之前的图片比例。
    `void` | `setImage(BitmapDescriptor icon)` 设置ground 覆盖物的图片信息，新图片会使用老图片的矩形区域。
    `void` | `setPosition(LatLng latLng)` 设置ground 覆盖物的位置，ground 覆盖物的其他属性不变。
    `void` | `setPositionFromBounds(LatLngBounds latLngBounds)` 根据矩形区域设置ground 覆盖物的位置。
    `void` | `setTransparency(float transparency)` 设置ground 覆盖物的透明度，默认为0，不透明。
    `void` | `setVisible(boolean visible)` 设置ground 覆盖物是否可见。
    `void` | `setZIndex(float zIndex)` 设置ground 覆盖物的z轴指数。

    - ### 从类继承的方法 com.amap.api.maps.model.BaseOverlay

      `method1, method2`

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 方法详细资料

    - #### remove

          public void remove()

      从地图中删除当前 Ground 覆盖物，删除后它的所有方法不可用。
      Remove the current Ground overlay from the map, and all its methods will be unavailable after deletion.
      从以下版本开始:
        2.1.4

    - #### getId

          public java.lang.String getId()

      得到Ground 覆盖物的Id，一个地图上的每个图片层都有自己的ID。
      Get the ID of the Ground overlay, each image layer on the map has its own ID.
      返回:
        当前Ground 覆盖物的Id。
        The ID of the current Ground overlay.
      从以下版本开始:
        2.1.4

    - #### setPosition

          public void setPosition(LatLng latLng)

      设置ground 覆盖物的位置，ground 覆盖物的其他属性不变。
      Set the position of the ground overlay, other attributes of the ground overlay remain unchanged.
      参数:
        `latLng` - 可以设置ground 覆盖物的位置的锚点。
        The anchor point of the ground overlay's position can be set.
      从以下版本开始:
        2.1.4

    - #### getPosition

          public LatLng getPosition()

      获取 ground 覆盖物位置。
      Get the position of the ground overlay.
      返回:
        ground 覆盖物的位置。
        The position of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### setDimensions

          public void setDimensions(float width)

      设置ground 覆盖物的宽度，ground 覆盖物的高度根据图片的比例自动变化。
      Set the width of the ground overlay, the height of the ground overlay will automatically change according to the image's aspect ratio.
      参数:
        `width` - ground覆盖物的宽度，单位：米。
        The width of the ground overlay, unit: meters.
      从以下版本开始:
        2.1.4

    - #### setImage

          public void setImage(BitmapDescriptor icon)

      设置ground 覆盖物的图片信息，新图片会使用老图片的矩形区域。
      Set the image information of the ground overlay, the new image will use the rectangular area of the old image.
      参数:
        `icon` - 新图片。
        New image.
      从以下版本开始:
        2.1.4

    - #### setDimensions

          public void setDimensions(float width,
                                    float height)

      设置ground 覆盖物的宽度和高度，图片会被拉伸，可能不会保留之前的图片比例。
      Set the width and height of the ground overlay, the image will be stretched and may not retain the previous image's aspect ratio.
      参数:
        `width` - ground 覆盖物的宽度。单位:米
        The width of the ground overlay. Unit: meters
        `height` - ground 覆盖物的高度。单位:米
        The height of the ground overlay. Unit: meters
      从以下版本开始:
        2.1.4

    - #### getWidth

          public float getWidth()

      获取 ground 覆盖物的宽度。
      Get the width of the ground overlay.
      返回:
        ground 覆盖物的宽。单位:米
        The width of the ground overlay. Unit: meters
      从以下版本开始:
        2.1.4

    - #### getHeight

          public float getHeight()

      获取ground 覆盖物的高。
      Get the height of the ground overlay.
      返回:
        ground 覆盖物的高。单位:米
        The height of the ground overlay. Unit: meters
      从以下版本开始:
        2.1.4

    - #### setPositionFromBounds

          public void setPositionFromBounds(LatLngBounds latLngBounds)

      根据矩形区域设置ground 覆盖物的位置。当设置时忽略旋转的角度，但是画此ground 覆盖物时还是会使用之前的旋转角度。
      Set the position of the ground overlay according to the rectangular area. When setting, the rotation angle is ignored, but the previous rotation angle will still be used when drawing this ground overlay.
      参数:
        `latLngBounds` - 可以设置ground 覆盖物位置的矩形区域。（西南与东北坐标范围）
        The rectangular area of the ground overlay's position can be set. (Southwest and northeast coordinate range)
      从以下版本开始:
        2.1.4

    - #### getBounds

          public LatLngBounds getBounds()

      获取ground 覆盖物的地理坐标范围。
      Get the geographic coordinate range of the ground overlay.
      返回:
        ground 覆盖物位置的矩形区域（西南与东北坐标范围）。
        The rectangular area of the ground overlay's position (southwest and northeast coordinate range).
      从以下版本开始:
        2.1.4

    - #### setBearing

          public void setBearing(float bearing)

      设置ground 覆盖物从正北开始顺时针旋转的角度，中心点为锚点。
      Set the angle of the ground overlay's clockwise rotation from true north, with the center point as the anchor.
      参数:
        `bearing` - 旋转的角度。
        The rotation angle.
      从以下版本开始:
        2.1.4

    - #### getBearing

          public float getBearing()

      获取ground 覆盖物旋转的角度。
      Get the rotation angle of the ground overlay.
      返回:
        旋转的角度。
        The rotation angle.
      从以下版本开始:
        2.1.4

    - #### setZIndex

          public void setZIndex(float zIndex)

      设置ground 覆盖物的z轴指数。
      Set the z-index of the ground overlay.
      参数:
        `zIndex` - ground 覆盖物的z轴指数。
        The z-index of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### getZIndex

          public float getZIndex()

      获取ground 覆盖物的z轴指数。
      Get the z-index of the ground overlay.
      返回:
        ground 覆盖物的z轴指数。
        The z-index of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### setVisible

          public void setVisible(boolean visible)

      设置ground 覆盖物是否可见。
      Set whether the ground overlay is visible.
      参数:
        `visible` - true 可见, false 不可见。
        true visible, false invisible.
      从以下版本开始:
        2.1.4

    - #### isVisible

          public boolean isVisible()

      得到当前ground 覆盖物的可见性。不管是否在屏幕中，只看是否在地图中存在。
      Get the visibility of the current ground overlay. Regardless of whether it is on the screen, only check if it exists in the map.
      返回:
        当前ground 覆盖物是否可见，true 可见，false 不可见。
        Whether the current ground overlay is visible, true for visible, false for invisible.
      从以下版本开始:
        2.1.4

    - #### setTransparency

          public void setTransparency(float transparency)

      设置ground 覆盖物的透明度，默认为0，不透明。
      Set the transparency of the ground overlay, default is 0, opaque.
      参数:
        `transparency` - 0~1之间的数值，0为不透明，1为全透明。
        A value between 0 and 1, where 0 is opaque and 1 is fully transparent.
      从以下版本开始:
        2.1.4

    - #### getTransparency

          public float getTransparency()

      获取ground 覆盖物的透明度。
      Get the transparency of the ground overlay.
      返回:
        ground 覆盖物的透明度。
        The transparency of the ground overlay.
      从以下版本开始:
        2.1.4

    - #### destroy

          public void destroy()

      销毁地面覆盖物资源
      Destroy ground overlay resources