DimScreen

open class DimScreen : NSObject

지도 뷰 전체를 어둡게 가리는 DimScreen 클래스.

KakaoMap에 종속되어 있으며 사용자가 별도로 생성할 수 없다. KakaoMap 인터페이스로 DimScreend의 On/Off가 가능하다.

screen에 원하는대로 Shape를 추가하여 특정 부분만 하이라이트 효과를 줄 수 있다.

PolygonShape Style Controls

  • PolygonStyleSet을 추가한다.

    PolygonShape의 Polygon이 여러개인 경우, Polygon마다 다른 스타일을 설정할 수 있다. 같은 styleID로 추가하더라도 overwrite되지 않는다.

    See also

    PolygonStyleSet

    Declaration

    Swift

    @objc
open func addPolygonStyleSet(_ styles: PolygonStyleSet)

    Parameters

    styles

    추가할 PolygonStyleSet

MapPolygonShape Controls

  • DimScreen에 MapPolygonShape를 추가한다.

    중복ID로는 추가할 수 없으며, 기존에 같은 아이디의 Shape가 존재할 경우 기존 객체를 리턴한다.

    Declaration

    Swift

    @objc
open func addHighlightMapPolygonShape(_ shapeOption: MapPolygonShapeOptions,
                                      callback: ((MapPolygonShape?) -> Void)? = nil) -> MapPolygonShape?

    Parameters

    shapeOption

    생성할 MapPolygonShape 옵션
    callback

    MapPolygonShape객체가 생성이 완료됐을 때 호출할 콜백함수(optional)

    Return Value

    생성된 MapPolygonShape 객체

  • DimScreen에 다수의 MapPolygonShape를 추가한다.

    중복ID로는 추가할 수 없으며, 기존에 같은 아이디의 Shape가 존재할 경우 기존 객체를 리턴한다.

    Declaration

    Swift

    @objc
open func addHighlightMapPolygonShapes(_ shapeOptions: [MapPolygonShapeOptions],
                                       callback: (([MapPolygonShape]?) -> Void)? = nil) -> [MapPolygonShape]?

    Parameters

    shapeOptions

    생성할 MapPolygonShape 옵션 배열
    callback

    MapPolygonShape객체가 모두 생성이 완료됐을 때 호출할 콜백함수(optional)

    Return Value

    생성된 MapPolygonShape 객체 배열

  • 현재 DimScreen에 속한 MapPolygonShape를 가져온다.

    Declaration

    Swift

    @objc
open func getHighlightMapPolygonShape(shapeID: String) -> MapPolygonShape?

    Parameters

    shapeID

    가져올 MapPolygonShape ID

    Return Value

    ID에 해당하는 MapPolygonShape 객체, 없을경우 nil.

  • 현재 DimScreen에 속한 다수의 MapPolygonShape를 가져온다.

    Declaration

    Swift

    @objc
open func getHighlightMapPolygonShapes(shapeIDs: [String]) -> [MapPolygonShape]?

    Parameters

    shapeIDs

    가져올 MapPolygonShape ID 배열

    Return Value

    ID에 해당하는 MapPolygonShape 객체 배열, 없을경우 nil.

  • 현재 DimScreen에 속한 모든 MapPolygonShape를 가져온다.

    Declaration

    Swift

    @objc
open func getAllHighlightMapPolygonShapes() -> [MapPolygonShape]?

    Return Value

    현재 DimScreen에 추가된 MapPolygonShape 배열

  • 현재 DimScreen에서 특정 MapPolygonShape를 지운다.

    Declaration

    Swift

    @objc
open func removeHighlightMapPolygonShape(shapeID: String, callback: (() -> Void)? = nil)

    Parameters

    shapeID

    DimScreen에서 제거할 MapPolygonShape Id
    callback

    DimScreen에서 해당 Shape제거가 완료되었을 때, 호출할 콜백함수(optional)

  • 현재 DimScreen에서 다수의 MapPolygonShape를 지운다.

    Declaration

    Swift

    @objc
open func removeHighlightMapPolygonShapes(shapeIDs: [String], callback: (() -> Void)? = nil)

    Parameters

    shapeID

    DimScreen에서 제거할 MapPolygonShape Id 배열
    callback

    DimScreen에서 id에 해당하는 모든 shape제거가 완료되었을 때, 호출할 콜백함수(optional)

  • 현재 DimScreen에 속한 특정 MapPolygonShape를 보여준다.

    Declaration

    Swift

    @objc
open func showHighlightMapPolygonShapes(shapeIDs: [String])

    Parameters

    shapeIDs

    보여줄 MapPolygonShape ID 배열

  • 현재 DimScreen에 속한 특정 MapPolygonShape를 숨긴다.

    Declaration

    Swift

    @objc
open func hideHighlightMapPolygonShapes(shapeIDs: [String])

    Parameters

    shapeIDs

    숨길 MapPolygonShape ID 배열

PolygonShape Controls

  • DimScreen에 PolygonShape를 추가한다.

    이미 추가한 ID로 추가할 수 없으며, 이 경우 기존의 객체가 리턴된다.

    Declaration

    Swift

    @objc
open func addHighlightPolygonShape(_ shapeOption: PolygonShapeOptions,
                                   callback: ((PolygonShape?) -> Void)? = nil) -> PolygonShape?

    Parameters

    shaepOption

    DimScreen에 추가할 PolygonShapeOptions
    callback

    DimScreen에 객체 추가가 완료되었을 때, 호출할 콜백함수(optional)

    Return Value

    추가된 PolygonShape 객체

  • DimScreen에 여러개의 PolygonShape를 추가한다.

    이미 추가한 ID로 추가할 수 없으며, 이 경우 기존의 객체가 리턴된다.

    Declaration

    Swift

    @objc
open func addHighlightPolygonShapes(_ shapeOptions: [PolygonShapeOptions],
                                    callback: (([PolygonShape]?) -> Void)? = nil) -> [PolygonShape]?

    Parameters

    shaepOptions

    DimScreen에 추가할 PolygonShapeOptions 배열
    callback

    DimScreen에 객체 추가가 모두 완료되었을 때, 호출할 콜백함수(optional)

    Return Value

    추가된 PolygonShape 객체 배열

  • DimScreen에 추가된 PolygonShape를 가져온다.

    Declaration

    Swift

    @objc
open func getHighlightPolygonShape(shapeID: String) -> PolygonShape?

    Parameters

    shapeID

    가져올 PolygonShape ID

    Return Value

    shapeID에 해당하는 Shape객체. 없을경우 nil 리턴

  • DimScreen에 추가된 다수의 PolygonShape를 가져온다.

    Declaration

    Swift

    @objc
public func getHighlightPolygonShapes(shapeIDs: [String]) -> [PolygonShape]?

    Parameters

    shapeIDs

    가져올 PolygonShape ID 배열

    Return Value

    shapeID에 해당하는 PolygonShape객체 배열. 없을경우 nil 리턴

  • DimScreen에 추가된 모든 PolygonShape를 가져온다.

    Declaration

    Swift

    @objc
open func getAllHighlightPolygonShapes() -> [PolygonShape]?

    Return Value

    DimScreen에 추가된 모든 PolygonShape 객체 배열

  • DimScreen에 추가된 특정 PolygonShape를 지운다.

    Declaration

    Swift

    @objc
open func removeHighlightPolygonShape(shapeID: String, callback: (() -> Void)? = nil)

    Parameters

    shapeID

    지울 PolygonShape ID
    callback

    제거가 완료되었을 때, 호출할 callback 함수(optional)

  • DimScreen에 추가된 다수의 PolygonShape를 지운다.

    Declaration

    Swift

    @objc
open func removeHighlightPolygonShapes(shapeIDs: [String], callback: (() -> Void)? = nil)

    Parameters

    shapeIDs

    지울 PolygonShape ID 배열
    callback

    제거가 완료되었을 때, 호출할 callback 함수(optional)

  • 현재 DimScreen에 속한 특정 PolygonShape를 보여준다.

    Declaration

    Swift

    @objc
public func showHighlightPolygonShapes(shapeIDs: [String])

    Parameters

    shapeIDs

    보여줄 PolygonShape ID 배열

  • 현재 DimScreen에 속한 특정 PolygonShape를 숨긴다.

    Declaration

    Swift

    @objc
public func hideHighlightPolygonShapes(shapeIDs: [String])

    Parameters

    shapeIDs

    숨길 PolygonShape ID 배열

  • DimScreen에 추가된 모든 Shape를 지운다.

    Declaration

    Swift

    @objc
open func clearAllHighlightShapes()

DimScreen Controls

  • DimScreen의 활성화 상태를 지정한다.

    true설정 시 DimScreen이 활성화 되어 표시된다. false 설정시 DimScreen이 비활성화된다.

    Declaration

    Swift

    @objc
open var isEnabled: Bool { get set }

  • DimScreen의 컬러값

    값을 설정하면 DimScreen의 컬러가 업데이트된다.

    Declaration

    Swift

    @objc
open var color: UIColor { get set }

  • DimScreen이 덮을 레이어 범위

    See also

    DimScreenCover

    Declaration

    Swift

    @objc
public var cover: DimScreenCover { get set }

ShapeAnimator Controls

  • ShapeAnimator를 추가한다.

    ShapeAnimator 객체는 사용자가 직접 생성할 수 없으며, Manager를 통해서만 생성이 가능하다. 이미 존재하는 AnimatorID로는 overwrite되지 않는다.

    See also

    AnimationInterpolation

    See also

    WaveTextAnimation

    Declaration

    Swift

    @objc
public func addShapeAnimator(animatorID: String, effect: ShapeAnimationEffect) -> ShapeAnimator?

    Parameters

    animatorID

    ShapeAnimator ID
    effect

    레벨별 애니메이션 효과 지정

    Return Value

    생성된 Animator 객체

  • 추가한 ShapeAnimator 객체를 제거한다.

    Declaration

    Swift

    @objc
public func removeShapeAnimator(animatorID: String)

    Parameters

    animatorID

    제거할 animatorID

  • 추가되어있는 모든 ShapeAnimaotr를 제거한다.

    Declaration

    Swift

    @objc
public func clearAllShapeAnimators()

  • 추가한 ShapeAnimator 객체를 가져온다.

    Declaration

    Swift

    @objc
public func getShapeAnimator(animatorID: String) -> ShapeAnimator?

    Parameters

    animatorID

    가져올 AnimatorID

    Return Value

    animatorID에 해당하는 ShapeAnimator 객체. 존재하지 않을 경우 nil 리턴