Package com.biodigital.humansdk

Class HKHuman

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    ArrayList<String>
    apiEvents
    list of BioDigital web API events
    ArrayList<String>
    apiFunctions
    list of BioDigital web API functions
    HKCamera
    camera
    HKCamera object for getting and setting the camera
    HKLabels
    labels
    HKLabels object controls object Labels
    HKQuiz
    quiz
    HKQuiz object contains data and functionality related to a quiz, if the content contains one
    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
    String
    version
    BioDigital 3D engine version
    Map<String,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, HashMap<HumanUIOptions,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(String ICD)
    Get a list of HKModel objects by ICD Number
    void
    load(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
    setUIoptions(HashMap<HumanUIOptions,Boolean> options)
    Set the built-in UI options
    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

    • labels

      public HKLabels labels
      HKLabels object controls object Labels

    • ui

      public HKUI ui
      HKUI object controls display parameters and background colors

    • quiz

      public HKQuiz quiz
      HKQuiz object contains data and functionality related to a quiz, if the content contains one

    • camera

      public HKCamera camera
      HKCamera object for getting and setting the camera

    • version

      public String version
      BioDigital 3D engine version

    • webGlInfo

      public Map<String,Boolean> webGlInfo
      webGl settings and parameters

    • apiFunctions

      public ArrayList<String> apiFunctions
      list of BioDigital web API functions

    • apiEvents

      public ArrayList<String> apiEvents
      list of BioDigital web API events

  • Constructor Details

    • HKHuman

      public HKHuman(android.widget.RelativeLayout container, HashMap<HumanUIOptions,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

    • setUIoptions

      public void setUIoptions(HashMap<HumanUIOptions,Boolean> options)
      Set the built-in UI options
      Parameters:
      options - a set of option identifiers and booleans to turn them on and off

    • 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(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(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