getBillboardOrigin

Sets the origin of the billboards in the billboard set.

getBillboardRotationType

Gets the billboard renderer rotation type of the billboard set.

Returns:

number - rotationType Type of billboard set rotation. It can be PR_BILLBOARD_ROTATION_VERTEX (default) or PR_BILLBOARD_ROTATION_TEXCOORD.

getBillboardSize

Returns the size of the billboard set.

Returns:

number - w Width of the billboard set.

number - h Height of the billboard set.

getBillboardType

Gets the type of billboard set.

Returns:

number - type Type of billboard renderer. It can be PR_BILLBOARD_POINT, PR_BILLBOARD_POINT, PR_BILLBOARD_ORIENTED_SELF, PR_BILLBOARD_PERPENDICULAR_COMMON or PR_PERPENDICULAR_SELF.

getDirection

Gets the direction of the billboard set.

Parameters:

number x - X direction coordinate.

number y - Y direction coordinate.

number z - Z direction coordinate.

getID

Returns the representation ID.

Returns:

string - Representation ID.

getMaterial

Gets the material name of the billboard set.

Returns:

string - Material name.

getMouseButtonClickedListener

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

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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.

getPosition

Returns the position of the BillBoard.

Returns:

number - The position of the BillBoard in the X coordinate.

number - The position of the BillBoard in the Y coordinate.

number - The position of the BillBoard in the Z coordinate.

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.

getUpVector

Gets the direction of the up vector of the billboard set.

Parameters:

number x - X direction coordinate.

number y - Y direction coordinate.

number z - Z direction coordinate.

hasMouseButtonClickedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonClickedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonPressedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonReleasedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseButtonTripleClickedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'button triple clicked' event, otherwise 'false'.

hasMouseEnteredListener

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

Returns:

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

hasMouseEnteredListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'mouse entered' event, otherwise 'false'.

hasMouseLeftListener

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

Returns:

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

hasMouseLeftListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseMovedListener

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

Returns:

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

hasMouseMovedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasMouseWheelMovedListener

Returns 'true' if the BillBoard 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 BillBoard has a listener for the 'mouse wheel moved' event, otherwise 'false'.

isAccurateFacing

Returns whether each billboard is constantly facing the camera.

Returns:

boolean - facing Whether each billboard is constantly facing the camera.

isCullEach

Returns whether the billboard set culls each billboard individually or not.

Returns:

boolean - Whether the billboard set culls each billboard or not.

isPersistent

Returns true if the representation is persistent, false otherwise.

Returns:

boolean - Whether the BillBoard is persistent or not.

isSorted

Returns whether the billboard set sorts the billboards or not.

Returns:

boolean - sorted Whether the billboard set sorts the billboards or not.

print

Prints the BillBoard data and attributes to the console.

removeMouseButtonClickedListener

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

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

removeMouseEnteredListener

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

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 BillBoard.

removeMouseLeftListener

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

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 BillBoard.

removeMouseMovedListener

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

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 BillBoard.

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 BillBoard.

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.

setAccurateFacing

Sets whether each billboard is constantly facing the camera.

Parameters:

boolean facing - Whether each billboard is constantly facing the camera.

setBillboardOrigin

Sets the origin of the billboard in the billboard set.

Parameters:

number vPosition - Vertical position of the origin of the billboards in the billboard set. It can be VA_TOP, VA_CENTRE or VA_BOTTOM.

number hPosition - Horizontal position of the origin of the billboards in the billboard set. It can be HA_RIGHT, HA_CENTRE or HA_BOTTOM.

setBillboardRotationType

Sets the billboard rotation type of the billboard set.

Parameters:

number rotationType - Type of billboard rotation. It can be PR_BILLBOARD_ROTATION_VERTEX (default) or PR_BILLBOARD_ROTATION_TEXCOORD.

setBillboardsCustom

Sets the billboard set to contain a set of billboards defined in the array.

Parameters:

array{} billboards - An array of billboards, where each element of the array contains the position (x,y,z) and size (width,height) of a billboard.

setBillboardsCustomOnSurface

Sets the billboard set to contain a set of billboards defined in the array that will be set on the suface of the terrain.

Parameters:

array{} billboards - An array of billboards that will be set on the suface of the terrain, where each element of the array contains the position (x,z) and size (width,height) of a billboard.

setBillboardSize

Sets the size of the billboard set.

Parameters:

number w - Width of the billboard set.

number h - Height of the billboard set.

setBillboardsRandom

Sets the billboard set to spread a given number of billboards (count) inside a box defined by x,y and z.

Parameters:

number seed - Seed for the pseudo-random number generator.

number count - Number of billboards.

number x - X coordinate of the box.

number y - X coordinate of the box.

number z - X coordinate of the box.

setBillboardsRandomOnSurfaceImage

Sets the billboard set to spread a given number of billboards (count) over the terrain inside an area defined by x and z and distributes them according to a density map defined by an image.

Parameters:

number seed - Seed for the pseudo-random number generator.

number count - Number of billboards.

number x - X coordinate of the area.

number z - X coordinate of the area.

MediaItem image - Grayscale image that contains the density map according of the distribution of billboards in the billboardset.

setBillboardsRandomOnSurfacePosition

Sets the billboard set to spread a given number of billboards (count) over the terrain inside an area defined by x and z.

Parameters:

number seed - Seed for the pseudo-random number generator.

number count - Number of billboards.

number x - X coordinate of the area.

number z - X coordinate of the area.

setBillboardType

Sets the type of billboard set.

Parameters:

number type - Type of billboard set. It can be PR_BILLBOARD_POINT (default), PR_BILLBOARD_POINT, PR_BILLBOARD_ORIENTED_SELF, PR_BILLBOARD_PERPENDICULAR_COMMON or PR_PERPENDICULAR_SELF.

setCullEach

Sets whether the billboard set culls each billboard individually or not. Set this to true when it's most likely that only part of the billboards are actually visible. In most cases, it's far more efficient to cull them together.

Parameters:

boolean cullEach - Whether the billboard set culls each billboard.

setDirection

Sets the direction of the billboard set.

Parameters:

number x - X direction coordinate.

number y - Y direction coordinate.

number z - Z direction coordinate.

setMaterial

Defines the material of the billboard set.

Parameters:

string material - Material name.

setMouseButtonDoubleClickedListener

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

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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 BillBoard.

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.

setPersistent

Makes the BillBoard persistent or not persistent.

Parameters:

boolean persistent - Whether the BillBoard is persistent or not.

setPosition

Sets the position of the BillBoard in the 3D space (x,y,z).

Parameters:

number x - New position in the X axis.

number y - New position in the Y axis.

number z - New position in the Z axis.

setSorted

Sets whether the ebillboard set sorts the billboards or not. If set to 'true', the billboards will be sorted with respect to the camera, furthest first. There is a small overhead in sorting the billboards.

Parameters:

boolean sorted - Whether the billboard set sorts the billboards or not.

setUpVector

Sets the direction of the 'up vector' of a billboard set of the type PR_BILLBOARD_PERPENDICULAR_COMMON or PR_PERPENDICULAR_SELF.

Parameters:

number x - X direction coordinate.

number y - Y direction coordinate.

number z - Z direction coordinate.