Overview  Package   Class  Tree  Index 

be.lassi.lanbox.tools
Class CueListBuilder

java.lang.Object
  extended by be.lassi.lanbox.tools.CueListBuilder
Direct Known Subclasses:
Stockholm

public class CueListBuilder
extends java.lang.Object

Builds cue lists and writes these cue lists to the Lanbox; classes that build actual cue lists can inherited from this class.


Field Summary
protected  java.util.List<CueList> cueLists
           
protected static int LAYER_A
           
protected static int LAYER_B
           
protected static int LAYER_C
           
protected static int LAYER_D
           
protected static int LAYER_E
           
protected static int LAYER_F
           
protected  CueList manualControlCueList
           
 
Constructor Summary
CueListBuilder()
          Constructs a new cue list builder.
 
Method Summary
protected  void clearChannelChanges()
          Empties the collection in which channel changes are collected.
protected  java.awt.Color colorWithHue(float hue)
          Gets the color with given hue (with full saturation and brightness);
protected  void comment(java.lang.String comment)
          Adds one or more comment cuesteps to the current cue list.
protected  void createCueList(int cueListId)
          Creates a new cue list; the new cue list becomes the "current" cue list to which new cue steps will be added.
protected  void createCueList(int cueListId, java.lang.String comment)
          Creates a new cue list; the new cue list becomes the "current" cue list to which new cue steps will be added.
protected  void createCueList(java.lang.String comment)
          Creates a new cue list; the new cue list becomes the "current" cue list to which new cue steps will be added.
protected  void crossFade(Time fadeTime, Time holdTime)
          Adds a cuestep to the current cue list to add a scene with the currently collected channel values.
protected  void crossFade(Time fadeTime, Time holdTime, boolean clearChannelChanges)
          Adds a cuestep to the current cue list to add a scene with the currently collected channel values.
protected  void cueScene(FadeType fadeType, Time fadeTime, Time holdTime)
          Adds a cuestep to the current cue list to add a scene with the currently collected channel values.
protected  void go()
          Creates a new cue list from the current cue steps, and adds a step to the manual control cue list to start this new cue list in a dynamic layer.
protected  void go(int layerNumber)
          Creates a new cue list from the current cue steps, and adds a step to the manual control cue list to start this new cue list in given layer.
protected  void go(java.lang.String timestamp, int layerNumber)
          Adds a cue step in the timed control cue list that will execute a go for the current cue list at given timestamp in given layer.
protected  void hold(Time holdTime)
          Adds a cuestep to the current cue list to add a scene with the currently collected channel values; the crossfade is done instantly.
protected  void loopTo(int cueStepId, int loopCount)
          Adds a cuestep to the current cue list to jump to given cue list step, and repeat the jump the specified number of times.
protected  Time millis(int millis)
          Gets the Lanbox encoded time that is closest to given number of milliseconds.
protected  int nextCueStepNumber()
          Gets the number that the next cue step that will be added to the current cue list will have.
protected  void resetLayer(int layerNumber)
          Adds a cuestep to the current cue list to reset given layer.
protected  Time seconds(int seconds)
          Gets the Lanbox encoded time that is closest to given number of seconds.
protected  void setAttribute(Fixtures fixtures, java.lang.String attributeName, int dmxValue)
          Sets the attribute with given name to given dmx value in given fixtures.
protected  void setAttribute(Fixture fixture, java.lang.String attributeName, int dmxValue)
          Sets the attribute with given name to given dmx value in given fixture.
protected  void setColor(Fixture fixture, java.awt.Color color)
          Sets the color attributes of given fixture to given color.
protected  void setColor(Fixtures fixtures, java.awt.Color color)
          Sets the color attribute of given fixtures to given color.
protected  void setColors(FixtureGroups groups, Colors colors)
          Sets the color attributes of the fixtures in given fixture groups to the colors in given color collection (both the fixture groups and the colors collection have to have the same size).
protected  void setColors(Fixtures fixtures, Colors colors)
          Sets the color attributes of given fixtures to the colors in given color collection (both the fixtures and the colors collection have to have the same size).
protected  void setIntensity(Fixture fixture, int percentage)
          Sets the intensity attribute value (0 to 100) of given fixture.
protected  void setIntensity(Fixtures fixtures, int percentage)
          Sets the intensity attribute value (0 to 100) of given fixtures.
protected  void setLayerMixMode(int layerNumber, MixMode mixMode)
          Adds a cuestep to the current cue list to set the mix mode in given layer.
protected  void stop(int layerNumber)
          Adds a cuestep to the current cue list to stop the sequencer in given layer.
protected  void writeCueLists()
          Writes the cue lists to the Lanbox.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cueLists

protected final java.util.List<CueList> cueLists

LAYER_A

protected static final int LAYER_A
See Also:
Constant Field Values

LAYER_B

protected static final int LAYER_B
See Also:
Constant Field Values

LAYER_C

protected static final int LAYER_C
See Also:
Constant Field Values

LAYER_D

protected static final int LAYER_D
See Also:
Constant Field Values

LAYER_E

protected static final int LAYER_E
See Also:
Constant Field Values

LAYER_F

protected static final int LAYER_F
See Also:
Constant Field Values

manualControlCueList

protected final CueList manualControlCueList
Constructor Detail

CueListBuilder

public CueListBuilder()
Constructs a new cue list builder.

Method Detail

clearChannelChanges

protected void clearChannelChanges()
Empties the collection in which channel changes are collected.


colorWithHue

protected java.awt.Color colorWithHue(float hue)
Gets the color with given hue (with full saturation and brightness);

Parameters:
hue - the color hue value
Returns:
the color with given hue

comment

protected void comment(java.lang.String comment)
Adds one or more comment cuesteps to the current cue list.

Parameters:
comment - the comment to be added, multiple comments can be added by separating the comments with a newline character

createCueList

protected void createCueList(int cueListId)
Creates a new cue list; the new cue list becomes the "current" cue list to which new cue steps will be added.

Parameters:
cueListId - the cue list number

createCueList

protected void createCueList(int cueListId,
                             java.lang.String comment)
Creates a new cue list; the new cue list becomes the "current" cue list to which new cue steps will be added.

Parameters:
cueListId - the cue list number
comment - a comment that will added in the first cue step(s) of the new cue list

createCueList

protected void createCueList(java.lang.String comment)
Creates a new cue list; the new cue list becomes the "current" cue list to which new cue steps will be added.

Parameters:
comment - a comment that will added in the first cue step(s) of the new cue list

crossFade

protected void crossFade(Time fadeTime,
                         Time holdTime)
Adds a cuestep to the current cue list to add a scene with the currently collected channel values.

Parameters:
fadeTime - the time used for the fading operation
holdTime - the time to wait before stepping to the next cue list step

crossFade

protected void crossFade(Time fadeTime,
                         Time holdTime,
                         boolean clearChannelChanges)
Adds a cuestep to the current cue list to add a scene with the currently collected channel values.

Parameters:
fadeTime - the time used for the fading operation
holdTime - the time to wait before stepping to the next cue list step
clearChannelChanges - true if the collection in which channel changes are collected needs to be emptied afterwards

cueScene

protected void cueScene(FadeType fadeType,
                        Time fadeTime,
                        Time holdTime)
Adds a cuestep to the current cue list to add a scene with the currently collected channel values.

Parameters:
fadeType - the type of fading to be used to set the channel values
fadeTime - the time used for the fading operation
holdTime - the time to wait before stepping to the next cue list step

go

protected void go()
Creates a new cue list from the current cue steps, and adds a step to the manual control cue list to start this new cue list in a dynamic layer.


go

protected void go(int layerNumber)
Creates a new cue list from the current cue steps, and adds a step to the manual control cue list to start this new cue list in given layer.

Parameters:
layerNumber - the layer in which to execute the cue list

go

protected void go(java.lang.String timestamp,
                  int layerNumber)
Adds a cue step in the timed control cue list that will execute a go for the current cue list at given timestamp in given layer.

Parameters:
timestamp - the timestamp at which to execute the go
layerNumber - the layer in which to

hold

protected void hold(Time holdTime)
Adds a cuestep to the current cue list to add a scene with the currently collected channel values; the crossfade is done instantly.

Parameters:
holdTime - the time to wait before stepping to the next cue list step

loopTo

protected void loopTo(int cueStepId,
                      int loopCount)
Adds a cuestep to the current cue list to jump to given cue list step, and repeat the jump the specified number of times.

Parameters:
cueStepId - the number of the cue step within the current cue list to jump to
loopCount - number of time to repeat the jump

millis

protected Time millis(int millis)
Gets the Lanbox encoded time that is closest to given number of milliseconds.

Parameters:
millis - the time duration in number of milliseconds
Returns:
a Lanbox encoded time

nextCueStepNumber

protected int nextCueStepNumber()
Gets the number that the next cue step that will be added to the current cue list will have. This can be usefull in the program logic to record a cue list position to jump back to in a loop.

Returns:
the number of the next cue step

resetLayer

protected void resetLayer(int layerNumber)
Adds a cuestep to the current cue list to reset given layer.

Parameters:
layerNumber - the layer to be reset

seconds

protected Time seconds(int seconds)
Gets the Lanbox encoded time that is closest to given number of seconds.

Parameters:
seconds - the time duration in number of seconds
Returns:
a Lanbox encoded time

setAttribute

protected void setAttribute(Fixtures fixtures,
                            java.lang.String attributeName,
                            int dmxValue)
Sets the attribute with given name to given dmx value in given fixtures.

Parameters:
fixtures - the fixtures for which to change the attribute
attributeName - the name of the attribute to be changed
dmxValue - the new dmx value for given attribute

setAttribute

protected void setAttribute(Fixture fixture,
                            java.lang.String attributeName,
                            int dmxValue)
Sets the attribute with given name to given dmx value in given fixture.

Parameters:
fixture - the fixture for which to change the attribute
attributeName - the name of the attribute to be changed
dmxValue - the new dmx value for given attribute

setColor

protected void setColor(Fixture fixture,
                        java.awt.Color color)
Sets the color attributes of given fixture to given color.

Parameters:
fixture - the fixture for which to set the color
color - the color to be set

setColor

protected void setColor(Fixtures fixtures,
                        java.awt.Color color)
Sets the color attribute of given fixtures to given color.

Parameters:
fixtures - the fixtures for which to set the color
color - the color to be set

setColors

protected void setColors(FixtureGroups groups,
                         Colors colors)
Sets the color attributes of the fixtures in given fixture groups to the colors in given color collection (both the fixture groups and the colors collection have to have the same size).

Parameters:
groups - the fixture groups for which to set the colors
colors - the colors to set

setColors

protected void setColors(Fixtures fixtures,
                         Colors colors)
Sets the color attributes of given fixtures to the colors in given color collection (both the fixtures and the colors collection have to have the same size).

Parameters:
fixtures - the fixtures for which to set the colors
colors - the colors to set

setIntensity

protected void setIntensity(Fixture fixture,
                            int percentage)
Sets the intensity attribute value (0 to 100) of given fixture.

Parameters:
fixtures - the fixture for which to set the intensity attribute value
percentage - the intensity value (0 to 100) to be set

setIntensity

protected void setIntensity(Fixtures fixtures,
                            int percentage)
Sets the intensity attribute value (0 to 100) of given fixtures.

Parameters:
fixtures - the fixtures for which to set the intensity attribute value
percentage - the intensity value (0 to 100) to be set

setLayerMixMode

protected void setLayerMixMode(int layerNumber,
                               MixMode mixMode)
Adds a cuestep to the current cue list to set the mix mode in given layer.

Parameters:
layerNumber - the layer for which to set the mix mode
mixMode - the mix mode to be set

stop

protected void stop(int layerNumber)
Adds a cuestep to the current cue list to stop the sequencer in given layer.

Parameters:
layerNumber - the layer in which to stop the sequencer

writeCueLists

protected void writeCueLists()
Writes the cue lists to the Lanbox.


Overview  Package   Class  Tree  Index 
Lighting Assistant 1.2