heronarts.lx.command

Class LXCommand.Modulation.AddModulator

java.lang.Object

heronarts.lx.command.LXCommand

heronarts.lx.command.LXCommand.Modulation.AddModulator

Enclosing class:

LXCommand.Modulation

public static class LXCommand.Modulation.AddModulator
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
AddModulator(LXModulationEngine modulation, Class<? extends LXModulator> modulatorClass)
AddModulator(LXModulationEngine modulation, Class<? extends LXModulator> modulatorClass, int modulationColor)
AddModulator(LXModulationEngine modulation, Class<? extends LXModulator> modulatorClass, JsonObject modulatorObj)
AddModulator(LXModulationEngine modulation, Class<? extends LXModulator> modulatorClass, JsonObject modulatorObj, int modulationColor)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AddModulator

public AddModulator(LXModulationEngine modulation,
                    Class<? extends LXModulator> modulatorClass)

AddModulator

public AddModulator(LXModulationEngine modulation,
                    Class<? extends LXModulator> modulatorClass,
                    int modulationColor)

AddModulator

public AddModulator(LXModulationEngine modulation,
                    Class<? extends LXModulator> modulatorClass,
                    JsonObject modulatorObj)

AddModulator

public AddModulator(LXModulationEngine modulation,
                    Class<? extends LXModulator> modulatorClass,
                    JsonObject modulatorObj,
                    int modulationColor)

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

undo

public void undo(LX lx)

Description copied from class: LXCommand

Undo the command, after it has been performed

Specified by:

undo in class LXCommand

Parameters:

lx - LX instance