Package com.biodigital.humansdk

Class HKAnnotation

java.lang.Object
com.biodigital.humansdk.HKAnnotation
public class HKAnnotation
extends java.lang.Object
HKAnnotation object

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String annotationId
    annotation ID
    double[] canvasPosition
    annotation screen position [x,y]
    java.lang.String description
    annotation description
    double[] labelOffset
    annotation label offset [x,y]
    java.lang.String objectId
    object ID of the annotated object this is required, all annotations must be connected to an object
    boolean occludable
    whether or not the annotation is occludable
    double[] position
    annotation 3D position [x,y,z]
    boolean shown
    whether or not the annotation is currently visible this will get set to false if the annotation moves off screen or is occluded
    java.lang.String title
    annotation title

  • Constructor Summary

    Constructors 
    Constructor Description
    HKAnnotation​(java.lang.String objectId)
    Create an HKAnnotation with the ID of its object

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • objectId

      public java.lang.String objectId
      object ID of the annotated object this is required, all annotations must be connected to an object

    • title

      public java.lang.String title
      annotation title

    • description

      public java.lang.String description
      annotation description

    • annotationId

      public java.lang.String annotationId
      annotation ID

    • position

      public double[] position
      annotation 3D position [x,y,z]

    • canvasPosition

      public double[] canvasPosition
      annotation screen position [x,y]

    • labelOffset

      public double[] labelOffset
      annotation label offset [x,y]

    • shown

      public boolean shown
      whether or not the annotation is currently visible this will get set to false if the annotation moves off screen or is occluded

    • occludable

      public boolean occludable
      whether or not the annotation is occludable

  • Constructor Details

    • HKAnnotation

      public HKAnnotation​(java.lang.String objectId)
      Create an HKAnnotation with the ID of its object
      Parameters:
      objectId - : ID of the attached object