Package com.kakao.vectormap.shape

Class DimScreenLayer

java.lang.Object

com.kakao.vectormap.shape.DimScreenLayer

public class DimScreenLayer
extends java.lang.Object

지도 전체 영역을 어둡게 혹은 원하는 색상으로 덮는 레이어 클래스이다. DimScreenLayer 에 Shape 을 추가하여 특정 부분만 하이라이트 효과를 줄 수 있다.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DimScreenLayer.OnPolygonCreateCallback	Polygon 이 생성되면 호출되는 콜백 리스너.

Method Summary

Modifier and Type	Method	Description
Polygon[]	addDotPointPolygons(PolygonOptions... options)	DimScreenLayer 에 DotPoints 로 구성 된 Polygon 을 추가한다.
void	addDotPointPolygons(PolygonOptions[] options, DimScreenLayer.OnPolygonCreateCallback callback)	DimScreenLayer 에 DotPoints 로 구성 된 Polygon 을 추가한다.
Polygon[]	addMapPointPolygons(PolygonOptions... options)	DimScreenLayer 에 MapPoints 로 구성 된 Polygon 을 추가한다.
void	addMapPointPolygons(PolygonOptions[] options, DimScreenLayer.OnPolygonCreateCallback callback)	DimScreenLayer 에 MapPoints 로 구성 된 Polygon 을 추가한다.
Polygon	addPolygon(PolygonOptions options)	DimScreenLayer 에 Polygon 을 추가한다.
void	clearAll()	DimScreenLayer 에 추가 된 모든 Shape 들을 지운다.
Polygon	getPolygon(java.lang.String polygonId)	id 에 해당하는 Polygon 을 가져온다.
java.lang.Object	getTag()	태그를 가져온다.
void	remove(Polygon... polygons)	DimScreenLayer 에 추가됐던 Polygon 을 삭제한다.
void	setColor(int color)	DimScreenLayer 의 색상을 변경한다.
void	setDimScreenCover(DimScreenCover cover)	DimScreenLayer 이 덮는 영역을 설정한다.
void	setTag(java.lang.Object tag)	사용자가 원하는 커스텀한 태그를 설정한다.
void	setVisible(boolean visible)	DimScreenLayer 의 visible 여부를 설정한다.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addPolygon

@Nullable
public Polygon addPolygon(@NonNull
                          PolygonOptions options)

DimScreenLayer 에 Polygon 을 추가한다.

Parameters:

options - 추가 할 PolygonOptions

Returns:

생성 된 Polygon 객체

addMapPointPolygons

@Nullable
public Polygon[] addMapPointPolygons(@NonNull
                                     PolygonOptions... options)

DimScreenLayer 에 MapPoints 로 구성 된 Polygon 을 추가한다.

Parameters:

options - MapPoints 로 구성 된 PolygonOptions 배열

Returns:

생성 된 Polygon 배열

addMapPointPolygons

public void addMapPointPolygons(@NonNull
                                PolygonOptions[] options,
                                @Nullable
                                DimScreenLayer.OnPolygonCreateCallback callback)

DimScreenLayer 에 MapPoints 로 구성 된 Polygon 을 추가한다.

Parameters:

options - MapPoints 로 구성 된 PolygonOptions 배열

callback - Polygon 생성 완료 콜백 리스너

addDotPointPolygons

@Nullable
public Polygon[] addDotPointPolygons(@NonNull
                                     PolygonOptions... options)

DimScreenLayer 에 DotPoints 로 구성 된 Polygon 을 추가한다.

Parameters:

options - DotPoints 로 구성 된 PolygonOptions 배열

Returns:

생성 된 Polygon 배열

addDotPointPolygons

public void addDotPointPolygons(@NonNull
                                PolygonOptions[] options,
                                @Nullable
                                DimScreenLayer.OnPolygonCreateCallback callback)

DimScreenLayer 에 DotPoints 로 구성 된 Polygon 을 추가한다.

Parameters:

options - DotPoints 로 구성 된 PolygonOptions 배열

callback - Polygon 생성 완료 콜백 리스너

getPolygon

@Nullable
public Polygon getPolygon(@NonNull
                          java.lang.String polygonId)

id 에 해당하는 Polygon 을 가져온다.

Parameters:

polygonId - Polygon 의 id

Returns:

id 에 해당하는 Polygon, 없으면 null

setColor

public void setColor(int color)

DimScreenLayer 의 색상을 변경한다.

Parameters:

color - 변경 할 색상.

setVisible

public void setVisible(boolean visible)

DimScreenLayer 의 visible 여부를 설정한다.

Parameters:

visible - visible 여부.

remove

public void remove(@NonNull
                   Polygon... polygons)

DimScreenLayer 에 추가됐던 Polygon 을 삭제한다.

Parameters:

polygons - 삭제 할 Polygon 배열

setDimScreenCover

public void setDimScreenCover(@NonNull
                              DimScreenCover cover)

DimScreenLayer 이 덮는 영역을 설정한다.

Parameters:

cover - DimScreenLayer 이 덮는 영역

clearAll

public void clearAll()

DimScreenLayer 에 추가 된 모든 Shape 들을 지운다.

setTag

public void setTag(@Nullable
                   java.lang.Object tag)

사용자가 원하는 커스텀한 태그를 설정한다.

Parameters:

tag - 사용자가 원하는 커스텀한 태그

getTag

@Nullable
public java.lang.Object getTag()

태그를 가져온다.

Returns:

사용자가 넣은 태그