fi.helsinki.dacopan.animseq
Interface ScenarioItem

All Known Implementing Classes:

ScenarioItemENC, ScenarioItemEndMarker, ScenarioItemMSC, ScenarioItemPause

public interface ScenarioItem

An interface for all scenario items stored in the animation sequence. Each item should store an individual copy (clone, if necessary) of the settings it needs.

NOTE: The implementing class itself is responsible for creating the necessary clones of objects passed to it.

Method Summary

void	doAction(MainFrame mainFrame, boolean inRecordingMode) Performs the action stored in this scenario item.
java.lang.String	getPlaylistText() Returns a short text representation of the scenario item for presentation in the playlist.
boolean	getShowable() Should return true if the item will set the main frame to some reasonable state and false otherwise.
boolean	recordEnd(float nowTime)

Method Detail

doAction

void doAction(MainFrame mainFrame,
              boolean inRecordingMode)

Performs the action stored in this scenario item.

Parameters:

mainFrame - A reference to a MainFrame instance in order to be able to carry out necessary mode changes.

inRecordingMode - Tells the item if the AnimationSequence is in recording mode or not. If true, the item should refraing from any potentially confusing mode changes, like automatically putting AnimationTimeState in play mode.

getPlaylistText

java.lang.String getPlaylistText()

Returns a short text representation of the scenario item for presentation in the playlist.

recordEnd

boolean recordEnd(float nowTime)

Returns:

True if recording the end was successful, false if not. The animation sequence is only allowed to move into recording the next item if the recording was successful.

getShowable

boolean getShowable()

Should return true if the item will set the main frame to some reasonable state and false otherwise. Examples of items that should return true are MSC and ENC items, and examples of items returning false are pause item and end marker item.