heronarts.lx.command

Class LXCommand.Channel.AddEffect

java.lang.Object

heronarts.lx.command.LXCommand

heronarts.lx.command.LXCommand.Channel.AddEffect

Enclosing class:

LXCommand.Channel

public static class LXCommand.Channel.AddEffect
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
AddEffect(LXBus channel, Class<? extends LXEffect> effectClass)
AddEffect(LXBus channel, Class<? extends LXEffect> effectClass, JsonObject effectObj)

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

AddEffect

public AddEffect(LXBus channel,
                 Class<? extends LXEffect> effectClass)

AddEffect

public AddEffect(LXBus channel,
                 Class<? extends LXEffect> effectClass,
                 JsonObject effectObj)

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