Package com.biodigital.humansdk

Enum Class HumanUIOptions

java.lang.Object
java.lang.Enum<HumanUIOptions>
com.biodigital.humansdk.HumanUIOptions
All Implemented Interfaces:
Serializable, Comparable<HumanUIOptions>, Constable
public enum HumanUIOptions extends 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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    all
    toggle display of BioDigital viewer UI, default is true
    anatomyLabels
    toggle showing anatomy context labels on selection, 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
    labels
    toggle showing labels in the 3D scene, default is on
    layers
    toggle showing layer slider UI button, 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
    quizAutoStart
    start a Quiz if one is present in the content, default is off
    quizLock
    Block users from taking a Quiz if one is present, 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(String name)
    Returns the enum constant of this class with the specified name.
    static HumanUIOptions[]
    values()
    Returns an array containing the constants of this enum class, 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

    • all

      public static final HumanUIOptions all
      toggle display of BioDigital viewer UI, default is true

    • anatomyLabels

      public static final HumanUIOptions anatomyLabels
      toggle showing anatomy context labels on selection, default is on

    • animation

      public static final HumanUIOptions animation
      toggle showing animation controls, default is true

    • audio

      public static final HumanUIOptions audio
      toggle showing audio UI, default is on

    • draw

      public static final HumanUIOptions draw
      toggle showing "Draw" button, default is on

    • help

      public static final HumanUIOptions help
      toggle showing "Help" button, default is on

    • info

      public static final HumanUIOptions info
      toggle showing scene information panel, default is true

    • labels

      public static final HumanUIOptions labels
      toggle showing labels in the 3D scene, default is on

    • labelList

      public static final HumanUIOptions labelList
      toggle showing labels list in Info panel, default is off

    • layers

      public static final HumanUIOptions layers
      toggle showing layer slider UI button, default is on

    • objects

      public static final HumanUIOptions objects
      toggle showing object search interface, default is true

    • onDemand

      public static final HumanUIOptions onDemand
      turn 'click to interact' on/off, default is off

    • quizAutoStart

      public static final HumanUIOptions quizAutoStart
      start a Quiz if one is present in the content, default is off

    • quizLock

      public static final HumanUIOptions quizLock
      Block users from taking a Quiz if one is present, default is off

    • reset

      public static final HumanUIOptions reset
      toggle showing scene undo UI, default is true

    • tools

      public static final HumanUIOptions tools
      toggle showing scene interaction tools, default is true

    • tour

      public static final HumanUIOptions tour
      toggle showing tour navigation UI, default is on

    • tutorial

      public static final HumanUIOptions tutorial
      enable/disable tutorial default is disabled

  • Method Details

    • values

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

    • valueOf

      public static HumanUIOptions valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null