org.mechio.api.animation.protocol
Interface AnimationSignal

public interface AnimationSignal

An interface for animation signalling events.

Author:

Jason G. Pallack

Nested Class Summary

static interface

AnimationSignal.AnimationSignalFactory

Field Summary

static String	EVENT_CANCEL
static String	EVENT_COMPLETE
static String	EVENT_PAUSE
static String	EVENT_RESUME
static String	EVENT_START
static String	PROP_LOOP
static String	PROP_RAMPING

Method Summary

Integer	getAnimationHash() Returns an Integer hash of the animation
Long	getAnimationLength() Returns the Long length of the animation.
String	getAnimationName() Returns a String representing the name of the animation.
List<String>	getAnimationProperties() Returns a List of Strings containing the animation properties
String	getAnimationVersion() Returns a String representing the version of the animation.
String	getEventType() Returns a String representing the type of the event.
String	getSourceId() Returns the id String for the source of the AnimationSignal.
Long	getTimestampMillisecUTC() Returns the timestamp of the AnimationSignal.

Field Detail

EVENT_START

static final String EVENT_START

See Also:

Constant Field Values

EVENT_PAUSE

static final String EVENT_PAUSE

See Also:

Constant Field Values

EVENT_RESUME

static final String EVENT_RESUME

See Also:

Constant Field Values

EVENT_COMPLETE

static final String EVENT_COMPLETE

See Also:

Constant Field Values

EVENT_CANCEL

static final String EVENT_CANCEL

See Also:

Constant Field Values

PROP_LOOP

static final String PROP_LOOP

See Also:

Constant Field Values

PROP_RAMPING

static final String PROP_RAMPING

See Also:

Constant Field Values

Method Detail

getSourceId

String getSourceId()

Returns the id String for the source of the AnimationSignal.

Returns:

id String for the source of the AnimationSignal

getTimestampMillisecUTC

Long getTimestampMillisecUTC()

Returns the timestamp of the AnimationSignal.

Returns:

timestamp of the AnimationSignal

getEventType

String getEventType()

Returns a String representing the type of the event.

Returns:

String representing the type of the event

getAnimationName

String getAnimationName()

Returns a String representing the name of the animation.

Returns:

String representing the name of the animation

getAnimationVersion

String getAnimationVersion()

Returns a String representing the version of the animation.

Returns:

String representing the version of the animation

getAnimationHash

Integer getAnimationHash()

Returns an Integer hash of the animation

Returns:

Integer hash of the animation

getAnimationLength

Long getAnimationLength()

Returns the Long length of the animation.

Returns:

Long length of the animation

getAnimationProperties

List<String> getAnimationProperties()

Returns a List of Strings containing the animation properties

Returns:

List of Strings containing the animation properties