Package com.biodigital.humansdk

Class HKHuman

java.lang.Object
com.biodigital.humansdk.HKHuman
public class HKHuman
extends java.lang.Object
Represents the BioDigital Human 3D Canvas

  • Field Summary

    Fields 
    Modifier and Type Field Description
    HKAnnotations annotations
    HKAnnotations object controls object annotations
    java.util.ArrayList<java.lang.String> apiEvents
    list of BioDigital web API events
    java.util.ArrayList<java.lang.String> apiFunctions
    list of BioDigital web API functions
    HKCamera camera
    HKCamera object for getting and setting the camera
    HKScene scene
    HKScene object provides information and control of the 3D scene
    HKTimeline timeline
    HKTimeline object controls Chapter navigation and animations
    HKUI ui
    HKUI object controls display parameters and background colors
    java.lang.String version
    BioDigital 3D engine version
    java.util.Map<java.lang.String,​java.lang.Boolean> webGlInfo
    webGl settings and parameters

  • Constructor Summary

    Constructors 
    Constructor Description
    HKHuman​(android.widget.RelativeLayout container)
    HKHuman constructor using the default viewer UI elements (ui.all = true)
    HKHuman​(android.widget.RelativeLayout container, java.util.HashMap<HumanUIOptions,​java.lang.Boolean> uiOptionsMap)
    HKHuman constructor NOTE: This new implementation separates the view from the SDK and allows for loading and unloading scenes into the same HKHuman object for faster loading

  • Method Summary

    Modifier and Type Method Description
    void disableInput()
    Disable user input
    void enableInput()
    Enable user input, only needed if input was disabled, it is on by default
    HKModel[] findModel​(java.lang.String ICD)
    Get a list of HKModel objects by ICD Number
    void load​(java.lang.String modelId)
    Loads a BioDigital Human 3D model into the view Use unload() when you are done viewing the model
    void setInterface​(HKHumanInterface bodyInterface)
    Set the HKHumanInterface object to receive callback messages
    void unload()
    Unload the current scene - Use this method to clear the HKHuman when exiting a model view

    Methods inherited from class java.lang.Object

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

  • Field Details

    • scene

      public HKScene scene
      HKScene object provides information and control of the 3D scene

    • timeline

      public HKTimeline timeline
      HKTimeline object controls Chapter navigation and animations

    • annotations

      public HKAnnotations annotations
      HKAnnotations object controls object annotations

    • ui

      public HKUI ui
      HKUI object controls display parameters and background colors

    • camera

      public HKCamera camera
      HKCamera object for getting and setting the camera

    • version

      public java.lang.String version
      BioDigital 3D engine version

    • webGlInfo

      public java.util.Map<java.lang.String,​java.lang.Boolean> webGlInfo
      webGl settings and parameters

    • apiFunctions

      public java.util.ArrayList<java.lang.String> apiFunctions
      list of BioDigital web API functions

    • apiEvents

      public java.util.ArrayList<java.lang.String> apiEvents
      list of BioDigital web API events

  • Constructor Details

    • HKHuman

      public HKHuman​(android.widget.RelativeLayout container, java.util.HashMap<HumanUIOptions,​java.lang.Boolean> uiOptionsMap)
      HKHuman constructor NOTE: This new implementation separates the view from the SDK and allows for loading and unloading scenes into the same HKHuman object for faster loading
      Parameters:
      container - the containing view
      uiOptionsMap - initialize the UI options

    • HKHuman

      public HKHuman​(android.widget.RelativeLayout container)
      HKHuman constructor using the default viewer UI elements (ui.all = true)
      Parameters:
      container - the containing view

  • Method Details

    • setInterface

      public void setInterface​(HKHumanInterface bodyInterface)
      Set the HKHumanInterface object to receive callback messages
      Parameters:
      bodyInterface - set the object to receive callback functions

    • load

      public void load​(java.lang.String modelId)
      Loads a BioDigital Human 3D model into the view Use unload() when you are done viewing the model
      Parameters:
      modelId - The unique identifier of the model

    • unload

      public void unload()
      Unload the current scene - Use this method to clear the HKHuman when exiting a model view

    • disableInput

      public void disableInput()
      Disable user input

    • enableInput

      public void enableInput()
      Enable user input, only needed if input was disabled, it is on by default

    • findModel

      public HKModel[] findModel​(java.lang.String ICD)
      Get a list of HKModel objects by ICD Number
      Parameters:
      ICD - the code for the condition
      Returns:
      An array of HKModel objects which match the ICD code