addRepresentation

Adds another representation to this representation.

Parameters:

representation toAdd - Representation to be added to this representation.

appendNode

Appends a node to the end of the river in the given position.

Parameters:

number x - The X coordinate of the node's position.

number y - The Y coordinate of the node's position.

number z - The Z coordinate of the node's position.

getDetail

Gets the detail of the river.

Returns:

int - detail of the river.

getHeight

Gets the height of the river.

Returns:

int - height of the river.

getID

Returns the representation ID.

Returns:

string - Representation ID.

getMaterial

Gets the name of the Material applied to the river.

Returns:

string - Material name.

getMouseButtonClickedListener

Returns the 'mouse button clicked' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonClickedListener

Returns the 'mouse button clicked' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonDoubleClickedListener

Returns the 'mouse button double clicked' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonDoubleClickedListener

Returns the 'mouse button double clicked' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonPressedListener

Returns the 'mouse button pressed' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonPressedListener

Returns the 'mouse button pressed' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonReleasedListener

Returns the 'mouse button released' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonReleasedListener

Returns the 'mouse button released' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonTripleClickedListener

Returns the 'mouse button triple clicked' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseButtonTripleClickedListener

Returns the 'mouse button triple clicked' listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseEnteredListener

Returns the 'mouse entered' listener of the River.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseEnteredListener

Returns the 'mouse entered' listener of the River.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseLeftListener

Returns the 'mouse left' listener of the River.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseLeftListener

Returns the 'mouse left' listener of the River.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseMovedListener

Returns the 'mouse moved' listener of the River.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseMovedListener

Returns the 'mouse moved' listener of the River.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseWheelMovedListener

Returns the 'mouse wheel moved' listener of the River.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getMouseWheelMovedListener

Returns the 'mouse wheel moved' listener of the River.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

Object - The object that contains the interaction that will be executed.

string - Name of the interaction.

InterModel - Arguments of the interaction that will be executed when this listener is activated.

boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.

string - The channel of the listener.

getName

Returns the name of the River

Returns:

string - The name of the River

getNodePosition

Returns the position of the river's chosen node.

Parameters:

int index - Index of the node

Returns:

number - Position of the river node in the X coordinate.

number - Position of the river node in the Y coordinate.

number - Position of the river node in the Z coordinate.

getNodes

Returns the position of all of the river's nodes.

Returns:

array{} - Position of each of the river's nodes.

getNodesCount

Returns the number of nodes composing the river.

Returns:

int - Number of nodes that compose the river.

getRepresentation

Returns the contained representation with the specified name and type.

Parameters:

string name - The name of the contained representation.

number type - The type of the contained representation.

Returns:

representation - The contained representation with the specified name and type.

getRepresentationContainer

Returns the representation that contains this representation.

Returns:

representation - The representation that contains this representation.

getRepresentations

Returns an array of the contained representations.

Returns:

array{} - Array of the contained representations.

getType

Returns the representation type:
2 - MODEL,
3 - LIGHT,
4 - EFFECT,
5 - PLANE,
6 - WATER,
7 - SOUND,
8 - TERRAIN_MESH_DECAL,
9 - TERRAIN_HIGHLIGHTING_DECAL,
10 - BILLBOARD,
11 - OVERLAY

Returns:

number - The type of the representation.

hasMouseButtonClickedListener

Returns 'true' if the River has a listener for the 'button clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the River has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonClickedListener

Returns 'true' if the River has a listener for the 'button clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the River has a listener for the 'button double clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the River has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the River has a listener for the 'button double clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the River has a listener for the 'button pressed' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the River has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the River has a listener for the 'button pressed' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the River has a listener for the 'button released' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the River has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the River has a listener for the 'button released' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the River has a listener for the 'button triple clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:

boolean - 'True' if the River has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the River has a listener for the 'button triple clicked' event, otherwise 'false'.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseEnteredListener

Returns 'true' if the River has a listener for the 'mouse entered' event, otherwise 'false'.

Returns:

boolean - 'True' if the River has a listener for the 'mouse entered' event, otherwise 'false'.

hasMouseEnteredListener

Returns 'true' if the River has a listener for the 'mouse entered' event, otherwise 'false'.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'mouse entered' event, otherwise 'false'.

hasMouseLeftListener

Returns 'true' if the River has a listener for the 'mouse left' event, otherwise 'false'.

Returns:

boolean - 'True' if the River has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseLeftListener

Returns 'true' if the River has a listener for the 'mouse left' event, otherwise 'false'.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseMovedListener

Returns 'true' if the River has a listener for the 'mouse moved' event, otherwise 'false'.

Returns:

boolean - 'True' if the River has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseMovedListener

Returns 'true' if the River has a listener for the 'mouse moved' event, otherwise 'false'.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the River has a listener for the 'mouse wheel moved' event, otherwise 'false'.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Returns:

boolean - 'True' if the River has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the River has a listener for the 'mouse wheel moved' event, otherwise 'false'.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:

boolean - 'True' if the River has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasRepresentation

Returns 'true' if this representation has the other representation, otherwise 'false'.

Parameters:

representation other - The other representation.

Returns:

boolean - 'True' if this representation has the other representation, otherwise 'false'.

hasRepresentation

Returns 'true' if this representation has another representation with the specified name and type, otherwise 'false'.

Parameters:

string name - Name of the representation.

number type - Type of the representation

Returns:

boolean - 'True' if this representation has another representation with the specified name and type, otherwise 'false'.

isPersistent

Returns true if the representation is persistent, false otherwise.

Returns:

boolean - Whether the River is persistent or not.

isVisible

Returns 'true' if the representation is visible, 'false' otherwise.

Returns:

boolean - Whether the River is visible or not.

print

Prints the River data and attributes to the console.

removeAllNodes

Remove all the river's nodes.

removeAllRepresentations

Removes all representations contained in this representation.

removeMouseButtonClickedListener

Removes the 'mouse button clicked' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonClickedListener

Removes the 'mouse button clicked' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonDoubleClickedListener

Removes the 'mouse button double clicked' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonDoubleClickedListener

Removes the 'mouse button double clicked' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonPressedListener

Removes the 'mouse button pressed' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonPressedListener

Removes the 'mouse button pressed' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonReleasedListener

Removes the 'mouse button released' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonReleasedListener

Removes the 'mouse button released' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonTripleClickedListener

Removes the 'mouse button triple clicked' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonTripleClickedListener

Removes the 'mouse button triple clicked' event listener of the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseEnteredListener

Removes the 'mouse entered' event listener of the River.

removeMouseEnteredListener

Removes the 'mouse entered' event listener of the River.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseLeftListener

Removes the 'mouse left' event listener of the River.

removeMouseLeftListener

Removes the 'mouse left' event listener of the River.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseMovedListener

Removes the 'mouse moved' event listener of the River.

removeMouseMovedListener

Removes the 'mouse moved' event listener of the River.

Parameters:

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseWheelMovedListener

Removes the 'mouse wheel moved' event listener of the River.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

removeMouseWheelMovedListener

Removes the 'mouse wheel moved' event listener of the River.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

removeNode

Removes the river's chosen node.

Parameters:

int index - Index of the node

removeRepresentation

Removes a representation from this representation.

Parameters:

representation other - The representation to be removed.

removeRepresentation

Removes a representation with the specified name and type from this representation.

Parameters:

string name - Name of the representation.

number type - Type of the representation

setDetail

Changes the detail of the river.

Parameters:

int detail - Detail of the river.

setHeight

Changes the height of the river.

Parameters:

int height - Height of the river.

setMaterial

Applies a material to the river.

Parameters:

string material - Material name.

setMouseButtonDoubleClickedListener

Sets a listener to be invoked upon a 'mouse button double clicked' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonDoubleClickedListener

Sets a listener to be invoked upon a 'mouse button double clicked' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseButtonPressedListener

Sets a listener to be invoked upon a 'mouse button pressed' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonPressedListener

Sets a listener to be invoked upon a 'mouse button pressed' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseButtonReleasedListener

Sets a listener to be invoked upon a 'mouse button released' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonReleasedListener

Sets a listener to be invoked upon a 'mouse button released' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseButtonTripleClickedListener

Sets a listener to be invoked upon a 'mouse button triple clicked' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonTripleClickedListener

Sets a listener to be invoked upon a 'mouse button triple clicked' event on the River.

Parameters:

number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseEnteredListener

Sets a listener to be invoked upon a 'mouse enter' event on the River.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseEnteredListener

Sets a listener to be invoked upon a 'mouse enter' event on the River.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseLeftListener

Sets a listener to be invoked upon a 'mouse leave' event on the River.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseLeftListener

Sets a listener to be invoked upon a 'mouse leave' event on the River.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseMovedListener

Sets a listener to be invoked upon a 'mouse move' event on the River.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseMovedListener

Sets a listener to be invoked upon a 'mouse move' event on the River.

Parameters:

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setMouseWheelMovedListener

Sets a listener to be invoked upon a 'mouse wheel moved' event on the River.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseWheelMovedListener

Sets a listener to be invoked upon a 'mouse wheel moved' event on the River.

Parameters:

number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Object target - The object that contains the interaction that will be executed.

string name - Name of the interaction.

InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.

boolean alt - Whether the key combination includes the 'alt' modifier key.

boolean shift - Whether the key combination includes the 'shift' modifier key.

boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.

string channel - The channel of the listener.

setNodePosition

Changes the position of the chosen node

Parameters:

int index - Index of the node

number x - The X coordinate of the node's new position.

number y - The Y coordinate of the node's new position.

number z - The Z coordinate of the node's new position.

setNodes

Sets the route of the river

Parameters:

array{} nodes - The nodes (x,y,z) that define the route of the river

setPersistent

Makes the River persistent or not persistent.

Parameters:

boolean persistent - Whether the River is persistent or not.

setVisible

Makes the River visible or invisible.

Parameters:

boolean visible - Whether the River is visible or not.