public interface HKHumanInterface

Callback functions for the 3D Scene

Method Summary

Modifier and Type	Method	Description
`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 complete for a scene
`void`	`onModelLoadError(java.lang.String modelId)`	Called when an error has occurred during loading for a scene
`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

Method Details
- onModelLoaded
  
  void onModelLoaded(java.lang.String modelId)
  
  Called when loading is complete for a scene
  
  Parameters:
  
  modelId - String id of the loaded model
- onModelLoadError
  
  void onModelLoadError(java.lang.String modelId)
  
  Called when an error has occurred during loading for a scene
  
  Parameters:
  
  modelId - String id of the loaded model
- onObjectSelected
  
  void onObjectSelected(java.lang.String objectId)
  
  Called when an object is selected in the scene
  
  Parameters:
  
  objectId - String id of the selected object
- onObjectDeselected
  
  void onObjectDeselected(java.lang.String objectId)
  
  Called when an object is deselected in the scene
  
  Parameters:
  
  objectId - String id of the selected object
- onObjectsShown
  
  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
  
  Parameters:
  
  objects - a Map of object IDs and boolean values for shown/hidden
- onChapterTransition
  
  void onChapterTransition(java.lang.String chapterId)
  
  Called when a new chapter is loaded by the scene
  
  Parameters:
  
  chapterId - String id of the current chapter
- onAnimationComplete
  
  void onAnimationComplete()
  
  Called when the current is done running
- onScreenshot
  
  void onScreenshot(android.graphics.Bitmap image)
  
  Called when a screenshot is returned from the SDK
  
  Parameters:
  
  image - Bitmap representation of the saved screenshot
- onSceneInit
  
  void onSceneInit(java.lang.String title)
  
  Called when the scene is initialized and metadata is available
  
  Parameters:
  
  title - the scene title
- onXrayEnabled
  
  void onXrayEnabled(java.lang.Boolean isEnabled)
  
  Called when xray mode is enabled or disabled
  
  Parameters:
  
  isEnabled - true if enabled
- onSceneRestore
  
  void onSceneRestore()
  
  Called when the scene is restored
- onTimelineUpdated
  
  void onTimelineUpdated(HKTimeline timeline)
  
  Called when the timeline has been updated
  
  Parameters:
  
  timeline - the HKTimeline object
- onAnnotationCreated
  
  void onAnnotationCreated(java.lang.String annotationId)
  
  Called when a new annotation is created in the scene
  
  Parameters:
  
  annotationId - the ID of the new HKAnnotation object
- onAnnotationDestroyed
  
  void onAnnotationDestroyed(java.lang.String annotationId)
  
  Called when an annotation is destroyed in the scene
  
  Parameters:
  
  annotationId - the ID of the destroyed HKAnnotation
- onCameraUpdated
  
  void onCameraUpdated(HKCamera camera)
  
  Called when the camera moves in the scene
  
  Parameters:
  
  camera - the updated HKCamera object
- onObjectPicked
  
  void onObjectPicked(java.lang.String objectId, double[] position)
  
  Called when an object is picked by the user
  
  Parameters:
  
  objectId - the ID of the object
  
  position - the 3D position of the picked object
- onAnnotationsShown
  
  void onAnnotationsShown(java.lang.Boolean isShown)
  
  Called when annotations are shown or hidden in the scene
  
  Parameters:
  
  isShown - true if annotations are shown
- onAnnotationUpdated
  
  void onAnnotationUpdated(HKAnnotation annotation)
  
  Called when the annotations screen position has changed
  
  Parameters:
  
  annotation - the updated HKAnnotation object
- onObjectColor
  
  void onObjectColor(java.lang.String objectId, HKColor color)
  
  Called when an object's color is retrieved
  
  Parameters:
  
  objectId - the ID of the object
  
  color - the HKColor of the object
- onSceneCapture
  
  void onSceneCapture(java.lang.String captureString)
  
  Called when a scene capture is complete
  
  Parameters:
  
  captureString - the saved data as a Json String the capture can also be retrieved as a Map object with HKScene.captureJson

Interface HKHumanInterface

Method Summary

Method Details