Enum HumanUIOptions

java.lang.Object
java.lang.Enum<HumanUIOptions>
com.biodigital.humansdk.HumanUIOptions
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HumanUIOptions>, java.lang.constant.Constable

public enum HumanUIOptions
extends java.lang.Enum<HumanUIOptions>
UI Options - turn on or off various built-in UI elements
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    all
    turn all default ui elements on or all UI elements off
    anatomyLabels
    toggle showing anatomy layers slider, default is on
    animation
    toggle showing animation controls, default is true
    audio
    toggle showing audio UI, default is on
    draw
    toggle showing "Draw" button, default is on
    help
    toggle showing "Help" button, default is on
    info
    toggle showing scene information panel, default is true
    labelList
    toggle showing labels list in Info panel, default is off
    layers
    toggle showing layer slider UI, default is on
    nav
    toggle showing scene navigation UI, default is on
    objects
    toggle showing object search interface, default is true
    onDemand
    turn 'click to interact' on/off, default is off
    quizEnabled
    toggle showing "Take Quiz" button if there is a quiz, default is on
    quizLock
    turn on quiz lock mode, default is off
    reset
    toggle showing scene undo UI, default is true
    tools
    toggle showing scene interaction tools, default is true
    tour
    toggle showing tour navigation UI, default is on
    tutorial
    enable/disable tutorial default is disabled
  • Method Summary

    Modifier and Type Method Description
    static HumanUIOptions valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static HumanUIOptions[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

  • Method Details

    • values

      public static HumanUIOptions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static HumanUIOptions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null