Package com.biodigital.humansdk

Class HKLabels

java.lang.Object

com.biodigital.humansdk.HKLabels

public class HKLabels
extends Object

HKLabels manages object labels in the scene

Since:

sdk 2.0

Field Summary

Fields

Modifier and Type	Field	Description
HashMap<String,HKLabel>	labels	A map of annotation IDs to HKAnnotation objects in the current scene

Constructor Summary

Constructors

Constructor	Description
HKLabels()

Method Summary

Modifier and Type	Method	Description
void	create(HKLabel label)	Create a Label in the scene with an HKLabel object.
void	destroy(String labelId)	Delete a Label in the scene
void	hide()	Hides the annotations in the scene This allows apps to draw native annotations over the view
void	show()	Shows the annotations in the current scene
void	update(String labelId)	Update a Label in the scene with an updated HKLabel object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

labels

public HashMap<String,HKLabel> labels

A map of annotation IDs to HKAnnotation objects in the current scene

Constructor Details

HKLabels

public HKLabels()

Method Details

show

public void show()

Shows the annotations in the current scene

hide

public void hide()

Hides the annotations in the scene This allows apps to draw native annotations over the view

create

public void create(HKLabel label)

Create a Label in the scene with an HKLabel object.

Parameters:

label - : set up an HKLabel object and pass it to this function to add it to the scene

Since:

sdk 2.0

update

public void update(String labelId)

Update a Label in the scene with an updated HKLabel object.

Parameters:

labelId - : Id of the updated Label to update in the scene

Since:

sdk 2.0

destroy

public void destroy(String labelId)

Delete a Label in the scene

Parameters:

labelId - : Id of the Label to remove from the scene

Since:

sdk 2.0