story.scheherazade.virgil
Class Virgil

java.lang.Object
  extended by story.scheherazade.virgil.Virgil

public class Virgil
extends java.lang.Object

Root class for Virgil, the Scheherazade GUI.


Nested Class Summary
 class Virgil.LeftSideMouseListener
           
 class Virgil.SymbolicStackMouseListener
           
 
Field Summary
static java.lang.String ACTIONSELECTOR_CARD
           
static java.lang.String AUTHORING_PANEL_CARD
           
static java.awt.Font bannerFontBig
           
static java.awt.Font bannerFontMedium
           
static java.awt.Font bannerFontSmall
           
static java.awt.Color brushedMetal
           
static java.awt.Color brushedMetalGold
           
static java.awt.Font captionFont
           
static java.lang.String CONDITIONSELECTOR_CARD
           
static java.lang.String CONTROLPANEL_CARD
           
static java.awt.Font defaultFont
           
static java.awt.Color editColor
           
static java.awt.Font headerFont
           
static java.lang.String HELPCONTENT_CARD
           
static java.lang.String HELPINDEX_CARD
           
static java.awt.Color highlightColor
           
static java.lang.String INTERPRETATIVE_CARD
           
static java.lang.String INTERPRETATIVEDETAIL_CARD
           
static java.lang.String KNOWLEDGEEDITOR_CARD
           
static java.lang.String MODIFIERSELECTOR_CARD
           
static java.lang.String SETTINGSPANEL_CARD
           
static java.awt.Font smallFont
           
static java.awt.Color sourceHighlightColor
           
static java.lang.String TEXTUAL_CARD
           
static java.lang.String TIMELINE_CARD
           
static java.lang.String TIMELINEPANEL_CARD
           
 
Constructor Summary
Virgil(VirgilConfiguration config, boolean quitAppOnWindowClose, WaitFrame waitDialog, double startWaitProgress)
          Constructor with story to load.
 
Method Summary
 int confirm(java.lang.String s, java.lang.String title)
          1 - No
0 - Yes
 int confirmWithCancel(java.lang.String s, java.lang.String title)
          2 - Cancel
1 - No
0 - Yes
 java.lang.Object execute(VirgilCommand virgilCommand)
          Execute a VirgilCommand.
static AssignedActionSet getActionsInTransition(StoryInterpreter storyInterpreter, TimelineID timelineID, TransitionTime time)
          Get all the assigned actions for a transition.
 TimelineTime getAttachmentPoint(TimelineID timeline)
           
 HistoryFrameID getCurrentStateID()
          Get the HistoryFrameID of the current state
 java.lang.String getShownLeftSideCard()
          Return the card currently being shown in the left side card stack.
 java.lang.String getShownRightSideCard()
          Return the card currently being shown in the right side card stack.
 java.lang.String getShownSymbolicCard()
          Return the card currently being shown in the symbolic stack.
 StoryTelling getStartupTelling()
          Get the StoryTelling of the startup state of the interface, after the default world knowledge and before any user input
 java.lang.Object hear(StoryPoint point)
          Accessor function for easily hearing a StoryPoint without having to encapsulate in a VirgilCommand.
 void resetHighlights()
           
 void resetStory()
          Reset the narrative back to where it was after configuration.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

captionFont

public static final java.awt.Font captionFont

headerFont

public static final java.awt.Font headerFont

bannerFontBig

public static final java.awt.Font bannerFontBig

bannerFontMedium

public static final java.awt.Font bannerFontMedium

bannerFontSmall

public static final java.awt.Font bannerFontSmall

defaultFont

public static final java.awt.Font defaultFont

smallFont

public static final java.awt.Font smallFont

highlightColor

public static final java.awt.Color highlightColor

sourceHighlightColor

public static final java.awt.Color sourceHighlightColor

TEXTUAL_CARD

public static final java.lang.String TEXTUAL_CARD
See Also:
Constant Field Values

CONDITIONSELECTOR_CARD

public static final java.lang.String CONDITIONSELECTOR_CARD
See Also:
Constant Field Values

ACTIONSELECTOR_CARD

public static final java.lang.String ACTIONSELECTOR_CARD
See Also:
Constant Field Values

MODIFIERSELECTOR_CARD

public static final java.lang.String MODIFIERSELECTOR_CARD
See Also:
Constant Field Values

TIMELINE_CARD

public static final java.lang.String TIMELINE_CARD
See Also:
Constant Field Values

TIMELINEPANEL_CARD

public static final java.lang.String TIMELINEPANEL_CARD
See Also:
Constant Field Values

AUTHORING_PANEL_CARD

public static final java.lang.String AUTHORING_PANEL_CARD
See Also:
Constant Field Values

INTERPRETATIVE_CARD

public static final java.lang.String INTERPRETATIVE_CARD
See Also:
Constant Field Values

INTERPRETATIVEDETAIL_CARD

public static final java.lang.String INTERPRETATIVEDETAIL_CARD
See Also:
Constant Field Values

CONTROLPANEL_CARD

public static final java.lang.String CONTROLPANEL_CARD
See Also:
Constant Field Values

SETTINGSPANEL_CARD

public static final java.lang.String SETTINGSPANEL_CARD
See Also:
Constant Field Values

KNOWLEDGEEDITOR_CARD

public static final java.lang.String KNOWLEDGEEDITOR_CARD
See Also:
Constant Field Values

HELPCONTENT_CARD

public static final java.lang.String HELPCONTENT_CARD
See Also:
Constant Field Values

HELPINDEX_CARD

public static final java.lang.String HELPINDEX_CARD
See Also:
Constant Field Values

brushedMetal

public static final java.awt.Color brushedMetal

brushedMetalGold

public static final java.awt.Color brushedMetalGold

editColor

public static final java.awt.Color editColor
Constructor Detail

Virgil

public Virgil(VirgilConfiguration config,
              boolean quitAppOnWindowClose,
              WaitFrame waitDialog,
              double startWaitProgress)
       throws Scheherexception
Constructor with story to load.

Throws:
Scheherexception
Method Detail

resetStory

public void resetStory()
                throws Scheherexception
Reset the narrative back to where it was after configuration.

Throws:
Scheherexception

getCurrentStateID

public HistoryFrameID getCurrentStateID()
Get the HistoryFrameID of the current state


getStartupTelling

public StoryTelling getStartupTelling()
                               throws Scheherexception
Get the StoryTelling of the startup state of the interface, after the default world knowledge and before any user input

Throws:
Scheherexception

getShownSymbolicCard

public java.lang.String getShownSymbolicCard()
Return the card currently being shown in the symbolic stack.


getShownLeftSideCard

public java.lang.String getShownLeftSideCard()
Return the card currently being shown in the left side card stack.


getShownRightSideCard

public java.lang.String getShownRightSideCard()
Return the card currently being shown in the right side card stack.


resetHighlights

public void resetHighlights()

hear

public java.lang.Object hear(StoryPoint point)
                      throws Scheherexception
Accessor function for easily hearing a StoryPoint without having to encapsulate in a VirgilCommand.

Throws:
Scheherexception

execute

public java.lang.Object execute(VirgilCommand virgilCommand)
                         throws Scheherexception
Execute a VirgilCommand.

Throws:
Scheherexception

getAttachmentPoint

public TimelineTime getAttachmentPoint(TimelineID timeline)
                                throws Scheherexception
Throws:
Scheherexception

getActionsInTransition

public static AssignedActionSet getActionsInTransition(StoryInterpreter storyInterpreter,
                                                       TimelineID timelineID,
                                                       TransitionTime time)
                                                throws Scheherexception
Get all the assigned actions for a transition. Compiles not only the actions in the transition itself, but actions beginning at the FROM state and ending at the TO state. This is the way Virgil simplifies a Scheherazade timeline into a one-dimensional vector with transitions between each state: each transition contains the actions beginning at the state before the diamond, as well as the actions ending at the state after the diamond.

Throws:
Scheherexception

confirm

public int confirm(java.lang.String s,
                   java.lang.String title)
1 - No
0 - Yes


confirmWithCancel

public int confirmWithCancel(java.lang.String s,
                             java.lang.String title)
2 - Cancel
1 - No
0 - Yes



Copyright © 2011 David K. Elson. All Rights Reserved.