Package com.biodigital.humansdk

Class HKUI

java.lang.Object

com.biodigital.humansdk.HKUI

public class HKUI
extends Object

UI settings

Field Summary

Fields

Modifier and Type	Field	Description
String	bgType	linear or radial
ArrayList<Double>	bottomColor	bottom (linear) or center (radial) color
ArrayList<Double>	colorStops	positions for the colors from 0 to 100
boolean	hasPlayPause	UI should display a playPause button
boolean	hasScrubber	UI should display a playPause button and timeline scrubber
ArrayList<Double>	topColor	top (linear) or outer (radial) color

Constructor Summary

Constructors

Constructor	Description
HKUI()

Method Summary

Modifier and Type	Method	Description
void	getBackgroundColor()	gets the current background color this is run by the sdk when each chapter loads
void	hideUI()	hide the built in BioDigital UI
void	presetBackgroundColor(int topColor, int bottomColor)	Change the background colors BEFORE loading a model without changing the style, default is radial
void	presetBackgroundColor(int topColor, int bottomColor, String bgType)	Change the background style and color BEFORE loading a model with two specified colors
void	setBackgroundColor(int topColor, int bottomColor)	Change the background colors AFTER loading a modelwithout changing the style, default is radial
void	setBackgroundColor(int topColor, int bottomColor, String bgType)	Change the background style AFTER loading a model with two specified colors
void	setOption(HumanUIOptions option, Boolean value)	set an option true or false

Methods inherited from class java.lang.Object

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

Field Details

topColor

public ArrayList<Double> topColor

top (linear) or outer (radial) color

bottomColor

public ArrayList<Double> bottomColor

bottom (linear) or center (radial) color

bgType

public String bgType

linear or radial

colorStops

public ArrayList<Double> colorStops

positions for the colors from 0 to 100

hasPlayPause

public boolean hasPlayPause

UI should display a playPause button

hasScrubber

public boolean hasScrubber

UI should display a playPause button and timeline scrubber

Constructor Details

HKUI

public HKUI()

Method Details

setOption

public void setOption(HumanUIOptions option,
 Boolean value)

set an option true or false

Parameters:

option - any UI option

value - true or false

hideUI

public void hideUI()

hide the built in BioDigital UI

setBackgroundColor

public void setBackgroundColor(int topColor,
 int bottomColor)

Change the background colors AFTER loading a modelwithout changing the style, default is radial

Parameters:

topColor - Primary color

bottomColor - Secondary color

presetBackgroundColor

public void presetBackgroundColor(int topColor,
 int bottomColor)

Change the background colors BEFORE loading a model without changing the style, default is radial

Parameters:

topColor - Primary color

bottomColor - Secondary color

setBackgroundColor

public void setBackgroundColor(int topColor,
 int bottomColor,
 String bgType)

Change the background style AFTER loading a model with two specified colors

Parameters:

topColor - Primary color

bottomColor - Secondary color

bgType - Background style ("linear" or "radial", default is "radial")

presetBackgroundColor

public void presetBackgroundColor(int topColor,
 int bottomColor,
 String bgType)

Change the background style and color BEFORE loading a model with two specified colors

Parameters:

topColor - Primary color

bottomColor - Secondary color

bgType - Background style ("linear" or "radial", default is "radial")

getBackgroundColor

public void getBackgroundColor()

gets the current background color this is run by the sdk when each chapter loads