GuiBase

open class GuiBase : NSObject

Gui 베이스 클래스

Gui는 특성상 culling 이 되지 않으므로, 지도상의 특정 위치에 그려져서 화면에 그려지는 영역 밖에 있더라도 실제로 그려진다.

그러므로 다수의 Gui를 추가하게 되면 엔진 부하를 야기할 수 있다.

Gui Controls

  • Gui를 그린다.

    Declaration

    Swift

    @objc
open func show()

  • Gui를 숨긴다.

    Declaration

    Swift

    @objc
open func hide()

  • Gui가 그려지고 있던 경우 갱신하여 새로 그린다. 한번 Gui를 그린 상태에서 속성을 변경하고자 하는 경우, 이 함수를 호출해야 반영된다.

    Declaration

    Swift

    @objc
public func updateGui()

Event Handling

  • childComponent를 가져온다.

    Declaration

    Swift

    @objc
open func getChild(_ componentId: String) -> GuiComponentBase?

    Parameters

    componentId

    가져올 컴포넌트의 Id

    Return Value

    ComponentId에 해당하는 GuiComponent. 없을경우 nil

  • 탭 이벤트 핸들러를 추가한다.

    Declaration

    Swift

    open func addTapEventHandler<U>(target: U, handler: @escaping (U) -> (GuiInteractionEventParam) -> Void) -> DisposableEventHandler where U : AnyObject

    Parameters

    target

    이벤트를 수신할 target object
    handler

    이벤트를 수신할 method

    Return Value

    추가된 이벤트 핸들러.

  • Declaration

    Swift

    open func addAnimationEventHandler<U>(target: U, handler: @escaping (U) -> (GuiAnimationEventParam) -> Void) -> DisposableEventHandler where U : AnyObject

    Parameters

    target

    이벤트를 수신할 target object
    handler

    이벤트를 수신할 method

    Return Value

    추가된 이벤트 핸들러.

  • Gui 이동 정지 이벤트 핸들러를 추가한다.

    Declaration

    Swift

    open func addMoveEndEventHandler<U>(target: U, handler: @escaping (U) -> (GuiMoveEventParam) -> Void) -> DisposableEventHandler where U : AnyObject

    Parameters

    target

    이벤트를 수신할 target object
    handler

    이벤트를 수신할 method

    Return Value

    추가된 이벤트 핸들러.

Properties

  • Gui의 name

    Declaration

    Swift

    @objc
open var name: String { get }

  • GuiEventDelegate를 지정한다.

    Declaration

    Swift

    @objc
open var delegate: GuiEventDelegate? { get set }

  • Gui의 렌더링 우선순위를 지정한다. 값을 세팅하면, 따로 updateGui() 호출 없이도 바로 반영된다.

    zOrder는 같은 Gui타입끼리만 유효하며, zOrder 값이 클수록 더 위에 그려진다.

    즉, zOrder가 0인 Gui는 zOrder가 1인 Gui보다 아래에 그려진다.

    Declaration

    Swift

    @objc
open var zOrder: Int { get set }

  • Gui 표출 여부

    Declaration

    Swift

    @objc
open var isShow: Bool { get }