Package heronarts.lx.clip

Class LXClipEngine

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.clip.LXClipEngine

All Implemented Interfaces:

LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXClipEngine
extends LXComponent
implements LXOscComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LXClipEngine.FocusedClipParameter

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Hidden, LXComponent.Placeholder, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final BooleanParameter	clipViewExpanded
final DiscreteParameter	clipViewGridOffset
final LXClipEngine.FocusedClipParameter	focusedClip
static final int	MAX_SCENES
static final int	MIN_SCENES
final DiscreteParameter	numScenes
final BooleanParameter	snapshotTransitionEnabled
final BoundedParameter	snapshotTransitionTimeSecs	Amount of time taken in seconds to transition into a new snapshot view

Fields inherited from class heronarts.lx.LXComponent

children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
LXClipEngine(LX lx)

Method Summary

Modifier and Type	Method	Description
LXClip	getFocusedClip()
TriggerParameter	getScene(int index)	Get the boolean parameter that launches a scene
LXClipEngine	launchScene(int index)	Launches the scene at given index
void	load(LX lx, JsonObject obj)	Loads the LX component.
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
LXClipEngine	setFocusedClip(LXClip clip)
LXClipEngine	stopClips()	Stops all running clips

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, dispose, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

MIN_SCENES

public static final int MIN_SCENES

See Also:

• Constant Field Values

MAX_SCENES

public static final int MAX_SCENES

See Also:

• Constant Field Values

focusedClip

public final LXClipEngine.FocusedClipParameter focusedClip

clipViewExpanded

public final BooleanParameter clipViewExpanded

clipViewGridOffset

public final DiscreteParameter clipViewGridOffset

numScenes

public final DiscreteParameter numScenes

snapshotTransitionTimeSecs

public final BoundedParameter snapshotTransitionTimeSecs

Amount of time taken in seconds to transition into a new snapshot view

snapshotTransitionEnabled

public final BooleanParameter snapshotTransitionEnabled

Constructor Details

LXClipEngine

public LXClipEngine(LX lx)

Method Details

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

p - Parameter that has a value change

getFocusedClip

public LXClip getFocusedClip()

setFocusedClip

public LXClipEngine setFocusedClip(LXClip clip)

getScene

public TriggerParameter getScene(int index)

Get the boolean parameter that launches a scene

Parameters:

index - Index of scene

Returns:

Scene at index

launchScene

public LXClipEngine launchScene(int index)

Launches the scene at given index

Parameters:

index - Scene index

Returns:

this

stopClips

public LXClipEngine stopClips()

Stops all running clips

Returns:

this

load

public void load(LX lx,
 JsonObject obj)

Description copied from class: LXComponent

Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.

Specified by:

load in interface LXSerializable

Overrides:

load in class LXComponent

Parameters:

lx - LX instance

obj - Object to deserialize