HKScene (BioDigital Human SDK)

java.lang.Object
- com.biodigital.humansdk.HKScene

```
public class HKScene
extends java.lang.Object
```
Scene object - for interacting with objects and scene data

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.ArrayList<HKAnnotation>`	`annotations` A list of HKAnnotation objects.
`java.util.ArrayList<java.lang.String>`	`objectIDs` A flat map of objectID Strings
`java.util.HashMap<java.lang.String,java.lang.String>`	`objects` A map of objectID Strings to Display Names
`java.lang.String`	`text` The description of the current loaded Module.
`java.lang.String`	`title` The title of the current loaded Module.

Constructor Summary

Constructors
Constructor and Description

HKScene()

Constructors
Constructor and Description
`HKScene()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`colorObject(java.lang.String objectID, HKColor color)` Paint an object
`void`	`disableHighlight()` Turn off highlighting the selected object
`void`	`disablePicking()` Disable object selection
`void`	`dissect(boolean enabled)` Turn dissect mode ON or OFF in the current scene
`void`	`enableHighlight()` Turn on highlighting the selected object
`void`	`enablePicking()` Enable object selection
`HKColor`	`getColor(java.lang.String objectID)` Query the color of an object
`double[]`	`getScreenPosition(java.lang.String objectID)` Get screen position of object
`void`	`hideAnnotations()` Hides all annotations.
`void`	`hideLabels()` Hides all labels.
`void`	`isolate(boolean enabled)` Turn isolate mode ON or OFF in the current scene
`void`	`resetScene()` Reset the camera and objects to the current scene/chapter's original state
`void`	`screenshot()` Calls the onScreenshot interface method with the generated screenshot
`void`	`selectObject(java.lang.String objectID)` Select an object programatically
`void`	`setBackgroundColor(int topColor, int bottomColor)` Change the background colors without changing the style, default is radial
`void`	`setBackgroundColor(int topColor, int bottomColor, java.lang.String bgType)` Change the background style with two specified colors
`void`	`setHighlightColor(float[] highlight)` Change the object highlight color
`void`	`setHighlightColor(int color)` Change the object highlight color
`void`	`share()` Brings up the built-in Android share UI with the current contents of the view
`void`	`showAnnotations()` Shows all annotations.
`void`	`showLabels()` Shows all labels.
`void`	`uncolorObject(java.lang.String objectID)` Unpaint an object - set it back to it's original color
`void`	`undo()` Undo the last dissect
`void`	`undoSelections()` Deselect all objects in the scene
`void`	`xray(boolean enabled)` Turn xray mode ON or OFF in the current scene

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

- Field Detail
  - title
```
public java.lang.String title
```
    The title of the current loaded Module.
  - text
```
public java.lang.String text
```
    The description of the current loaded Module.
  - objectIDs
```
public java.util.ArrayList<java.lang.String> objectIDs
```
    A flat map of objectID Strings
  - objects
```
public java.util.HashMap<java.lang.String,java.lang.String> objects
```
    A map of objectID Strings to Display Names
  - annotations
```
public java.util.ArrayList<HKAnnotation> annotations
```
    A list of HKAnnotation objects.
- Constructor Detail
  - HKScene
```
public HKScene()
```
- Method Detail
  - share
```
public void share()
```
    Brings up the built-in Android share UI with the current contents of the view
  - screenshot
```
public void screenshot()
```
    Calls the onScreenshot interface method with the generated screenshot
  - resetScene
```
public void resetScene()
```
    Reset the camera and objects to the current scene/chapter's original state
  - xray
```
public void xray(boolean enabled)
```
    Turn xray mode ON or OFF in the current scene
    
    Parameters:
    
    enabled - A boolean to turn xray mode ON or OFF
  - isolate
```
public void isolate(boolean enabled)
```
    Turn isolate mode ON or OFF in the current scene
    
    Parameters:
    
    enabled - A boolean to turn isolate mode ON or OFF
  - dissect
```
public void dissect(boolean enabled)
```
    Turn dissect mode ON or OFF in the current scene
    
    Parameters:
    
    enabled - A boolean to turn dissect mode ON or OFF
  - undo
```
public void undo()
```
    Undo the last dissect
  - setBackgroundColor
```
public void setBackgroundColor(int topColor,
                               int bottomColor)
```
    Change the background colors without changing the style, default is radial
    
    Parameters:
    
    topColor - Primary color
    
    bottomColor - Secondary color
  - setBackgroundColor
```
public void setBackgroundColor(int topColor,
                               int bottomColor,
                               java.lang.String bgType)
```
    Change the background style with two specified colors
    
    Parameters:
    
    topColor - Primary color
    
    bottomColor - Secondary color
    
    bgType - Background style ("linear" or "radial", default is "radial")
  - disableHighlight
```
public void disableHighlight()
```
    Turn off highlighting the selected object
  - enableHighlight
```
public void enableHighlight()
```
    Turn on highlighting the selected object
  - setHighlightColor
```
public void setHighlightColor(int color)
```
    Change the object highlight color
    
    Parameters:
    
    color - Color as int
  - setHighlightColor
```
public void setHighlightColor(float[] highlight)
```
    Change the object highlight color
    
    Parameters:
    
    highlight - color as [r,b,g] in the range 0 - 1, to make it transparent pass in [1.0,1.0,1.0]
  - showLabels
```
public void showLabels()
```
    Shows all labels.
  - hideLabels
```
public void hideLabels()
```
    Hides all labels.
  - selectObject
```
public void selectObject(java.lang.String objectID)
```
    Select an object programatically
    
    Parameters:
    
    objectID - the object to select
  - undoSelections
```
public void undoSelections()
```
    Deselect all objects in the scene
  - disablePicking
```
public void disablePicking()
```
    Disable object selection
  - enablePicking
```
public void enablePicking()
```
    Enable object selection
  - getScreenPosition
```
public double[] getScreenPosition(java.lang.String objectID)
```
    Get screen position of object
    
    Parameters:
    
    objectID - String
    
    Returns:
    
    position as [x,y]
  - colorObject
```
public void colorObject(java.lang.String objectID,
                        HKColor color)
```
    Paint an object
    
    Parameters:
    
    objectID - - the String id of the object
    
    color - - the HKColor to paint the object
  - uncolorObject
```
public void uncolorObject(java.lang.String objectID)
```
    Unpaint an object - set it back to it's original color
    
    Parameters:
    
    objectID - String id of the object
  - getColor
```
public HKColor getColor(java.lang.String objectID)
```
    Query the color of an object
    
    Parameters:
    
    objectID - - the String id of the object
    
    Returns:
    
    color - the HKColor representing the state of the object
  - showAnnotations
```
public void showAnnotations()
```
    Shows all annotations.
  - hideAnnotations
```
public void hideAnnotations()
```
    Hides all annotations.

Class HKScene

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

title

text

objectIDs

objects

annotations

Constructor Detail

HKScene

Method Detail

share

screenshot

resetScene

xray

isolate

dissect

undo

setBackgroundColor

setBackgroundColor

disableHighlight

enableHighlight

setHighlightColor

setHighlightColor

showLabels

hideLabels

selectObject

undoSelections

disablePicking

enablePicking

getScreenPosition

colorObject

uncolorObject

getColor

showAnnotations

hideAnnotations