org.synthclipse.scripting.core

Class JSSynthclipse<FunctionType,ContextType>

java.lang.Object

org.synthclipse.scripting.core.JSSynthclipse<FunctionType,ContextType>

Type Parameters:

FunctionType - JavaScript function type

ContextType - JavaScript context

public class JSSynthclipse<FunctionType,ContextType>
extends Object

The main controller of the Synthclipse's scripting engine.

SCRIPTING: In scripts, JSSynthclipse instance is available as global object named: Synthclipse.

Constructor Summary

Constructors

Constructor and Description
JSSynthclipse(org.synthclipse.scripting.AbstractJSExecutor<FunctionType,ContextType> jsExecutor) Creates a new JSSynthclipse instance.

Method Summary

Modifier and Type	Method and Description
void	addAnimationListener(Object jsObject) Adds animation listener object.
void	addKeyListener(Object jsObject) Adds key listener object.
void	addMouseListener(Object jsObject) Adds mouse listener object.
void	createControls(GLSLProgram program) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program.
void	createControls(GLSLProgram program, boolean visible) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program.
void	createControls(GLSLProgram program, boolean visible, boolean trackEvents) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program.
void	createControls(GLSLProgram program, boolean visible, boolean trackEvents, boolean emitEvents) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program.
void	createControls(JSFragxRenderer fragxRenderer) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer.
void	createControls(JSFragxRenderer fragxRenderer, boolean visible) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer.
void	createControls(JSFragxRenderer fragxRenderer, boolean visible, boolean trackEvents) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer.
void	createControls(JSFragxRenderer fragxRenderer, boolean visible, boolean trackEvents, boolean emitEvents) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer.
void	createScriptControls() Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script.
void	createScriptControls(boolean visible) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script.
void	createScriptControls(boolean visible, boolean trackEvents) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script.
void	createScriptControls(boolean visible, boolean trackEvents, boolean emitEvents) Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script.
JSTimer	createTimer() Creates a new instance of JSTimer class.
int	getMusicTextureID() Gets music OpenGL texture's ID.
IRecordingInfo	getRecordingInfo() Gets recording info.
double	getSystemTime() Gets system time in seconds.
double	getTime() Gets animation time (from the Rendering View) in seconds.
int	getTrueViewportHeight() Gets true/physical Viewport's height.
int	getTrueViewportWidth() Gets true/physical Viewport's width.
int	getViewportHeight() Gets the Viewport's height.
int	getViewportWidth() Gets the Viewport's width.
boolean	isAnimationPaused() Is animation paused?
boolean	isAnimationPlaying() Is animation playing?
boolean	isAnimationStopped() Is animation stopped?
boolean	isDebugMode() Checks whether Debug Mode is enabled.
boolean	isRecording() Checks whether Synthclipse is recording current script.
void	load(String scriptPath) Loads and executes a JavaScript file.
JSFragxRenderer	loadFragx(String filePath) Loads .fragx/.stoy shader file.
boolean	loadPreset(String presetName) Loads preset.
TextureWrapper	loadTexture(String path) Loads texture file.
double	random() Generates a random value between 0.0 (inclusive) and 1.0 (exclusive).
double	random(double min, double max) Generates a random value between min (inclusive) and max (exclusive).
ByteBuffer	readBinaryFile(String filePath) Reads a binary file.
String	readFile(String filePath) Reads a text file with "UTF-8" encoding.
String	readFile(String filePath, String encoding) Reads a text file with user selected encoding.
void	refreshControls() Refreshes all tabs in the Uniform Controls View.
void	removeAllControls() Removes from the Uniform Controls View all tabs.
void	removeControls(GLSLProgram program) Removes from the Uniform Controls View a tab with UI elements/widgets, which uniform variables contained in the program.
void	removeControls(JSFragxRenderer fragxRenderer) Removes from the Uniform Controls View a tab with UI elements/widgets, which uniform variables contained in the fragxRenderer.
File	resolveFile(String path) Resolves specified path.
void	setDebugMode(boolean debugMode) Enables or disables Debug Mode.
void	setGLVersion(int major, int minor) Sets OpenGL version used in the script.
void	setRenderable(Object jsObject) Sets Renderable object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSSynthclipse

public JSSynthclipse(org.synthclipse.scripting.AbstractJSExecutor<FunctionType,ContextType> jsExecutor)

Creates a new JSSynthclipse instance.

Method Detail

addMouseListener

public void addMouseListener(Object jsObject)
                      throws org.synthclipse.core.SynthclipseException

Adds mouse listener object. jsObject should be a JavaScript object containing one or more of the following functions:

• function mouseUp(mouseEvent) {}
• function mouseDown(mouseEvent) {}
• function mouseMove(mouseEvent) {}
• function mouseScrolled(mouseEvent) {}

Argument - mouseEvent - of these functions is an instance of org.eclipse.swt.events.MouseEvent class.

Parameters:

jsObject - a JavaScript object with mouse event handler methods

Throws:

org.synthclipse.core.SynthclipseException - when jsObject does not contain any of above JavaScript functions or when those functions have wrong definitions (e.g. invalid argument count).

addKeyListener

public void addKeyListener(Object jsObject)
                    throws org.synthclipse.core.SynthclipseException

Adds key listener object. jsObject should be a JavaScript object containing one or more of the following functions:

• function keyPressed(keyEvent) {}
• function keyReleased(keyEvent) {}

Argument - keyEvent - of these functions is an instance of org.eclipse.swt.events.KeyEvent class.

Parameters:

jsObject - a JavaScript object with key event handler methods

Throws:

org.synthclipse.core.SynthclipseException - when jsObject does not contain any of above JavaScript functions or when those functions have wrong definitions (e.g. invalid argument count).

addAnimationListener

public void addAnimationListener(Object jsObject)
                          throws org.synthclipse.core.SynthclipseException

Adds animation listener object. jsObject should be a JavaScript object containing one or more of the following functions:

• function onPlay() {}
• function onPause() {}
• function onStop() {}

Parameters:

jsObject - a JavaScript object with animation event handler methods

Throws:

org.synthclipse.core.SynthclipseException - when jsObject does not contain any of above JavaScript functions or when those functions have wrong definitions (e.g. invalid argument count).

setRenderable

public void setRenderable(Object jsObject)
                   throws org.synthclipse.core.SynthclipseException

Sets Renderable object. jsObject should be a JavaScript object containing one or more of the following functions:

• function init() {}
  This function is called only once on the beginning of the script execution.
• function lateInit() {}
  This function is called only once as well, but instead of being called on the beginning of the script execution (like init()), it is called exactly on the first frame of the rendering.
• function display() {}
  This function is called on every frame.
• function resize(width, height) {}
  This function is called once on script's startup and every time the Viewport's size changes.
  Parameters width and height are Viewport's width and Viewport's height, respectively.
• function destroy() {}
  This function is called on script shutdown.

Parameters:

jsObject - a JavaScript object with script life cycle methods

Throws:

org.synthclipse.core.SynthclipseException - when jsObject's functions have wrong definitions (e.g. invalid argument count).

isDebugMode

public boolean isDebugMode()

Checks whether Debug Mode is enabled.

Returns:

true if Debug Mode is enabled, false otherwise.

setDebugMode

public void setDebugMode(boolean debugMode)

Enables or disables Debug Mode.

IMPORTANT: This method should be called always at the beginning of the scripts.

Parameters:

debugMode - true enables Debug Mode, false disables Debug Mode

getTime

public double getTime()

Gets animation time (from the Rendering View) in seconds.

SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:

• Synthclipse.getTime();
• Synthclipse.time;

Returns:

animation time (in seconds).

See Also:

getSystemTime()

getSystemTime

public double getSystemTime()

Gets system time in seconds.

SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:

• Synthclipse.getSystemTime();
• Synthclipse.systemTime;

Returns:

system time.

See Also:

getTime()

getMusicTextureID

public int getMusicTextureID()

Gets music OpenGL texture's ID. It is non zero only when some audio track is played.
To learn more about OpenGL texture IDs (also known as "texture names") please see glGenTextures().

SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:

• Synthclipse.getMusicTextureID();
• Synthclipse.musicTextureID;

Returns:

music OpenGL texture's ID.

random

public double random()

Generates a random value between 0.0 (inclusive) and 1.0 (exclusive).

Returns:

a random value.

random

public double random(double min,
                     double max)

Generates a random value between min (inclusive) and max (exclusive).

Parameters:

min - minimal boundary (inclusive)

max - maximal boundary (exclusive)

Returns:

a random value.

setGLVersion

public void setGLVersion(int major,
                         int minor)
                  throws org.synthclipse.core.SynthclipseException

Sets OpenGL version used in the script.

IMPORTANT: This method should be called always at the beginning of the scripts.

Parameters:

major - Major part of the OpenGL version. (e.g. "4" from "OpenGL 4.3").

minor - Minor part of the OpenGL version (e.g. "3" from "OpenGL 4.3").

Throws:

org.synthclipse.core.SynthclipseException - when requested OpenGL's version is not supported.

load

public void load(String scriptPath)
          throws org.synthclipse.core.SynthclipseException

Loads and executes a JavaScript file.

Parameters:

scriptPath - path to the JavaScript file.

Throws:

org.synthclipse.core.SynthclipseException - when the script file does not exist or there are errors in the script.

readFile

public String readFile(String filePath)
                throws FileNotFoundException

Reads a text file with "UTF-8" encoding.

Parameters:

filePath - path to the text file

Returns:

a String with the file's content

Throws:

FileNotFoundException - when the file does not exist.

readFile

public String readFile(String filePath,
                       String encoding)
                throws FileNotFoundException

Reads a text file with user selected encoding.

Parameters:

filePath - path to the text file

encoding - text encoding (e.g. "UTF-8", "UTF-16", "ISO-8859-1")

Returns:

a String with the file's content

Throws:

FileNotFoundException - when the file does not exist.

readBinaryFile

public ByteBuffer readBinaryFile(String filePath)
                          throws IOException

Reads a binary file.

Throws:

IOException

resolveFile

public File resolveFile(String path)
                 throws FileNotFoundException

Resolves specified path.

Throws:

FileNotFoundException

loadTexture

public TextureWrapper loadTexture(String path)
                           throws javax.media.opengl.GLException,
                                  IOException

Loads texture file. Supported formats:

• png
• gif
• jpeg
• bmp
• dds
• tga
• sgi/rgb

Parameters:

path - texture's path

Returns:

TextureWrapper instance

Throws:

javax.media.opengl.GLException - when OpenGL's texture creation fails

IOException - when the file cannot be read

loadFragx

public JSFragxRenderer loadFragx(String filePath)
                          throws FileNotFoundException,
                                 org.synthclipse.core.SynthclipseException

Loads .fragx/.stoy shader file.

Parameters:

filePath - path to the file

Returns:

JSFragxRenderer instance

Throws:

FileNotFoundException - when the file does not exist

org.synthclipse.core.SynthclipseException - when the .fragx/.stoy script contains errors

createScriptControls

public void createScriptControls()

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script. Equivalent of: createScriptControls(true, true, true);

See Also:

createScriptControls(boolean, boolean, boolean)

createScriptControls

public void createScriptControls(boolean visible)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script. Equivalent of: createScriptControls(visible, trackEvents, true);

Parameters:

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

See Also:

createScriptControls(boolean, boolean, boolean)

createScriptControls

public void createScriptControls(boolean visible,
                                 boolean trackEvents)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script. Equivalent of: createScriptControls(visible, true, true);

Parameters:

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

trackEvents - if true the Uniform Control variables (UCs) will be synchronized with other UCs with the same names and groups

See Also:

createScriptControls(boolean, boolean, boolean)

createScriptControls

public void createScriptControls(boolean visible,
                                 boolean trackEvents,
                                 boolean emitEvents)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in current JSX script.

Parameters:

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

trackEvents - if true the Uniform Control variables (UCs) will be synchronized with other UCs with the same names and groups

emitEvents - if true the Uniform Control variables (UCs) will emit a synchronization events, which can be captured by other UCs with the same names and groups to force their synchronization

createControls

public void createControls(JSFragxRenderer fragxRenderer)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer. Equivalent of: createControls(fragxRenderer, true, true, true);

Parameters:

fragxRenderer - a .fragx/.stoy renderer

See Also:

createControls(JSFragxRenderer, boolean, boolean, boolean)

createControls

public void createControls(JSFragxRenderer fragxRenderer,
                           boolean visible)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer. Equivalent of: createControls(fragxRenderer, visible, true, true);

Parameters:

fragxRenderer - a .fragx/.stoy renderer

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

See Also:

createControls(JSFragxRenderer, boolean, boolean, boolean)

createControls

public void createControls(JSFragxRenderer fragxRenderer,
                           boolean visible,
                           boolean trackEvents)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer. Equivalent of: createControls(fragxRenderer, visible, trackEvents, true);

Parameters:

fragxRenderer - a .fragx/.stoy renderer

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

trackEvents - if true the Uniform Control variables (UCs) will be synchronized with other UCs with the same names and groups

See Also:

createControls(JSFragxRenderer, boolean, boolean, boolean)

createControls

public void createControls(JSFragxRenderer fragxRenderer,
                           boolean visible,
                           boolean trackEvents,
                           boolean emitEvents)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the fragxRenderer.

Parameters:

fragxRenderer - a .fragx/.stoy renderer

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

trackEvents - if true the Uniform Control variables (UCs) will be synchronized with other UCs with the same names and groups

emitEvents - if true the Uniform Control variables (UCs) will emit a synchronization events, which can be captured by other UCs with the same names and groups to force their synchronization

createControls

public void createControls(GLSLProgram program)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program. Equivalent of: createControls(program, true, true, true);

Parameters:

program - a GLSL program

See Also:

createControls(GLSLProgram, boolean, boolean, boolean)

createControls

public void createControls(GLSLProgram program,
                           boolean visible)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program. Equivalent of: createControls(program, visible, true, true);

Parameters:

program - a GLSL program

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

See Also:

createControls(GLSLProgram, boolean, boolean, boolean)

createControls

public void createControls(GLSLProgram program,
                           boolean visible,
                           boolean trackEvents)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program. Equivalent of: createControls(program, visible, trackEvents, true);

Parameters:

program - a GLSL program

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

trackEvents - if true the Uniform Control variables (UCs) will be synchronized with other UCs with the same names and groups

See Also:

createControls(GLSLProgram, boolean, boolean, boolean)

createControls

public void createControls(GLSLProgram program,
                           boolean visible,
                           boolean trackEvents,
                           boolean emitEvents)

Creates in the Uniform Controls View a tab with UI elements/widgets, which control uniform variables contained in the program.

Parameters:

program - a GLSL program

visible - if true the Uniform Control widgets will be visible in the Uniform Controls View

trackEvents - if true the Uniform Control variables (UCs) will be synchronized with other UCs with the same names and groups

emitEvents - if true the Uniform Control variables (UCs) will emit a synchronization events, which can be captured by other UCs with the same names and groups to force their synchronization

removeControls

public void removeControls(JSFragxRenderer fragxRenderer)

Removes from the Uniform Controls View a tab with UI elements/widgets, which uniform variables contained in the fragxRenderer.

Parameters:

fragxRenderer - a .fragx/.stoy renderer

removeControls

public void removeControls(GLSLProgram program)

Removes from the Uniform Controls View a tab with UI elements/widgets, which uniform variables contained in the program.

Parameters:

program - a GLSL program

removeAllControls

public void removeAllControls()

Removes from the Uniform Controls View all tabs.

refreshControls

public void refreshControls()

Refreshes all tabs in the Uniform Controls View.

loadPreset

public boolean loadPreset(String presetName)

Loads preset.

Parameters:

presetName - the preset's name

Returns:

true if succeed, false otherwise

getViewportWidth

public int getViewportWidth()

Gets the Viewport's width. This value is passed to renderable.resize() function (see setRenderable()).

It can be different from true Viewport's width, when "Buffer size/Same as Viewport" Check Box is unselected in the Rendering View. To get true size just use getTrueViewportWidth().

SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:

• Synthclipse.getViewportWidth();
• Synthclipse.viewportWidth;

Returns:

the Viewport's width.

See Also:

getTrueViewportWidth()

getViewportHeight

public int getViewportHeight()

Gets the Viewport's height. This value is passed to renderable.resize() function (see setRenderable()).

It can be different from true Viewport's height, when "Buffer size/Same as Viewport" Check Box is unselected in the Rendering View. To get true size just use getTrueViewportHeight().

SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:

• Synthclipse.getViewportHeight();
• Synthclipse.viewportHeight;

Returns:

the Viewport's height.

See Also:

getTrueViewportHeight()

getTrueViewportWidth

public int getTrueViewportWidth()

Gets true/physical Viewport's width. It can be different from value passed to renderable.resize() function (see setRenderable()), when "Buffer size/Same as Viewport" Check Box is unselected in the Rendering View.

SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:

• Synthclipse.getTrueViewportWidth();
• Synthclipse.trueViewportWidth;

Returns:

true Viewport's width.

See Also:

getViewportWidth()

getTrueViewportHeight

public int getTrueViewportHeight()

Gets true/physical Viewport's height. It can be different from value passed to renderable.resize() function (see setRenderable()), when "Buffer size/Same as Viewport" Check Box is unselected in the Rendering View.

SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:

• Synthclipse.getTrueViewportHeight();
• Synthclipse.trueViewportHeight;

Returns:

true Viewport's height.

See Also:

getViewportHeight()

isRecording

public boolean isRecording()

Checks whether Synthclipse is recording current script.

Returns:

true - Synthclipse is recording current script, false - otherwise.

getRecordingInfo

public IRecordingInfo getRecordingInfo()

Gets recording info.

Returns:

recording info.

isAnimationPlaying

public boolean isAnimationPlaying()

Is animation playing?

Returns:

true - animation is being played, false - otherwise.

isAnimationPaused

public boolean isAnimationPaused()

Is animation paused?

Returns:

true - animation is paused, false - otherwise.

isAnimationStopped

public boolean isAnimationStopped()

Is animation stopped?

Returns:

true - animation is stopped, false - otherwise.

createTimer

public JSTimer createTimer()

Creates a new instance of JSTimer class.

Returns:

a JSTimer instance.