Overview  Package   Class  Tree  Index 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

be.lassi.cues
Class Timing

java.lang.Object
  extended by be.lassi.cues.Timing

public class Timing
extends java.lang.Object

The timing information for a single cue, consisting of potentially different times for fade in and fade out, and different wait times for fade in and fade out, an overall initial wait, and an hold time at the end.

Constructor Summary
Timing()
          Constructs a new instance.
Timing(Time time)
          Constructs a new instance with given time (no wait times).
Timing(Time fadeInTime, Time fadeInDelay, Time fadeOutTime, Time fadeOutDelay, Time waitTime, Time holdTime, boolean splitFade)
          Constructs a new instance.
 
Method Summary
 void append(java.lang.StringBuilder b)
          Appends a description of this timing to given string builder.
 java.lang.String displayString()
          Return string representation of the timing information.
 boolean equals(java.lang.Object object)
          
 Time getFadeInDelay()
          Gets the time to wait before fade in starts.
 Time getFadeInTime()
          Gets the duration of the fade in.
 Time getFadeOutDelay()
          Gets the time to wait before the fade out starts.
 Time getFadeOutTime()
          Gets the duration of fade out.
 Time getHoldTime()
          Gets the time to hold the scene after the fade completes and before automatically going to the next cue.
 Time getWaitTime()
          Gets the time to wait before any fading activity starts.
 boolean isSplitFade()
          Indicates whether this is a split fade (different durations for fade in and fade out).
 void reset()
          Set all values to default zero.
 void set(Timing timing)
          Sets the timing.
 void setFadeInDelay(Time time)
          Sets the time to wait before fade in starts.
 void setFadeInTime(Time time)
          Sets the duration of the fade in.
 void setFadeOutDelay(Time time)
          Sets the time to wait before fade out starts.
 void setFadeOutTime(Time time)
          Sets the duration of the fade out.
 void setHoldTime(Time time)
          Sets the time to hold the scene after the fade complete and before automatically going to the next cue.
 void setSplitFade(boolean splitFade)
          Sets the 'split fade' indicator.
 void setWaitTime(Time time)
          Sets the time to wait before any fading activity starts.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Timing

public Timing()
Constructs a new instance.

Timing

public Timing(Time time)
Constructs a new instance with given time (no wait times).

Parameters:
time - the time to be used for fade in and fade out duration

Timing

public Timing(Time fadeInTime,
              Time fadeInDelay,
              Time fadeOutTime,
              Time fadeOutDelay,
              Time waitTime,
              Time holdTime,
              boolean splitFade)
Constructs a new instance.

Parameters:
fadeInTime - the fade in duration
fadeInDelay - the wait time before fade in
fadeOutTime - the fade out duration
fadeOutDelay - the wait time before fade out
waitTime - the delay time before fading starts
holdTime - the time to hold the scene after the fade before automatically going to the next cue
splitFade - true if fade in and fade out times are different
Method Detail

append

public void append(java.lang.StringBuilder b)
Appends a description of this timing to given string builder.

Parameters:
b - the string builder to append to

displayString

public java.lang.String displayString()
Return string representation of the timing information.

fadeInTime/fadeInDelay-fadeOutTime/fadeOutDelay*waitTime+holdTime

Returns:
String

equals

public boolean equals(java.lang.Object object)

Overrides:
equals in class java.lang.Object

getFadeInDelay

public Time getFadeInDelay()
Gets the time to wait before fade in starts.

Returns:
long delay in milliseconds

getFadeInTime

public Time getFadeInTime()
Gets the duration of the fade in.

Returns:
fade in duration in milliseconds

getFadeOutDelay

public Time getFadeOutDelay()
Gets the time to wait before the fade out starts.

Returns:
the delay

getFadeOutTime

public Time getFadeOutTime()
Gets the duration of fade out.

Returns:
the fade out duration

getHoldTime

public Time getHoldTime()
Gets the time to hold the scene after the fade completes and before automatically going to the next cue.

Returns:
wait time in milliseconds

getWaitTime

public Time getWaitTime()
Gets the time to wait before any fading activity starts.

Returns:
wait time in milliseconds

isSplitFade

public boolean isSplitFade()
Indicates whether this is a split fade (different durations for fade in and fade out).

Returns:
true if this is a split fade

reset

public void reset()
Set all values to default zero.

set

public void set(Timing timing)
Sets the timing.

Parameters:
timing - another Timing object

setFadeInDelay

public void setFadeInDelay(Time time)
Sets the time to wait before fade in starts.

Parameters:
time - the wait time in milliseconds

setFadeInTime

public void setFadeInTime(Time time)
Sets the duration of the fade in.

Parameters:
time - the fade in time in milliseconds

setFadeOutDelay

public void setFadeOutDelay(Time time)
Sets the time to wait before fade out starts.

Parameters:
time - the wait time in milliseconds

setFadeOutTime

public void setFadeOutTime(Time time)
Sets the duration of the fade out.

Parameters:
time - the fade out time in milliseconds

setHoldTime

public void setHoldTime(Time time)
Sets the time to hold the scene after the fade complete and before automatically going to the next cue.

Parameters:
time - the hold time in milliseconds

setSplitFade

public void setSplitFade(boolean splitFade)
Sets the 'split fade' indicator.

Parameters:
splitFade - true if this is a split fade

setWaitTime

public void setWaitTime(Time time)
Sets the time to wait before any fading activity starts.

Parameters:
time - the wait time in milliseconds

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object
Overview  Package   Class  Tree  Index 
Lighting Assistant 1.2
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD