Index

A B C D E F G H I J L M N O P Q R S T U V W X Z 
All Classes All Packages

A

all - com.biodigital.humansdk.HumanUIOptions
turn all default ui elements on or all UI elements off
anatomyLabels - com.biodigital.humansdk.HumanUIOptions
toggle showing anatomy layers slider, default is on
animated - Variable in class com.biodigital.humansdk.HKChapter
true if this chapter is animated
animateTo(String) - Method in class com.biodigital.humansdk.HKCamera
Animates camera to object specified by its id.
animation - com.biodigital.humansdk.HumanUIOptions
toggle showing animation controls, default is true
annotationId - Variable in class com.biodigital.humansdk.HKAnnotation
annotation ID
annotations - Variable in class com.biodigital.humansdk.HKAnnotations
A map of annotation IDs to HKAnnotation objects in the current scene
annotations - Variable in class com.biodigital.humansdk.HKHuman
HKAnnotations object controls object annotations
apiEvents - Variable in class com.biodigital.humansdk.HKHuman
list of BioDigital web API events
apiFunctions - Variable in class com.biodigital.humansdk.HKHuman
list of BioDigital web API functions
audio - com.biodigital.humansdk.HumanUIOptions
toggle showing audio UI, default is on

B

bgType - Variable in class com.biodigital.humansdk.HKUI
linear or radial
bottomColor - Variable in class com.biodigital.humansdk.HKUI
bottom (linear) or center (radial) color
brightness - Variable in class com.biodigital.humansdk.HKColor
brightness - value between 0 and 1, default is 0.0

C

camera - Variable in class com.biodigital.humansdk.HKHuman
HKCamera object for getting and setting the camera
canvasPosition - Variable in class com.biodigital.humansdk.HKAnnotation
annotation screen position [x,y]
capture() - Method in class com.biodigital.humansdk.HKScene
Capture the current state of the scene
captureJson - Variable in class com.biodigital.humansdk.HKScene
JSON describing a scene capture as an Map object
captureString - Variable in class com.biodigital.humansdk.HKScene
JSON describing a scene capture as a String
chapterId - Variable in class com.biodigital.humansdk.HKChapter
chapter ID
chapterList - Variable in class com.biodigital.humansdk.HKTimeline
An ordered list of chapter IDs
chapters - Variable in class com.biodigital.humansdk.HKTimeline
A map of chapter IDs to Chapter objects.
CHINESE - com.biodigital.humansdk.HKLanguage
 
code() - Method in enum com.biodigital.humansdk.HKLanguage
 
color(String, HKColor) - Method in class com.biodigital.humansdk.HKScene
Paint an object
colorStops - Variable in class com.biodigital.humansdk.HKUI
positions for the colors from 0 to 100
com.biodigital.humansdk - package com.biodigital.humansdk
 
contrast - Variable in class com.biodigital.humansdk.HKColor
contrast - value between 0 and 1, default is 0.0
create(HKAnnotation) - Method in class com.biodigital.humansdk.HKAnnotations
Create an annotation in the scene with an HKAnnotation object.
currentChapter - Variable in class com.biodigital.humansdk.HKTimeline
A map of chapter IDs to Chapter objects.
currentTime - Variable in class com.biodigital.humansdk.HKTimeline
The current animation time

D

deleteLocalContent() - Method in class com.biodigital.humansdk.HKServices
Removes all BioDigital Human content from the device
description - Variable in class com.biodigital.humansdk.HKAnnotation
annotation description
description - Variable in class com.biodigital.humansdk.HKChapter
chapter description
description - Variable in class com.biodigital.humansdk.HKModel
Model description
destroy(String) - Method in class com.biodigital.humansdk.HKAnnotations
Delete an annotation in the scene
disableHighlight() - Method in class com.biodigital.humansdk.HKScene
Turn off highlighting the selected object
disableInput() - Method in class com.biodigital.humansdk.HKHuman
Disable user input
disablePicking() - Method in class com.biodigital.humansdk.HKScene
Disable object selection
dissect(boolean) - Method in class com.biodigital.humansdk.HKScene
Turn dissect mode ON or OFF in the current scene
download(String) - Method in class com.biodigital.humansdk.HKServices
Download a model
download(ArrayList<String>) - Method in class com.biodigital.humansdk.HKServices
Download a set of models
draw - com.biodigital.humansdk.HumanUIOptions
toggle showing "Draw" button, default is on
duration - Variable in class com.biodigital.humansdk.HKChapter
true if this chapter contains a video
duration - Variable in class com.biodigital.humansdk.HKTimeline
The current animation duration

E

enableHighlight() - Method in class com.biodigital.humansdk.HKScene
Turn on highlighting the selected object
enableInput() - Method in class com.biodigital.humansdk.HKHuman
Enable user input, only needed if input was disabled, it is on by default
enablePicking() - Method in class com.biodigital.humansdk.HKScene
Enable object selection
ENGLISH - com.biodigital.humansdk.HKLanguage
 
eye - Variable in class com.biodigital.humansdk.HKCamera
Eye vector [x,y,z]

F

findModel(String) - Method in class com.biodigital.humansdk.HKHuman
Get a list of HKModel objects by ICD Number
FRENCH - com.biodigital.humansdk.HKLanguage
 

G

GERMAN - com.biodigital.humansdk.HKLanguage
 
getBackgroundColor() - Method in class com.biodigital.humansdk.HKUI
gets the current background color this is run by the SDK when each chapter loads
getColor(String) - Method in class com.biodigital.humansdk.HKScene
Query the color of an object, calls onObjectColor with the color value
getInstance() - Static method in class com.biodigital.humansdk.HKServices
The Singleton instance of the HKServices class
getModels() - Method in class com.biodigital.humansdk.HKServices
Get Models from the Content API - requires API Key and Secret

H

hasPlayPause - Variable in class com.biodigital.humansdk.HKUI
UI should display a playPause button
hasScrubber - Variable in class com.biodigital.humansdk.HKUI
UI should display a playPause button and timeline scrubber
help - com.biodigital.humansdk.HumanUIOptions
toggle showing "Help" button, default is on
hide() - Method in class com.biodigital.humansdk.HKAnnotations
Hides the annotations in the scene This allows apps to draw native annotations over the view
hide(ArrayList<String>) - Method in class com.biodigital.humansdk.HKScene
Hide a group of obejcts by object ID Groups of objects can be hidden by passing more than one objectID or by passing a "group node" ID
hideUI() - Method in class com.biodigital.humansdk.HKUI
hide the built in BioDigital UI
highlight(ArrayList<String>) - Method in class com.biodigital.humansdk.HKScene
Highlight an object even if highlight is disabled for the user
HKAnnotation - Class in com.biodigital.humansdk
HKAnnotation object
HKAnnotation(String) - Constructor for class com.biodigital.humansdk.HKAnnotation
Create an HKAnnotation with the ID of its object
HKAnnotations - Class in com.biodigital.humansdk
HKAnnotations manages object annotations in the scene
HKAnnotations() - Constructor for class com.biodigital.humansdk.HKAnnotations
 
HKCamera - Class in com.biodigital.humansdk
Camera object camInfo has fields: eye, look, and up of type double[] zoom should be between 0 and 1
HKChapter - Class in com.biodigital.humansdk
Chapter object
HKColor - Class in com.biodigital.humansdk
Color object
HKColor() - Constructor for class com.biodigital.humansdk.HKColor
 
HKHuman - Class in com.biodigital.humansdk
Represents the BioDigital Human 3D Canvas
HKHuman(RelativeLayout) - Constructor for class com.biodigital.humansdk.HKHuman
HKHuman constructor using the default viewer UI elements (ui.all = true)
HKHuman(RelativeLayout, HashMap<HumanUIOptions, Boolean>) - Constructor for class com.biodigital.humansdk.HKHuman
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
HKHumanInterface - Interface in com.biodigital.humansdk
Callback functions for the 3D Scene
HKLanguage - Enum in com.biodigital.humansdk
SDK Translation values
HKModel - Class in com.biodigital.humansdk
Represents a content Module descriptor.
HKModel(String, String, String, String) - Constructor for class com.biodigital.humansdk.HKModel
HKModel constuctor
HKScene - Class in com.biodigital.humansdk
Scene object - for interacting with objects and scene data
HKScene() - Constructor for class com.biodigital.humansdk.HKScene
 
HKServices - Class in com.biodigital.humansdk
BioDigital Backend Services for SDK Validation, Analytics, and Content API
HKServicesInterface - Interface in com.biodigital.humansdk
Callback functions for BioDigital Backend Services
HKTimeline - Class in com.biodigital.humansdk
Timeline object - for interacting with chapters and animations in a scene
HKTimeline() - Constructor for class com.biodigital.humansdk.HKTimeline
 
HKUI - Class in com.biodigital.humansdk
UI settings
HKUI() - Constructor for class com.biodigital.humansdk.HKUI
 
HumanUIOptions - Enum in com.biodigital.humansdk
UI Options - turn on or off various built-in UI elements

I

id - Variable in class com.biodigital.humansdk.HKModel
Model ID
images - Variable in class com.biodigital.humansdk.HKChapter
contains a list of image urls if the chapter contains static images
index - Variable in class com.biodigital.humansdk.HKChapter
chapter number
info - com.biodigital.humansdk.HumanUIOptions
toggle showing scene information panel, default is true
isolate(boolean) - Method in class com.biodigital.humansdk.HKScene
Turn isolate mode ON or OFF in the current scene
isolate(ArrayList<String>) - Method in class com.biodigital.humansdk.HKScene
Isolate a group of objects by object ID Groups of objects can be shown by passing more than one object ID or by passing a "group node" ID
ITALIAN - com.biodigital.humansdk.HKLanguage
 

J

JAPANESE - com.biodigital.humansdk.HKLanguage
 

L

labelList - com.biodigital.humansdk.HumanUIOptions
toggle showing labels list in Info panel, default is off
labelOffset - Variable in class com.biodigital.humansdk.HKAnnotation
annotation label offset [x,y]
layers - com.biodigital.humansdk.HumanUIOptions
toggle showing layer slider UI, default is on
load(String) - Method in class com.biodigital.humansdk.HKHuman
Loads a BioDigital Human 3D model into the view Use unload() when you are done viewing the model
look - Variable in class com.biodigital.humansdk.HKCamera
Look vector [x,y,z]
loop(String) - Method in class com.biodigital.humansdk.HKTimeline
Jump to the chapter with the given ID and play it in a loop
loops - Variable in class com.biodigital.humansdk.HKChapter
true if this chapter loops

M

modelDownloaded(String) - Method in class com.biodigital.humansdk.HKServices
Check if a model has already been downloaded
models - Variable in class com.biodigital.humansdk.HKServices
Models returned from calling getModels from the Content API
moveToChapter(String) - Method in class com.biodigital.humansdk.HKTimeline
Jump to the chapter with the given ID
moveToTime(double) - Method in class com.biodigital.humansdk.HKTimeline
Jump to the given time in the current scene's current animation

N

nav - com.biodigital.humansdk.HumanUIOptions
toggle showing scene navigation UI, default is on
nextChapter() - Method in class com.biodigital.humansdk.HKTimeline
Jump to the next chapter

O

objectId - Variable in class com.biodigital.humansdk.HKAnnotation
object ID of the annotated object this is required, all annotations must be connected to an object
objectIds - Variable in class com.biodigital.humansdk.HKScene
A flat list of visible objects by ID
objects - com.biodigital.humansdk.HumanUIOptions
toggle showing object search interface, default is true
objects - Variable in class com.biodigital.humansdk.HKScene
A map of objectID Strings to Display Names
occludable - Variable in class com.biodigital.humansdk.HKAnnotation
whether or not the annotation is occludable
onAnimationComplete() - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when the current is done running
onAnnotationCreated(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when a new annotation is created in the scene
onAnnotationDestroyed(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when an annotation is destroyed in the scene
onAnnotationsShown(Boolean) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when annotations are shown or hidden in the scene
onAnnotationUpdated(HKAnnotation) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when the annotations screen position has changed
onCameraUpdated(HKCamera) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when the camera moves in the scene
onChapterTransition(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when a new chapter is loaded by the scene
onDemand - com.biodigital.humansdk.HumanUIOptions
turn 'click to interact' on/off, default is off
onInvalidSDK() - Method in interface com.biodigital.humansdk.HKServicesInterface
Called when the SDK validation succeeds
onModelDownloaded(String, Integer, Integer) - Method in interface com.biodigital.humansdk.HKServicesInterface
Called when a model is downloaded successfully
onModelDownloadError(String) - Method in interface com.biodigital.humansdk.HKServicesInterface
Called when a model is downloaded unsuccessfully
onModelLoaded(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when loading is complete for a scene
onModelLoadError(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when an error has occurred during loading for a scene
onModelsLoaded() - Method in interface com.biodigital.humansdk.HKServicesInterface
Called when content from the BioDigital Content API is returned
onObjectColor(String, HKColor) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when an object's color is retrieved
onObjectDeselected(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when an object is deselected in the scene
onObjectPicked(String, double[]) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when an object is picked by the user
onObjectSelected(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when an object is selected in the scene
onObjectsShown(Map<String, Object>) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when a set of objects are shown or hidden in the scene
onSceneCapture(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when a scene capture is complete
onSceneInit(String) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when the scene is initialized and metadata is available
onSceneRestore() - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when the scene is restored
onScreenshot(Bitmap) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when a screenshot is returned from the SDK
onTimelineUpdated(HKTimeline) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when the timeline has been updated
onValidSDK() - Method in interface com.biodigital.humansdk.HKServicesInterface
Called when the SDK validation fails
onXrayEnabled(Boolean) - Method in interface com.biodigital.humansdk.HKHumanInterface
Called when xray mode is enabled or disabled
opacity - Variable in class com.biodigital.humansdk.HKColor
opacity - alpha value between 0 and 1, default is 1.0
orbit(double, double) - Method in class com.biodigital.humansdk.HKCamera
Orbit around camera's current point of focus.
orbit(double, double, double) - Method in class com.biodigital.humansdk.HKCamera
Orbit around camera's current point of focus.

P

pan(double, double, double) - Method in class com.biodigital.humansdk.HKCamera
Pan camera by offset in world space.
pause() - Method in class com.biodigital.humansdk.HKTimeline
Pause the animation
pivot(String, double[]) - Method in class com.biodigital.humansdk.HKScene
Pivot an object in 3D space
play() - Method in class com.biodigital.humansdk.HKTimeline
Play the animation from the beginning
playing - Variable in class com.biodigital.humansdk.HKTimeline
true if the animation is currently playing
PORTUGUESE - com.biodigital.humansdk.HKLanguage
 
position - Variable in class com.biodigital.humansdk.HKAnnotation
annotation 3D position [x,y,z]
presetBackgroundColor(int, int) - Method in class com.biodigital.humansdk.HKUI
Change the background colors without changing the style, default is radial
presetBackgroundColor(int, int, String) - Method in class com.biodigital.humansdk.HKUI
Change the background style with two specified colors
prevChapter() - Method in class com.biodigital.humansdk.HKTimeline
Jump to the previous chapter

Q

quizEnabled - com.biodigital.humansdk.HumanUIOptions
toggle showing "Take Quiz" button if there is a quiz, default is on
quizLock - com.biodigital.humansdk.HumanUIOptions
turn on quiz lock mode, default is off

R

reset - com.biodigital.humansdk.HumanUIOptions
toggle showing scene undo UI, default is true
reset() - Method in class com.biodigital.humansdk.HKCamera
Reset camera to original position
reset() - Method in class com.biodigital.humansdk.HKScene
Reset the objects to their original state PLEASE NOTE: This does not reset the camera, use HKCamera.reset()
resetHighlightColor() - Method in class com.biodigital.humansdk.HKScene
Change the object highlight color back to the original yellow color
restore() - Method in class com.biodigital.humansdk.HKScene
Restore the scene from the last capture Calls human(_:sceneRestored:) on success
restore(String) - Method in class com.biodigital.humansdk.HKScene
Restore the scene from a previous capture Calls human(_:sceneRestored:) on success
rotate(String, double[]) - Method in class com.biodigital.humansdk.HKScene
Rotate an object in 3D space

S

saturation - Variable in class com.biodigital.humansdk.HKColor
saturation - value between -1 and 1, default is 0.0
scale(String, double[]) - Method in class com.biodigital.humansdk.HKScene
Scale an object in 3D space
scene - Variable in class com.biodigital.humansdk.HKHuman
HKScene object provides information and control of the 3D scene
screenshot() - Method in class com.biodigital.humansdk.HKScene
Calls the onScreenshot interface method with the generated screenshot
select(ArrayList<String>) - Method in class com.biodigital.humansdk.HKScene
Select a group of objects programmatically
selectObject(String) - Method in class com.biodigital.humansdk.HKScene
Deprecated.
use select(ArrayList objectIds) instead
set(double[], double[], double[], boolean) - Method in class com.biodigital.humansdk.HKCamera
Updates camera position.
setBackgroundColor(int, int) - Method in class com.biodigital.humansdk.HKUI
Change the background colors without changing the style, default is radial
setBackgroundColor(int, int, String) - Method in class com.biodigital.humansdk.HKUI
Change the background style with two specified colors
setHighlightColor(float[]) - Method in class com.biodigital.humansdk.HKScene
Change the object highlight color
setHighlightColor(int) - Method in class com.biodigital.humansdk.HKScene
Change the object highlight color
setInterface(HKHumanInterface) - Method in class com.biodigital.humansdk.HKHuman
Set the HKHumanInterface object to receive callback messages
setLanguage(HKLanguage) - Method in class com.biodigital.humansdk.HKServices
Set the current language
setOption(HumanUIOptions, Boolean) - Method in class com.biodigital.humansdk.HKUI
set an option true or false
setup(Context, HKServicesInterface) - Method in class com.biodigital.humansdk.HKServices
Initialize BioDigital Services and authenticate the SDK
share() - Method in class com.biodigital.humansdk.HKScene
Brings up the built-in Android share UI with the current contents of the view
show() - Method in class com.biodigital.humansdk.HKAnnotations
Shows the annotations in the current scene
show(ArrayList<String>) - Method in class com.biodigital.humansdk.HKScene
Show a group of objects by object ID Groups of objects can be shown by passing more than one objectID or by passing a "group node" ID
shown - Variable in class com.biodigital.humansdk.HKAnnotation
whether or not the annotation is currently visible this will get set to false if the annotation moves off screen or is occluded
SPANISH - com.biodigital.humansdk.HKLanguage
 

T

text - Variable in class com.biodigital.humansdk.HKScene
The description of the current loaded scene.
thumbnail - Variable in class com.biodigital.humansdk.HKChapter
contains an image url if the chapter has a thumbnail image
thumbnailurl - Variable in class com.biodigital.humansdk.HKModel
Model thumbnail
timeline - Variable in class com.biodigital.humansdk.HKHuman
HKTimeline object controls Chapter navigation and animations
tint - Variable in class com.biodigital.humansdk.HKColor
tint - color values for red, green, blue - between 0 and 1
title - Variable in class com.biodigital.humansdk.HKAnnotation
annotation title
title - Variable in class com.biodigital.humansdk.HKChapter
chapter title
title - Variable in class com.biodigital.humansdk.HKModel
Model title
title - Variable in class com.biodigital.humansdk.HKScene
The title of the current loaded scene.
tools - com.biodigital.humansdk.HumanUIOptions
toggle showing scene interaction tools, default is true
topColor - Variable in class com.biodigital.humansdk.HKUI
top (linear) or outer (radial) color
toString() - Method in class com.biodigital.humansdk.HKModel
Get the Model title
tour - com.biodigital.humansdk.HumanUIOptions
toggle showing tour navigation UI, default is on
transform(String, double[], double[], double[], double[]) - Method in class com.biodigital.humansdk.HKScene
Move an object in 3D space
translate(String, double[]) - Method in class com.biodigital.humansdk.HKScene
Move an object in 3D space
tutorial - com.biodigital.humansdk.HumanUIOptions
enable/disable tutorial default is disabled

U

ui - Variable in class com.biodigital.humansdk.HKHuman
HKUI object controls display parameters and background colors
uncolor(String) - Method in class com.biodigital.humansdk.HKScene
Unpaint an object - set it back to it's original color
undo() - Method in class com.biodigital.humansdk.HKScene
Undo the last dissect
undoSelections() - Method in class com.biodigital.humansdk.HKScene
Deselect all objects in the scene
unhighlight(String) - Method in class com.biodigital.humansdk.HKScene
Unhighlight an object
unload() - Method in class com.biodigital.humansdk.HKHuman
Unload the current scene - Use this method to clear the HKHuman when exiting a model view
unpause() - Method in class com.biodigital.humansdk.HKTimeline
Unpause the animation
up - Variable in class com.biodigital.humansdk.HKCamera
Up vector [x,y,z]
update(String) - Method in class com.biodigital.humansdk.HKAnnotations
Update an annotation in the scene with an updated HKAnnotation object.
updateCamera(double[], double[], double[], boolean) - Method in class com.biodigital.humansdk.HKCamera
Deprecated. 

V

valueOf(String) - Static method in enum com.biodigital.humansdk.HKLanguage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.biodigital.humansdk.HumanUIOptions
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.biodigital.humansdk.HKLanguage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.biodigital.humansdk.HumanUIOptions
Returns an array containing the constants of this enum type, in the order they are declared.
version - Variable in class com.biodigital.humansdk.HKHuman
BioDigital 3D engine version

W

webGlInfo - Variable in class com.biodigital.humansdk.HKHuman
webGl settings and parameters

X

xray(boolean) - Method in class com.biodigital.humansdk.HKScene
Turn xray mode ON or OFF in the current scene

Z

zoom(float) - Method in class com.biodigital.humansdk.HKCamera
Zoom the camera in and out of its point of focus.
zoomFactor - Variable in class com.biodigital.humansdk.HKCamera
Zoom factor
A B C D E F G H I J L M N O P Q R S T U V W X Z 
All Classes All Packages