com.biodigital.humansdk

Enum HumanUIOptions

java.lang.Object

java.lang.Enum<HumanUIOptions>

com.biodigital.humansdk.HumanUIOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HumanUIOptions>

public enum HumanUIOptions
extends java.lang.Enum<HumanUIOptions>

UI Options - turn on or off various built-in UI elements

Enum Constant Summary

Enum Constants

Enum Constant and 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

Method Summary

Modifier and Type	Method and 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

tools

public static final HumanUIOptions tools

toggle showing scene interaction tools, default is true

reset

public static final HumanUIOptions reset

toggle showing scene undo UI, default is true

info

public static final HumanUIOptions info

toggle showing scene information panel, default is true

animation

public static final HumanUIOptions animation

toggle showing animation controls, default is true

objects

public static final HumanUIOptions objects

toggle showing object search interface, default is true

all

public static final HumanUIOptions all

turn all default ui elements on or all UI elements off

onDemand

public static final HumanUIOptions onDemand

turn 'click to interact' on/off, default is off

quizLock

public static final HumanUIOptions quizLock

turn on quiz lock mode, default is off

audio

public static final HumanUIOptions audio

toggle showing audio UI, default is on

layers

public static final HumanUIOptions layers

toggle showing layer slider UI, default is on

labelList

public static final HumanUIOptions labelList

toggle showing labels list in Info panel, default is off

quizEnabled

public static final HumanUIOptions quizEnabled

toggle showing "Take Quiz" button if there is a quiz, default is on

draw

public static final HumanUIOptions draw

toggle showing "Draw" button, default is on

anatomyLabels

public static final HumanUIOptions anatomyLabels

toggle showing anatomy layers slider, default is on

nav

public static final HumanUIOptions nav

toggle showing scene navigation UI, default is on

tour

public static final HumanUIOptions tour

toggle showing tour navigation UI, default is on

help

public static final HumanUIOptions help

toggle showing "Help" button, default is on

Method Detail

values

public static HumanUIOptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HumanUIOptions c : HumanUIOptions.values())
    System.out.println(c);

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