fi.helsinki.dacopan.animseq
Class ScenarioItemMSC

java.lang.Object
  fi.helsinki.dacopan.animseq.ScenarioItemMSC

All Implemented Interfaces:

ScenarioItem

public class ScenarioItemMSC
extends java.lang.Object
implements ScenarioItem

A list item for an MSC animation.

An MSC item in the list contains a SettingsMSC instance that in turn contains all information necessary for presenting the MSC animation. Particularly, unlike in explore mode, now the SettingsMSC object will also store a start time and an end time for this scenario item.

Constructor Summary

ScenarioItemMSC(SettingsMSC settings, float startTime)
Creates a new instance of ScenarioItemMSC.

Method Summary

void	doAction(MainFrame mainFrame, boolean inRecordingMode) Instructs the MainFrame instance to display the MSC animation.
java.lang.String	getPlaylistText() Returns a short text representation of the scenario item for presentation in the playlist.
boolean	getShowable() Always returns true.
boolean	recordEnd(float nowTime) Tries to record an end time and returns the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScenarioItemMSC

public ScenarioItemMSC(SettingsMSC settings,
                       float startTime)

Creates a new instance of ScenarioItemMSC.

NOTE: The ScenarioItemMSC will store a clone of the original settings object.

Method Detail

doAction

public void doAction(MainFrame mainFrame,
                     boolean inRecordingMode)

Instructs the MainFrame instance to display the MSC animation. If the SettingsMSC object for this item return true from getScenarioAutoPlay(), the AnimatioTimeState instance is also put to play mode.

Specified by:

doAction in interface ScenarioItem

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

public java.lang.String getPlaylistText()

Description copied from interface: ScenarioItem

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

Specified by:

getPlaylistText in interface ScenarioItem

recordEnd

public boolean recordEnd(float nowTime)

Tries to record an end time and returns the result.

Specified by:

recordEnd in interface ScenarioItem

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

public boolean getShowable()

Always returns true.

Specified by:

getShowable in interface ScenarioItem