HKLabels

public class HKLabels : NSObject

HKLabels manages object labels in the scene

Since

SDK 132.2

  • The SDK will set this when the labels are enabled in the scene

    Declaration

    Swift

    @objc
public var shown: Bool

  • A map of Label IDs to HKLabel objects in the current scene

    Declaration

    Swift

    @objc
public var labels: [String : HKLabel]

  • Shows the Labels in the current scene

    Declaration

    Swift

    @objc
public func show()

  • Hides the labels in the scene This allows apps to draw native Labels over the view

    Declaration

    Swift

    @objc
public func hide()

  • Create an label in the scene with an HKLabel object.

    Since

    SDK 2.0

    Declaration

    Swift

    @objc
public func create(label: HKLabel)

    Parameters

    label

    set up an HKLabel object and pass it to this function to add it to the scene

  • Update a Label in the scene with an updated HKLabel object.

    Since

    SDK 2.0

    Declaration

    Swift

    @objc
public func update(labelId: String)

    Parameters

    labelId

    Id of the updated Label to update in the scene

  • Delete a Label in the scene

    Since

    SDK 2.0

    Declaration

    Swift

    @objc
public func destroy(labelId: String)

    Parameters

    labelId

    Id of the Label to remove from the scene