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

A

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.

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 - Variable in class com.biodigital.humansdk.HKChapter

true if this chapter contains an audio track

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.

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.HKHuman

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 modelsin the background

download(ArrayList<String>) - Method in class com.biodigital.humansdk.HKServices

download a group of models in the background

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

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

G

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

get the HKServices singleton instance

getModels() - Method in class com.biodigital.humansdk.HKServices

Get Models from the Content API - requires API 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

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

hideLabels() - Method in class com.biodigital.humansdk.HKScene

Hides all labels.

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(Context) - Constructor for class com.biodigital.humansdk.HKHuman

HKHuman constructor

HKHuman(Context, AttributeSet) - Constructor for class com.biodigital.humansdk.HKHuman

HKHuman alternative constructor

HKHuman(Context, AttributeSet, int) - Constructor for class com.biodigital.humansdk.HKHuman

HKHuman alternative constructor

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
HKServices is a Singleton and can be accessed via HKServices.getInstance()
Your API Key and (optional) Secret must be entered as meta-data in your AndroidManifest.xml file

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

index - Variable in class com.biodigital.humansdk.HKChapter

chapter number

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

isolate(boolean) - Method in class com.biodigital.humansdk.HKScene

Turn isolate mode ON or OFF in the current scene

L

labelOffset - Variable in class com.biodigital.humansdk.HKAnnotation

annotation label offset [x,y]

load(String) - Method in class com.biodigital.humansdk.HKHuman

Loads a BioDigital Human 3D 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

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

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 - 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

onAnimationComplete() - Method in class com.biodigital.humansdk.HKServices

onAnnotationCreated(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when a new annotation is created in the scene

onAnnotationCreated(String) - Method in class com.biodigital.humansdk.HKServices

onAnnotationDestroyed(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when an annotation is destroyed in the scene

onAnnotationDestroyed(String) - Method in class com.biodigital.humansdk.HKServices

onAnnotationsShown(Boolean) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when annotations are shown or hidden in the scene

onAnnotationsShown(Boolean) - Method in class com.biodigital.humansdk.HKServices

onAnnotationUpdated(HKAnnotation) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when the annotations screen position has changed

onAnnotationUpdated(HKAnnotation) - Method in class com.biodigital.humansdk.HKServices

onCameraUpdated(HKCamera) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when the camera moves in the scene

onCameraUpdated(HKCamera) - Method in class com.biodigital.humansdk.HKServices

onChapterTransition(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when a new chapter is loaded by the scene

onChapterTransition(String) - Method in class com.biodigital.humansdk.HKServices

onInvalidSDK() - Method in interface com.biodigital.humansdk.HKServicesInterface

Called when the SDK validation succeeds

onModelDownloaded(String) - Method in interface com.biodigital.humansdk.HKServicesInterface

Called when a model has been downloaded

onModelLoaded(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when loading is 100% complete for a model

onModelLoaded(String) - Method in class com.biodigital.humansdk.HKServices

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

onObjectColor(String, HKColor) - Method in class com.biodigital.humansdk.HKServices

onObjectDeselected(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when an object is deselected in the scene

onObjectDeselected(String) - Method in class com.biodigital.humansdk.HKServices

onObjectPicked(String, double[]) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when an object is picked by the user

onObjectPicked(String, double[]) - Method in class com.biodigital.humansdk.HKServices

onObjectSelected(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when an object is selected in the scene

onObjectSelected(String) - Method in class com.biodigital.humansdk.HKServices

onObjectsShown(Map<String, Object>) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when a set of objects are shown or hidden in the scene

onObjectsShown(Map<String, Object>) - Method in class com.biodigital.humansdk.HKServices

onSceneCapture(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when a scene capture is complete

onSceneCapture(String) - Method in class com.biodigital.humansdk.HKServices

onSceneInit(String) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when the scene is initialized and metadata is available

onSceneInit(String) - Method in class com.biodigital.humansdk.HKServices

onSceneRestore() - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when the scene is restored

onSceneRestore() - Method in class com.biodigital.humansdk.HKServices

onScreenshot(Bitmap) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when a screenshot is returned from the SDK

onScreenshot(Bitmap) - Method in class com.biodigital.humansdk.HKServices

onTimelineUpdated(HKTimeline) - Method in interface com.biodigital.humansdk.HKHumanInterface

Called when the timeline has been updated

onTimelineUpdated(HKTimeline) - Method in class com.biodigital.humansdk.HKServices

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

onXrayEnabled(Boolean) - Method in class com.biodigital.humansdk.HKServices

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

position - Variable in class com.biodigital.humansdk.HKAnnotation

annotation 3D position [x,y,z]

prevChapter() - Method in class com.biodigital.humansdk.HKTimeline

Jump to the previous chapter

R

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

serve(IHTTPSession) - Method in class com.biodigital.humansdk.HKServices

internal method for handling web requests

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(int) - Method in class com.biodigital.humansdk.HKScene

Change the object highlight color

setHighlightColor(float[]) - Method in class com.biodigital.humansdk.HKScene

Change the object highlight color

setInterface(HKHumanInterface) - Method in class com.biodigital.humansdk.HKHuman

setLanguage(HKLanguage) - Method in class com.biodigital.humansdk.HKServices

setLanguage - set the current language

setUIoptions(HashMap<HumanUIOptions, Boolean>) - Method in class com.biodigital.humansdk.HKHuman

Set the built-in UI options

setup(Context, HKServicesInterface) - Method in class com.biodigital.humansdk.HKServices

setup the HKServices singleton and validate 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

showLabels() - Method in class com.biodigital.humansdk.HKScene

Shows all labels.

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

T

text - Variable in class com.biodigital.humansdk.HKScene

The description of the current loaded scene.

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.

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

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

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

Loads an empty scene

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

video - Variable in class com.biodigital.humansdk.HKChapter

true if this chapter contains a video

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 L M N O P R S T U V W X Z