heronarts.lx.command

Class LXCommand.Parameter.SetColor

java.lang.Object

heronarts.lx.command.LXCommand

heronarts.lx.command.LXCommand.Parameter.SetColor

Enclosing class:

LXCommand.Parameter

public static class LXCommand.Parameter.SetColor
extends LXCommand

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.command.LXCommand

LXCommand.Channel, LXCommand.ComponentReference<T extends LXComponent>, LXCommand.InvalidCommandException, LXCommand.Midi, LXCommand.Mixer, LXCommand.Modulation, LXCommand.Palette, LXCommand.Parameter, LXCommand.ParameterReference<T extends LXParameter>, LXCommand.RemoveComponent, LXCommand.Snapshots, LXCommand.Structure

Constructor Summary

Constructors

Constructor and Description
SetColor(ColorParameter colorParameter)
SetColor(ColorParameter colorParameter, double hue, double saturation)

Method Summary

Modifier and Type	Method and Description
String	getDescription() Short description of a command, to explain it to the user
void	perform(LX lx) Perform the given command
void	undo(LX lx) Undo the command, after it has been performed
LXCommand.Parameter.SetColor	update(double hue, double saturation)

Methods inherited from class java.lang.Object

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

Constructor Detail

SetColor

public SetColor(ColorParameter colorParameter)

SetColor

public SetColor(ColorParameter colorParameter,
                double hue,
                double saturation)

Method Detail

getDescription

public String getDescription()

Description copied from class: LXCommand

Short description of a command, to explain it to the user

Specified by:

getDescription in class LXCommand

Returns:

short description of command

perform

public void perform(LX lx)
             throws LXCommand.InvalidCommandException

Description copied from class: LXCommand

Perform the given command

Specified by:

perform in class LXCommand

Parameters:

lx - LX instance

Throws:

LXCommand.InvalidCommandException - if the command is invalid

update

public LXCommand.Parameter.SetColor update(double hue,
                                           double saturation)

undo

public void undo(LX lx)
          throws LXCommand.InvalidCommandException

Description copied from class: LXCommand

Undo the command, after it has been performed

Specified by:

undo in class LXCommand

Parameters:

lx - LX instance

Throws:

LXCommand.InvalidCommandException - if the command is invalid