sigmlanim.sigmlstream.interfaces

Interface StreamedSiGMLSupplierForAnimationGen

All Known Implementing Classes:

FilteringSupplierForAnimGen, SiGMLInputAnimGenCoordinator, SignsArraySupplier

public interface StreamedSiGMLSupplierForAnimationGen

Interface implemented by an object able to supply the content of a SiGML document to an animation module as a stream of AnimatedSigns, with animation data not yet attached at the time they are supplied. This is a "pull" interface, i.e. the supplier delivers a sign only in response to an explicit request from its client, via getNextSignToBeAnimated().

Method Summary

Modifier and Type	Method and Description
void	doneSignAnimation() Accepts a notification from this supplier's client indicating that it has completed processing of one more sign in the stream supplied to date.
AnimatedSign	getNextSignToBeAnimated() Returns next SiGML sign to be animated, or null, if the sign stream is exhausted.

Method Detail

getNextSignToBeAnimated

AnimatedSign getNextSignToBeAnimated()
                              throws java.lang.InterruptedException

Returns next SiGML sign to be animated, or null, if the sign stream is exhausted.

Throws:

java.lang.InterruptedException

doneSignAnimation

void doneSignAnimation()

Accepts a notification from this supplier's client indicating that it has completed processing of one more sign in the stream supplied to date.