com.biodigital.humansdk

Class HKTimeline

java.lang.Object

com.biodigital.humansdk.HKTimeline

public class HKTimeline
extends java.lang.Object

Timeline object - for interacting with chapters and animations in a scene

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<java.lang.String>	chapterList An ordered list of chapter IDs
java.util.HashMap<java.lang.String,HKChapter>	chapters A map of chapter IDs to Chapter objects.
HKChapter	currentChapter A map of chapter IDs to Chapter objects.
float	currentTime The current animation time
float	duration The current animation duration

Constructor Summary

Constructors

Constructor and Description
HKTimeline()

Method Summary

Modifier and Type	Method and Description
void	moveToChapter(java.lang.String chapterID) Jump to the current module's chapter with the given ID
void	moveToTime(float time) Jump to the given time in the current scene's current animation
void	nextChapter() Jump to the current module's next chapter
void	pause() Pause the current scene's animation
void	play() Play the current scene's animation
boolean	playing() Check if there is an animation playing
void	prevChapter() Jump to the current module's previous chapter
void	unpause() Unpause the current scene's animation

Methods inherited from class java.lang.Object

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

Field Detail

currentChapter

public HKChapter currentChapter

A map of chapter IDs to Chapter objects.

chapters

public java.util.HashMap<java.lang.String,HKChapter> chapters

A map of chapter IDs to Chapter objects.

chapterList

public java.util.ArrayList<java.lang.String> chapterList

An ordered list of chapter IDs

currentTime

public float currentTime

The current animation time

duration

public float duration

The current animation duration

Constructor Detail

HKTimeline

public HKTimeline()

Method Detail

play

public void play()

Play the current scene's animation

pause

public void pause()

Pause the current scene's animation

unpause

public void unpause()

Unpause the current scene's animation

nextChapter

public void nextChapter()

Jump to the current module's next chapter

prevChapter

public void prevChapter()

Jump to the current module's previous chapter

moveToChapter

public void moveToChapter(java.lang.String chapterID)

Jump to the current module's chapter with the given ID

Parameters:

chapterID - ID of the chapter

moveToTime

public void moveToTime(float time)

Jump to the given time in the current scene's current animation

Parameters:

time - animation offset in seconds

playing

public boolean playing()

Check if there is an animation playing

Returns:

is the current scene playing an animation?