Package com.naver.maps.map.overlay
Class GroundOverlay
- java.lang.Object
-
- com.naver.maps.map.overlay.Overlay
-
- com.naver.maps.map.overlay.GroundOverlay
-
- All Implemented Interfaces:
Pickable
public final class GroundOverlay extends Overlay
지도에서 특정 영역을 나타내는 오버레이. 지도에 추가하기 전에 반드시setBounds(LatLngBounds)
와setImage(OverlayImage)
를 호출해 영역 및 이미지를 지정해야 하며, 그렇지 않으면 예외가 발생합니다.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.naver.maps.map.overlay.Overlay
Overlay.InvalidBoundsException, Overlay.InvalidCoordinateException, Overlay.OnClickListener
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_GLOBAL_Z_INDEX
기본 전역 Z 인덱스.static OverlayImage
DEFAULT_IMAGE
기본 이미지.
-
Constructor Summary
Constructors Constructor Description GroundOverlay()
기본 생성자.GroundOverlay(LatLngBounds bounds, OverlayImage image)
영역과 이미지를 지정하는 생성자.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description float
getAlpha()
불투명도를0
~1
로 반환합니다.LatLngBounds
getBounds()
영역을 반환합니다.int
getGlobalZIndex()
전역 Z 인덱스를 반환합니다.OverlayImage
getImage()
이미지를 반환합니다.void
setAlpha(float alpha)
불투명도를0
~1
로 지정합니다.void
setBounds(LatLngBounds bounds)
영역을 지정합니다.void
setGlobalZIndex(int globalZIndex)
전역 Z 인덱스를 지정합니다.void
setImage(OverlayImage image)
이미지를 지정합니다.void
setMap(NaverMap map)
오버레이를map
에 추가합니다.-
Methods inherited from class com.naver.maps.map.overlay.Overlay
getMap, getMaxZoom, getMinZoom, getOnClickListener, getTag, getZIndex, isAdded, isMaxZoomInclusive, isMinZoomInclusive, isVisible, performClick, setMaxZoom, setMaxZoomInclusive, setMinZoom, setMinZoomInclusive, setOnClickListener, setTag, setVisible, setZIndex
-
-
-
-
Field Detail
-
DEFAULT_GLOBAL_Z_INDEX
public static final int DEFAULT_GLOBAL_Z_INDEX
기본 전역 Z 인덱스.- See Also:
setGlobalZIndex(int)
, Constant Field Values
-
DEFAULT_IMAGE
public static final OverlayImage DEFAULT_IMAGE
기본 이미지.- See Also:
setImage(OverlayImage)
-
-
Constructor Detail
-
GroundOverlay
public GroundOverlay()
기본 생성자.
-
GroundOverlay
public GroundOverlay(@NonNull LatLngBounds bounds, @NonNull OverlayImage image)
영역과 이미지를 지정하는 생성자. 만약bounds
가 빈(LatLngBounds.isEmpty()
가true
인) 영역이라면Overlay.InvalidBoundsException
이 발생합니다.- Parameters:
bounds
- 영역.image
- 이미지.- Throws:
Overlay.InvalidBoundsException
-bounds
가 유효하지 않은 경우 발생.
-
-
Method Detail
-
setMap
public void setMap(@Nullable NaverMap map)
오버레이를map
에 추가합니다.map
에null
을 지정하면 지도에서 제거됩니다.
지상 오버레이를 지도에 추가하기 전에는 반드시setBounds(LatLngBounds)
로 영역을 지정해야 합니다. 그렇지 않을 경우Overlay.InvalidBoundsException
이 발생합니다.- Overrides:
setMap
in classOverlay
- Parameters:
map
- 오버레이를 추가할 지도 객체.- Throws:
Overlay.InvalidBoundsException
-bounds
를 지정하지 않은 경우 발생.
-
getGlobalZIndex
public int getGlobalZIndex()
전역 Z 인덱스를 반환합니다. 여러 오버레이가 화면에서 겹쳐지면 전역 Z 인덱스가 큰 오버레이가 작은 오버레이를 덮습니다. 또한 값이0
이상이면 오버레이가 심벌 위에,0
미만이면 심벌 아래에 그려집니다.
기본값은DEFAULT_GLOBAL_Z_INDEX
입니다.- Overrides:
getGlobalZIndex
in classOverlay
- Returns:
- 전역 Z 인덱스.
-
setGlobalZIndex
public void setGlobalZIndex(int globalZIndex)
전역 Z 인덱스를 지정합니다. 여러 오버레이가 화면에서 겹쳐지면 전역 Z 인덱스가 큰 오버레이가 작은 오버레이를 덮습니다. 또한 값이0
이상이면 오버레이가 심벌 위에,0
미만이면 심벌 아래에 그려집니다.
기본값은DEFAULT_GLOBAL_Z_INDEX
입니다.- Overrides:
setGlobalZIndex
in classOverlay
- Parameters:
globalZIndex
- 전역 Z 인덱스.
-
getBounds
@NonNull @UiThread public LatLngBounds getBounds()
- Returns:
- 영역.
-
setBounds
@UiThread public void setBounds(@NonNull LatLngBounds bounds)
영역을 지정합니다. 지상 오버레이를 지도에 추가하기 전에 반드시 이 메서드를 호출해 영역을 지정해야 합니다. 만약bounds
가 빈(LatLngBounds.isEmpty()
가true
인) 영역이라면Overlay.InvalidBoundsException
이 발생합니다.- Parameters:
bounds
- 영역.- Throws:
Overlay.InvalidBoundsException
-bounds
가 유효하지 않은 경우 발생.
-
getImage
@NonNull @UiThread public OverlayImage getImage()
이미지를 반환합니다.- Returns:
- 이미지.
-
setImage
@UiThread public void setImage(@NonNull OverlayImage image)
이미지를 지정합니다.- Parameters:
image
- 이미지.
-
getAlpha
@UiThread public float getAlpha()
불투명도를0
~1
로 반환합니다.0
일 경우 완전히 투명,1
일 경우 완전히 불투명함을 의미합니다.
기본값은1
입니다.- Returns:
- 불투명도.
-
setAlpha
@UiThread public void setAlpha(float alpha)
불투명도를0
~1
로 지정합니다.0
일 경우 완전히 투명,1
일 경우 완전히 불투명함을 의미합니다.
기본값은1
입니다.- Parameters:
alpha
- 불투명도.
-
-