com.amap.api.maps.model

## 类 NavigateArrow

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

-     public class NavigateArrow
      extends BaseOverlay

  定义一个地图 箭头(NavigateArrow) 覆盖物 一个导航箭头是多个连贯点的集合，拥有以下属性：
  - 顶点

  箭头是由两个顶点之间连贯的点构成的。如果两个顶点相同，则一个箭头将闭合。

  - 宽度

  宽度是单位是像素。宽度是可视区域的缩放级别无关。默认为10。

  - 顶颜色

  箭头的顶颜色是ARGB格式，颜色格式可以参考android.graphics.Color。默认是黑色。

  - 侧边颜色

  箭头的侧边颜色是ARGB格式，颜色格式可以参考android.graphics.Color。默认是黑色。

  - Z轴

  Z轴是控制地图覆盖物（overlay）之间的绘制层次的参数。这个参数能够控制Circles、Polygons、Polyline的绘制层次，但不会影响marker。Z轴数值越大的覆盖物（overlay）将会绘制在更上层。如果两个及两个以上覆盖物（overlay）的Z轴数值相同，则最后的绘制结果是随机的。覆盖物（overlay）的默认为Z轴为0。

  - 可见

  这个属性表示了箭头是否可以显示在地图上。如果设置为不可见，则绘制地图时不会绘制此箭头，但其他属性不受影响。默认为可见。

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

  Define a map arrow (NavigateArrow) overlay. A navigation arrow is a collection of multiple connected points, with the following attributes:
  - Vertices

  The arrow is formed by connected points between two vertices. If the two vertices are the same, the arrow will be closed.

  - Width

  The width is in pixels. The width is independent of the zoom level of the visible area. The default is 10.

  - Top color

  The top color of the arrow is in ARGB format, and the color format can refer to android.graphics.Color. The default is black.

  - Side color

  The side color of the arrow is in ARGB format, and the color format can refer to android.graphics.Color. The default is black.

  - 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.

  - Visible

  This attribute indicates whether the arrow can be displayed on the map. If set to invisible, the arrow will not be drawn when the map is drawn, but other attributes will not be affected. The default is visible.

  Modifications to the arrow's attributes must be called in the main thread, otherwise an IllegalStateException will be thrown.

- - ### 字段概要

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

      `Field1, Field2, overlayName`

  - ### 方法概要

    所有方法 实例方法 具体方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `boolean` | `equals(java.lang.Object other)`
    `java.lang.String` | `getId()` 获取箭头(NavigateArrow)覆盖物的Id。
    `java.util.List<LatLng>` | `getPoints()` 获取箭头(NavigateArrow)覆盖物的顶点列表。
    `int` | `getSideColor()` 已过时。
    `int` | `getTopColor()` 获取(NavigateArrow)覆盖物的顶颜色。
    `float` | `getWidth()` 返回箭头(NavigateArrow)覆盖物的宽度值 Return the width value of the arrow (NavigateArrow) overlay.
    `float` | `getZIndex()` 获取箭头(NavigateArrow)覆盖物的z轴值。
    `int` | `hashCode()`
    `boolean` | `is3DModel()` 获取箭头(NavigateArrow)覆盖物是否是3D模式 Get whether the arrow (NavigateArrow) overlay is in 3D mode.
    `boolean` | `isVisible()` 获取箭头(NavigateArrow)覆盖物是否可见。
    `void` | `remove()` 从地图上删除当前箭头(NavigateArrow)覆盖物。
    `void` | `set3DModel(boolean enable)` 设置箭头(NavigateArrow)覆盖物的是否为3D模式。
    `void` | `setPoints(java.util.List<LatLng> points)` 设置箭头(NavigateArrow)覆盖物的顶点坐标。
    `void` | `setSideColor(int color)` 设置箭头(NavigateArrow)覆盖物的侧边颜色。
    `void` | `setTopColor(int color)` 设置箭头(NavigateArrow)覆盖物的顶部颜色 Set the top color of the arrow (NavigateArrow) overlay.
    `void` | `setVisible(boolean visible)` 设置箭头(NavigateArrow)覆盖物的是否可见。
    `void` | `setWidth(float width)` 设置箭头(NavigateArrow)覆盖物的宽度 Set the width of the arrow (NavigateArrow) overlay.
    `void` | `setZIndex(float zIndex)` 设置箭头(NavigateArrow)覆盖物Z轴的值。

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

      `method1, method2`

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

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

- - ### 方法详细资料

    - #### remove

          public void remove()

      从地图上删除当前箭头(NavigateArrow)覆盖物。删除后，对应的方法均无效。
      Remove the current arrow (NavigateArrow) overlay from the map. After removal, the corresponding methods will be invalid.
      从以下版本开始:
        2.3.0

    - #### getId

          public java.lang.String getId()

      获取箭头(NavigateArrow)覆盖物的Id。Id用于区分在同一个地图里面不同的箭头对象。
      Get the ID of the arrow (NavigateArrow) overlay. The ID is used to distinguish different arrow objects in the same map.
      返回:
        箭头(NavigateArrow)覆盖物的Id。
        The ID of the arrow (NavigateArrow) overlay.
      从以下版本开始:
        2.3.0

    - #### setPoints

          public void setPoints(java.util.List<LatLng> points)

      设置箭头(NavigateArrow)覆盖物的顶点坐标。如果调用此方法后修改了List的值将不会影响到箭头。
      Set the vertex coordinates of the arrow (NavigateArrow) overlay. If the value of the List is modified after calling this method, it will not affect the arrow.
      参数:
        `points` - 箭头顶点坐标集合。
        The collection of arrow vertex coordinates.
      从以下版本开始:
        2.3.0

    - #### getPoints

          public java.util.List<LatLng> getPoints()

      获取箭头(NavigateArrow)覆盖物的顶点列表。如果调用此方法后，线段的箭头发生了变化，列表的值不会随之改变。 如果调用此方法获得顶点坐标后并且修改了顶点坐标，也不会作用到当前线程。如果需要修改箭头的顶点值必须调用setPoints(List)。
      Get the vertex list of the arrow (NavigateArrow) overlay. If the arrow of the line segment changes after calling this method, the value of the list will not change. If you call this method to obtain the vertex coordinates and then modify the vertex coordinates, it will not affect the current thread. If you need to modify the vertex values of the arrow, you must call setPoints(List).
      返回:
        返回当前箭头的顶点列表。
        Return the vertex list of the current arrow.
      从以下版本开始:
        2.0

    - #### setWidth

          public void setWidth(float width)

      设置箭头(NavigateArrow)覆盖物的宽度
      Set the width of the arrow (NavigateArrow) overlay.
      参数:
        `width` - (NavigateArrow)覆盖物宽度 单位：像素
        The width of the (NavigateArrow) overlay in pixels.
      从以下版本开始:
        2.0

    - #### getWidth

          public float getWidth()

      返回箭头(NavigateArrow)覆盖物的宽度值
      Return the width value of the arrow (NavigateArrow) overlay.
      返回:
        (NavigateArrow)覆盖物的宽度 单位：像素
        The width of the (NavigateArrow) overlay in pixels.
      从以下版本开始:
        2.0

    - #### setTopColor

          public void setTopColor(int color)

      设置箭头(NavigateArrow)覆盖物的顶部颜色
      Set the top color of the arrow (NavigateArrow) overlay.
      参数:
        `color` - 颜色的ARGB格式
        The color in ARGB format.
      从以下版本开始:
        2.0

    - #### getTopColor

          public int getTopColor()

      获取(NavigateArrow)覆盖物的顶颜色。
      Get the top color of the (NavigateArrow) overlay.
      返回:
        当前箭头的顶颜色，ARGB格式。
        The top color of the current arrow in ARGB format.
      从以下版本开始:
        2.0

    - #### setSideColor

          public void setSideColor(int color)

      设置箭头(NavigateArrow)覆盖物的侧边颜色。 注意：v3.0中不再提供该方法。 注意：6.7.0中再次启用此方法。
      Set the side color of the arrow (NavigateArrow) overlay. Note: This method is no longer provided in v3.0. Note: This method is re-enabled in 6.7.0.
      参数:
        `color` - 侧边颜色，ARGB格式。
        The side color in ARGB format.
      从以下版本开始:
        2.0

    - #### getSideColor

          @Deprecated
          public int getSideColor()

      已过时。
      获取箭头(NavigateArrow)覆盖物的侧边颜色
      Get the side color of the arrow (NavigateArrow) overlay.
      返回:
        线段颜色的ARGB格式
        The color of the line segment in ARGB format.
      从以下版本开始:
        2.0

    - #### setZIndex

          public void setZIndex(float zIndex)

      设置箭头(NavigateArrow)覆盖物Z轴的值。
      Set the Z-axis value of the arrow (NavigateArrow) overlay.
      参数:
        `zIndex` - Z轴的值。
        The value of the Z-axis.
      从以下版本开始:
        2.0

    - #### getZIndex

          public float getZIndex()

      获取箭头(NavigateArrow)覆盖物的z轴值。
      Get the Z-axis value of the arrow (NavigateArrow) overlay.
      返回:
        当前箭头z轴的值。
        The Z-axis value of the current arrow.
      从以下版本开始:
        2.0

    - #### setVisible

          public void setVisible(boolean visible)

      设置箭头(NavigateArrow)覆盖物的是否可见。默认不可见
      Set whether the arrow (NavigateArrow) overlay is visible. By default, it is not visible.
      参数:
        `visible` - true：可见，false：不可见。
        true: visible, false: invisible.
      从以下版本开始:
        2.0

    - #### isVisible

          public boolean isVisible()

      获取箭头(NavigateArrow)覆盖物是否可见。
      Get whether the arrow (NavigateArrow) overlay is visible.
      返回:
        true：可见，false：不可见。
        true: visible, false: invisible.
      从以下版本开始:
        2.0

    - #### set3DModel

          public void set3DModel(boolean enable)

      设置箭头(NavigateArrow)覆盖物的是否为3D模式。默认为false。 设置为3D之后，箭头会悬空并增加厚度，此时`NavigateArrow.setSideColor(int)` 的值也会生效
      Set whether the arrow (NavigateArrow) overlay is in 3D mode. Default is false. When set to 3D, the arrow will float and increase in thickness, and the value of `NavigateArrow.setSideColor(int)` will also take effect.
      参数:
        `enable` - 一个表示箭头是为3D模式的布尔值，true表示3D，false表示不是3D即2D。
        A boolean value indicating whether the arrow is in 3D mode, true means 3D, false means not 3D, i.e., 2D.
      从以下版本开始:
        6.7.0

    - #### is3DModel

          public boolean is3DModel()

      获取箭头(NavigateArrow)覆盖物是否是3D模式
      Get whether the arrow (NavigateArrow) overlay is in 3D mode.
      返回:
        true：3D模式; false：非3D模式。
        true: 3D mode; false: non-3D mode.
      从以下版本开始:
        6.7.0

    - #### equals

          public boolean equals(java.lang.Object other)

      覆盖:
        `equals` 在类中 `java.lang.Object`

    - #### hashCode

          public int hashCode()

      覆盖:
        `hashCode` 在类中 `java.lang.Object`