HKLabel

@objc
public class HKLabel : NSObject

HKLabel represents a descriptive UI element in the anatomy viewer, attached to an anatomy object

  • objectID of the labelled object this is required, all labels must be connected to an object

    Declaration

    Swift

    @objc
public var objectId: String

  • Label title

    Declaration

    Swift

    @objc
public var title: String

  • Label description text

    Declaration

    Swift

    @objc
public var text: String

  • Label ID for reference

    Declaration

    Swift

    @objc
public var labelId: String

  • Label world space position [x,y,z]

    Declaration

    Swift

    @objc
public var position: [Double]

  • Label screen position [x,y]

    Declaration

    Swift

    @objc
public var canvasPosition: [Double]

  • Label offset [x,y] from the object, can be used to enhance visibility

    Declaration

    Swift

    @objc
public var labelOffset: [Double]

  • whether or not the Label is currently visible this will get set to false if the Label moves off screen or is occluded

    Declaration

    Swift

    @objc
public var shown: Bool

  • whether or not the Label is occludable

    Declaration

    Swift

    @objc
public var occludable: Bool

  • Create an HKLabel with the ID of its object

    Declaration

    Swift

    @objc
public init(objectId: String)

    Parameters

    objectId

    Id of the attached object