Package com.biodigital.humansdk

Class HKAnnotations

java.lang.Object
com.biodigital.humansdk.HKAnnotations
public class HKAnnotations
extends java.lang.Object
HKAnnotations manages object annotations in the scene
Since:
SDK 2.0

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.util.HashMap<java.lang.String,​HKAnnotation> annotations
    A map of annotation IDs to HKAnnotation objects in the current scene

  • Constructor Summary

    Constructors 
    Constructor Description
    HKAnnotations()  

  • Method Summary

    Modifier and Type Method Description
    void create​(HKAnnotation annotation)
    Create an annotation in the scene with an HKAnnotation object.
    void destroy​(java.lang.String annotationId)
    Delete an annotation in the scene
    void hide()
    Hides the annotations in the scene This allows apps to draw native annotations over the view
    void show()
    Shows the annotations in the current scene
    void update​(java.lang.String annotationId)
    Update an annotation in the scene with an updated HKAnnotation object.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • annotations

      public java.util.HashMap<java.lang.String,​HKAnnotation> annotations
      A map of annotation IDs to HKAnnotation objects in the current scene

  • Constructor Details

  • Method Details

    • show

      public void show()
      Shows the annotations in the current scene

    • hide

      public void hide()
      Hides the annotations in the scene This allows apps to draw native annotations over the view

    • create

      public void create​(HKAnnotation annotation)
      Create an annotation in the scene with an HKAnnotation object.
      Parameters:
      annotation - : set up an HKAnnotation object and pass it to this function to add it to the scene
      Since:
      SDK 2.0

    • update

      public void update​(java.lang.String annotationId)
      Update an annotation in the scene with an updated HKAnnotation object.
      Parameters:
      annotationId - : Id of the updated annotation to update in the scene
      Since:
      SDK 2.0

    • destroy

      public void destroy​(java.lang.String annotationId)
      Delete an annotation in the scene
      Parameters:
      annotationId - : Id of the annotation to remove from the scene
      Since:
      SDK 2.0