Package heronarts.lx.script

Class LXScriptEngine

java.lang.Object

heronarts.lx.script.LXScriptEngine

public class LXScriptEngine
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LXScriptEngine.DeviceAdapter
class	LXScriptEngine.ScriptInterface	Interface of methods exposed for Javascript to call back up into the LX device

Field Summary

Fields

Modifier and Type	Field	Description
final StringParameter	error	User facing error message
final MutableParameter	onReload	A bang is sent to this parameter to notify the UI when a reload has happened for any reason at all, or any event that require UI update.
final TriggerParameter	reload
static final int	RENDER_ERROR_LOG_INTERVAL_MS
final Collection<LXListenableNormalizedParameter>	scriptControls	Immutable public view of the JS control parameters
final StringParameter	scriptName

Constructor Summary

Constructors

Constructor	Description
LXScriptEngine(LXDeviceComponent device, LXScriptEngine.DeviceAdapter adapter)

Method Summary

Modifier and Type	Method	Description
String	getScriptName()
protected void	invokeFunction(String function, Object... args)
boolean	isHiddenControl(LXParameter parameter)
void	load()
protected void	onModelChanged(LXModel model)
void	reload()
void	run(double deltaMs, double enabledAmount, LXModel model, int[] colors)

Methods inherited from class java.lang.Object

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

Field Details

RENDER_ERROR_LOG_INTERVAL_MS

public static final int RENDER_ERROR_LOG_INTERVAL_MS

See Also:

• Constant Field Values

scriptName

public final StringParameter scriptName

reload

public final TriggerParameter reload

onReload

public final MutableParameter onReload

A bang is sent to this parameter to notify the UI when a reload has happened for any reason at all, or any event that require UI update.

error

public final StringParameter error

User facing error message

scriptControls

public final Collection<LXListenableNormalizedParameter> scriptControls

Immutable public view of the JS control parameters

Constructor Details

LXScriptEngine

public LXScriptEngine(LXDeviceComponent device,
 LXScriptEngine.DeviceAdapter adapter)

Method Details

getScriptName

public String getScriptName()

isHiddenControl

public boolean isHiddenControl(LXParameter parameter)

reload

public void reload()

onModelChanged

protected void onModelChanged(LXModel model)

invokeFunction

protected void invokeFunction(String function,
 Object... args)

load

public void load()
          throws ScriptException,
NoSuchFileException,
IOException,
NoSuchMethodException,
URISyntaxException

Throws:

ScriptException

NoSuchFileException

IOException

NoSuchMethodException

URISyntaxException

run

public void run(double deltaMs,
 double enabledAmount,
 LXModel model,
 int[] colors)