Package heronarts.lx.command

Class LXCommand.Channel.RemoveEffect

java.lang.Object

heronarts.lx.command.LXCommand

heronarts.lx.command.LXCommand.RemoveComponent

heronarts.lx.command.LXCommand.Channel.RemoveEffect

Direct Known Subclasses:

LXCommand.Channel.ReloadEffect, LXCommand.Channel.RelocateEffect

Enclosing class:

LXCommand.Channel

public static class LXCommand.Channel.RemoveEffect
extends LXCommand.RemoveComponent

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
RemoveEffect(LXComponent container, LXEffect effect)

Method Summary

Modifier and Type	Method	Description
protected void	checkLocked()
String	getDescription()	Short description of a command, to explain it to the user
protected LXEffect	getEffect()
protected LXEffect.Container	getEffectContainer()
void	perform(LX lx)	Perform the given command
void	undo(LX lx)	Undo the command, after it has been performed

Methods inherited from class heronarts.lx.command.LXCommand.RemoveComponent

removeClipLanes, removeModulationMappings, removePatternClipEvents, removePatternClipLaneEvents, removeRemoteControls, removeSnapshotViews

Methods inherited from class heronarts.lx.command.LXCommand

isIgnored

Methods inherited from class java.lang.Object

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

Constructor Details

RemoveEffect

public RemoveEffect(LXComponent container,
 LXEffect effect)

Method Details

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

checkLocked

protected void checkLocked()

getEffectContainer

protected LXEffect.Container getEffectContainer()

getEffect

protected LXEffect getEffect()

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)
          throws LXCommand.InvalidCommandException

Description copied from class: LXCommand

Undo the command, after it has been performed

Overrides:

undo in class LXCommand.RemoveComponent

Parameters:

lx - LX instance

Throws:

LXCommand.InvalidCommandException - if the command is invalid