HKServices (BioDigital Human SDK)

java.lang.Object
- NanoHTTPD
- - com.biodigital.humansdk.HKServices

All Implemented Interfaces:

HKHumanInterface
```
public class HKServices
extends NanoHTTPD
implements HKHumanInterface
```
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

Field Summary

Fields
Modifier and Type Field and Description

java.util.ArrayList<HKModel> models
Models returned from calling getModels from the Content API

Fields
Modifier and Type	Field and Description
`java.util.ArrayList<HKModel>`	`models` Models returned from calling getModels from the Content API

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`download(java.util.ArrayList<java.lang.String> modelIds)` download a group of models in the background
`void`	`download(java.lang.String modelId)` download a modelsin the background
`static HKServices`	`getInstance()` get the HKServices singleton instance
`void`	`getModels()` Get Models from the Content API - requires API Secret
`java.lang.Boolean`	`modelDownloaded(java.lang.String uri)` Check if a model has already been downloaded
`void`	`onAnimationComplete()` Called when the current is done running
`void`	`onAnnotationCreated(java.lang.String annotationId)` Called when a new annotation is created in the scene
`void`	`onAnnotationDestroyed(java.lang.String annotationId)` Called when an annotation is destroyed in the scene
`void`	`onAnnotationsShown(java.lang.Boolean isShown)` Called when annotations are shown or hidden in the scene
`void`	`onAnnotationUpdated(HKAnnotation annotation)` Called when the annotations screen position has changed
`void`	`onCameraUpdated(HKCamera camera)` Called when the camera moves in the scene
`void`	`onChapterTransition(java.lang.String chapterId)` Called when a new chapter is loaded by the scene
`void`	`onModelLoaded(java.lang.String modelId)` Called when loading is 100% complete for a model
`void`	`onObjectColor(java.lang.String objectId, HKColor color)` Called when an object's color is retrieved
`void`	`onObjectDeselected(java.lang.String objectId)` Called when an object is deselected in the scene
`void`	`onObjectPicked(java.lang.String objectId, double[] position)` Called when an object is picked by the user
`void`	`onObjectSelected(java.lang.String objectId)` Called when an object is selected in the scene
`void`	`onObjectsShown(java.util.Map<java.lang.String,java.lang.Object> objects)` Called when a set of objects are shown or hidden in the scene
`void`	`onSceneCapture(java.lang.String captureString)` Called when a scene capture is complete
`void`	`onSceneInit(java.lang.String title)` Called when the scene is initialized and metadata is available
`void`	`onSceneRestore()` Called when the scene is restored
`void`	`onScreenshot(android.graphics.Bitmap image)` Called when a screenshot is returned from the SDK
`void`	`onTimelineUpdated(HKTimeline timeline)` Called when the timeline has been updated
`void`	`onXrayEnabled(java.lang.Boolean isEnabled)` Called when xray mode is enabled or disabled
`Response`	`serve(IHTTPSession session)` internal method for handling web requests
`void`	`setLanguage(HKLanguage language)` setLanguage - set the current language
`void`	`setup(android.content.Context c, HKServicesInterface delegate)` setup the HKServices singleton and validate the SDK

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - models
```
public java.util.ArrayList<HKModel> models
```
    Models returned from calling getModels from the Content API
- Method Detail
  - onModelLoaded
```
public void onModelLoaded(java.lang.String modelId)
```
    Description copied from interface: HKHumanInterface
    
    Called when loading is 100% complete for a model
    
    Specified by:
    
    onModelLoaded in interface HKHumanInterface
    
    Parameters:
    
    modelId - ID of the loaded model
  - onObjectSelected
```
public void onObjectSelected(java.lang.String objectId)
```
    Description copied from interface: HKHumanInterface
    
    Called when an object is selected in the scene
    
    Specified by:
    
    onObjectSelected in interface HKHumanInterface
    
    Parameters:
    
    objectId - String id of the selected object
  - onObjectDeselected
```
public void onObjectDeselected(java.lang.String objectId)
```
    Description copied from interface: HKHumanInterface
    
    Called when an object is deselected in the scene
    
    Specified by:
    
    onObjectDeselected in interface HKHumanInterface
    
    Parameters:
    
    objectId - String id of the selected object
  - onObjectsShown
```
public void onObjectsShown(java.util.Map<java.lang.String,java.lang.Object> objects)
```
    Description copied from interface: HKHumanInterface
    
    Called when a set of objects are shown or hidden in the scene
    
    Specified by:
    
    onObjectsShown in interface HKHumanInterface
    
    Parameters:
    
    objects - a Map of object IDs and boolean values for shown/hidden
  - onChapterTransition
```
public void onChapterTransition(java.lang.String chapterId)
```
    Description copied from interface: HKHumanInterface
    
    Called when a new chapter is loaded by the scene
    
    Specified by:
    
    onChapterTransition in interface HKHumanInterface
    
    Parameters:
    
    chapterId - String id of the current chapter
  - onAnimationComplete
```
public void onAnimationComplete()
```
    Description copied from interface: HKHumanInterface
    
    Called when the current is done running
    
    Specified by:
    
    onAnimationComplete in interface HKHumanInterface
  - onScreenshot
```
public void onScreenshot(android.graphics.Bitmap image)
```
    Description copied from interface: HKHumanInterface
    
    Called when a screenshot is returned from the SDK
    
    Specified by:
    
    onScreenshot in interface HKHumanInterface
    
    Parameters:
    
    image - Bitmap representation of the saved screenshot
  - onSceneInit
```
public void onSceneInit(java.lang.String title)
```
    Description copied from interface: HKHumanInterface
    
    Called when the scene is initialized and metadata is available
    
    Specified by:
    
    onSceneInit in interface HKHumanInterface
    
    Parameters:
    
    title - the scene title
  - onXrayEnabled
```
public void onXrayEnabled(java.lang.Boolean isEnabled)
```
    Description copied from interface: HKHumanInterface
    
    Called when xray mode is enabled or disabled
    
    Specified by:
    
    onXrayEnabled in interface HKHumanInterface
    
    Parameters:
    
    isEnabled - true if enabled
  - onSceneRestore
```
public void onSceneRestore()
```
    Description copied from interface: HKHumanInterface
    
    Called when the scene is restored
    
    Specified by:
    
    onSceneRestore in interface HKHumanInterface
  - onTimelineUpdated
```
public void onTimelineUpdated(HKTimeline timeline)
```
    Description copied from interface: HKHumanInterface
    
    Called when the timeline has been updated
    
    Specified by:
    
    onTimelineUpdated in interface HKHumanInterface
    
    Parameters:
    
    timeline - the HKTimeline object
  - onAnnotationCreated
```
public void onAnnotationCreated(java.lang.String annotationId)
```
    Description copied from interface: HKHumanInterface
    
    Called when a new annotation is created in the scene
    
    Specified by:
    
    onAnnotationCreated in interface HKHumanInterface
    
    Parameters:
    
    annotationId - the ID of the new HKAnnotation object
  - onAnnotationDestroyed
```
public void onAnnotationDestroyed(java.lang.String annotationId)
```
    Description copied from interface: HKHumanInterface
    
    Called when an annotation is destroyed in the scene
    
    Specified by:
    
    onAnnotationDestroyed in interface HKHumanInterface
    
    Parameters:
    
    annotationId - the ID of the destroyed HKAnnotation
  - onCameraUpdated
```
public void onCameraUpdated(HKCamera camera)
```
    Description copied from interface: HKHumanInterface
    
    Called when the camera moves in the scene
    
    Specified by:
    
    onCameraUpdated in interface HKHumanInterface
    
    Parameters:
    
    camera - the updated HKCamera object
  - onObjectPicked
```
public void onObjectPicked(java.lang.String objectId,
                           double[] position)
```
    Description copied from interface: HKHumanInterface
    
    Called when an object is picked by the user
    
    Specified by:
    
    onObjectPicked in interface HKHumanInterface
    
    Parameters:
    
    objectId - the ID of the object
    
    position - the 3D position of the picked object
  - onAnnotationsShown
```
public void onAnnotationsShown(java.lang.Boolean isShown)
```
    Description copied from interface: HKHumanInterface
    
    Called when annotations are shown or hidden in the scene
    
    Specified by:
    
    onAnnotationsShown in interface HKHumanInterface
    
    Parameters:
    
    isShown - true if annotations are shown
  - onAnnotationUpdated
```
public void onAnnotationUpdated(HKAnnotation annotation)
```
    Description copied from interface: HKHumanInterface
    
    Called when the annotations screen position has changed
    
    Specified by:
    
    onAnnotationUpdated in interface HKHumanInterface
    
    Parameters:
    
    annotation - the updated HKAnnotation object
  - onObjectColor
```
public void onObjectColor(java.lang.String objectId,
                          HKColor color)
```
    Description copied from interface: HKHumanInterface
    
    Called when an object's color is retrieved
    
    Specified by:
    
    onObjectColor in interface HKHumanInterface
    
    Parameters:
    
    objectId - the ID of the object
    
    color - the HKColor of the object
  - onSceneCapture
```
public void onSceneCapture(java.lang.String captureString)
```
    Description copied from interface: HKHumanInterface
    
    Called when a scene capture is complete
    
    Specified by:
    
    onSceneCapture in interface HKHumanInterface
    
    Parameters:
    
    captureString - the saved data as a Json String the capture can also be retrieved as a Map object with HKScene.captureJson
  - getInstance
```
public static HKServices getInstance()
```
    get the HKServices singleton instance
    
    Returns:
    
    the HKServices singleton instance
  - setup
```
public void setup(android.content.Context c,
                  HKServicesInterface delegate)
```
    setup the HKServices singleton and validate the SDK
    
    Parameters:
    
    c - application context (required)
    
    delegate - HKServicesInterface (required)
  - getModels
```
public void getModels()
```
    Get Models from the Content API - requires API Secret
  - serve
```
public Response serve(IHTTPSession session)
```
    internal method for handling web requests
    
    Parameters:
    
    session - http session
    
    Returns:
    
    http response
  - download
```
public void download(java.lang.String modelId)
```
    download a modelsin the background
    
    Parameters:
    
    modelId - Model Identifier
  - download
```
public void download(java.util.ArrayList<java.lang.String> modelIds)
```
    download a group of models in the background
    
    Parameters:
    
    modelIds - ArrayList of Model Identifiers
  - modelDownloaded
```
public java.lang.Boolean modelDownloaded(java.lang.String uri)
```
    Check if a model has already been downloaded
    
    Parameters:
    
    uri - the model id
    
    Returns:
    
    true/false
  - setLanguage
```
public void setLanguage(HKLanguage language)
```
    setLanguage - set the current language
    
    Parameters:
    
    language - an HKLanguage object to translate available text in the 3D scenes

Class HKServices

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

models

Method Detail

onModelLoaded

onObjectSelected

onObjectDeselected

onObjectsShown

onChapterTransition

onAnimationComplete

onScreenshot

onSceneInit

onXrayEnabled

onSceneRestore

onTimelineUpdated

onAnnotationCreated

onAnnotationDestroyed

onCameraUpdated

onObjectPicked

onAnnotationsShown

onAnnotationUpdated

onObjectColor

onSceneCapture

getInstance

setup

getModels

serve

download

download

modelDownloaded

setLanguage