Package com.naver.maps.map.overlay

Class PolygonOverlay

java.lang.Object
com.naver.maps.map.overlay.Overlay
com.naver.maps.map.overlay.PolygonOverlay
All Implemented Interfaces:
Pickable
public final class PolygonOverlay extends Overlay
지도에 도형을 나타내는 오버레이.

  • Field Details

  • Constructor Details

    • PolygonOverlay

      public PolygonOverlay()
      기본 생성자.

    • PolygonOverlay

      public PolygonOverlay(@NonNull @Size(min=3L) List<com.naver.maps.geometry.LatLng> coords)
      좌표열을 지정하는 생성자. 만약 coords의 크기가 3 미만이면 IllegalArgumentException이 발생합니다.
      Parameters:
      coords - 좌표열.
      Throws:
      IllegalArgumentException - coords의 크기가 3 미만일 경우 발생.

  • Method Details

    • setMap

      public void setMap(@Nullable NaverMap map)
      오버레이를 map에 추가합니다. map에 null을 지정하면 지도에서 제거됩니다.

      PolygonOverlay를 지도에 추가하기 전에는 반드시 setCoords(List)로 좌표열을 지정해야 합니다. 그렇지 않을 경우 IllegalStateException이 발생합니다.
      Overrides:
      setMap in class Overlay
      Parameters:
      map - 오버레이를 추가할 지도 객체.
      Throws:
      IllegalStateException - coords를 지정하지 않았을 경우 발생.

    • getGlobalZIndex

      public int getGlobalZIndex()
      전역 Z 인덱스를 반환합니다. 여러 오버레이가 화면에서 겹쳐지면 전역 Z 인덱스가 큰 오버레이가 작은 오버레이를 덮습니다. 또한 값이 0 이상이면 오버레이가 심벌 위에, 0 미만이면 심벌 아래에 그려집니다.

      기본값은 DEFAULT_GLOBAL_Z_INDEX입니다.
      Overrides:
      getGlobalZIndex in class Overlay
      Returns:
      전역 Z 인덱스.

    • setGlobalZIndex

      public void setGlobalZIndex(int globalZIndex)
      전역 Z 인덱스를 지정합니다. 여러 오버레이가 화면에서 겹쳐지면 전역 Z 인덱스가 큰 오버레이가 작은 오버레이를 덮습니다. 또한 값이 0 이상이면 오버레이가 심벌 위에, 0 미만이면 심벌 아래에 그려집니다.

      기본값은 DEFAULT_GLOBAL_Z_INDEX입니다.
      Overrides:
      setGlobalZIndex in class Overlay
      Parameters:
      globalZIndex - 전역 Z 인덱스.

    • getCoords

      @UiThread @NonNull public List<com.naver.maps.geometry.LatLng> getCoords()
      좌표열을 반환합니다.
      Returns:
      좌표열.

    • setCoords

      @UiThread public void setCoords(@NonNull @Size(min=3L) List<com.naver.maps.geometry.LatLng> coords)
      좌표열을 지정합니다. 만약 coords의 크기가 3 미만이면 IllegalArgumentException이 발생합니다. coords에 null이거나 유효하지 않은(LatLng.isValid()가 false인) 좌표가 있다면 Overlay.InvalidCoordinateException이 발생합니다.
      Parameters:
      coords - 좌표열.
      Throws:
      IllegalArgumentException - coords의 크기가 3 미만일 경우 발생.
      Overlay.InvalidCoordinateException - coords에 유효하지 않은 좌표가 있을 경우 발생.

    • getBounds

      @NonNull @UiThread public com.naver.maps.geometry.LatLngBounds getBounds()
      오버레이가 차지하는 영역을 반환합니다. setCoords(List)로 지정한 좌표열의 영역과 동일합니다.

      기본값은 빈(LatLngBounds.isEmpty()가 true인) 영역입니다.
      Returns:
      영역.

    • getHoles

      @NonNull @UiThread public List<List<com.naver.maps.geometry.LatLng>> getHoles()
      내부 홀의 목록을 반환합니다.
      Returns:
      내부 홀 목록.

    • setHoles

      @UiThread public void setHoles(@NonNull List<List<com.naver.maps.geometry.LatLng>> holes)
      내부 홀의 목록을 지정합니다. 각 홀의 좌표열은 폴리곤의 외곽 좌표열과 반대 방향으로 감겨 있어야 합니다. 즉, 외곽 좌표열이 시계 방향이라면 내부 홀의 좌표열은 시계 반대 방향이어야 합니다. 빈 목록을 지정할 경우 내부 홀이 없는 폴리곤이 그려집니다. 만약 각 홀의 크기가 2 미만이면 IllegalArgumentException이 발생합니다. 각 홀에 null이거나 유효하지 않은(LatLng.isValid()가 false인) 좌표가 있다면 Overlay.InvalidCoordinateException이 발생합니다.
      Parameters:
      holes - 내부 홀 목록.
      Throws:
      IllegalArgumentException - 각 홀의 크기가 2 미만일 경우 발생.
      Overlay.InvalidCoordinateException - 각 홀에 유효하지 않은 좌표가 있을 경우 발생.

    • getColor

      @ColorInt @UiThread public int getColor()
      면의 색상을 반환합니다.

      기본값은 Color.WHITE입니다.
      Returns:
      면의 색상.

    • setColor

      @UiThread public void setColor(@ColorInt int color)
      면의 색상을 지정합니다.

      기본값은 Color.WHITE입니다.
      Parameters:
      color - 면의 색상.

    • getOutlineWidth

      @Px @UiThread public int getOutlineWidth()
      테두리의 두께를 반환합니다. 0일 경우 테두리가 그려지지 않습니다.

      기본값은 0입니다.
      Returns:
      두께. 픽셀 단위.

    • setOutlineWidth

      @UiThread public void setOutlineWidth(@Px int width)
      테두리의 두께를 지정합니다. 0일 경우 테두리가 그려지지 않습니다.

      기본값은 0입니다.
      Parameters:
      width - 두께. 픽셀 단위.

    • getOutlineColor

      @ColorInt @UiThread public int getOutlineColor()
      테두리의 색상을 반환합니다.

      기본값은 Color.BLACK입니다.
      Returns:
      테두리의 색상.

    • setOutlineColor

      @UiThread public void setOutlineColor(@ColorInt int color)
      테두리의 색상을 지정합니다.

      기본값은 Color.BLACK입니다.
      Parameters:
      color - 테두리의 색상.

    • getOutlinePattern

      @NonNull @Size(multiple=2L) @UiThread public int[] getOutlinePattern()
      테두리의 점선 패턴을 반환합니다. 패턴은 픽셀 단위의 배열로 표현되며, 각각 2n번째 요소는 실선의 길이, 2n + 1번째 요소는 공백의 길이를 의미합니다. 빈 배열일 경우 실선이 됩니다.

      기본값은 빈 배열입니다.
      Returns:
      점선 패턴.

    • setOutlinePattern

      @UiThread public void setOutlinePattern(@Size(multiple=2L) int... pattern)
      테두리의 점선 패턴을 지정합니다. 패턴은 픽셀 단위의 배열로 표현되며, 각각 2n번째 요소는 실선의 길이, 2n + 1번째 요소는 공백의 길이를 의미합니다. 빈 배열일 경우 실선이 됩니다.

      기본값은 빈 배열입니다.
      Parameters:
      pattern - 점선 패턴.