Package org.xj3d.core.eventmodel

Interface LayerRenderingManager

All Known Implementing Classes:

OGLMinimalBrowserCore, OGLStandardBrowserCore

public interface LayerRenderingManager

A representation of a class that would be responsible for performing management of all layers with a running the system.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Method Summary

Modifier and Type	Method	Description
void	clear()	Force clearing all currently managed layers from this manager now.
int	getRenderingStyle()	Get the currently set rendering style.
int	getRenderingStyle(int layerId)	Get the currently set rendering style for a specific layer.
void	setActiveLayers(LayerManager[] layers, int numLayers)	Set the list of current layers that should be rendered.
void	setErrorReporter(org.j3d.util.ErrorReporter reporter)	Register an error reporter with the engine so that any errors generated by the loading of script code can be reported in a nice, pretty fashion.
void	setRenderingStyle(int style)	Change the rendering style that the browser should currently be using for all layers.
void	setRenderingStyle(int style, int layerId)	Change the rendering style that the browser should currently be using for for a specific layer.
void	setRenderOrder(int[] order, int numValid)	Set the rendering order for all the layers on this manager
void	shutdown()	Shutdown the node manager now.

Method Details

setRenderingStyle

void setRenderingStyle(int style)
                throws IllegalArgumentException

Change the rendering style that the browser should currently be using for all layers. Various options are available based on the constants defined in this interface.

Parameters:

style - One of the RENDER_* constants from Xj3DConstants

Throws:

IllegalArgumentException - A style constant that is not recognized by the implementation was provided

See Also:

• Xj3DConstants

getRenderingStyle

int getRenderingStyle()

Get the currently set rendering style. The default style is RENDER_SHADED.

Returns:

one of the RENDER_ constants from LayerManager or Xj3DBrowser

See Also:

• Xj3DConstants

setRenderingStyle

void setRenderingStyle(int style,
 int layerId)
                throws IllegalArgumentException

Change the rendering style that the browser should currently be using for for a specific layer. Various options are available based on the constants defined in this interface.

Parameters:

style - One of the RENDER_* constants

layerId - The ID of the layer that should have the style changed

Throws:

IllegalArgumentException - A style constant that is not recognized by the implementation was provided

See Also:

• Xj3DConstants

getRenderingStyle

int getRenderingStyle(int layerId)

Get the currently set rendering style for a specific layer. The default style is RENDER_SHADED.

Parameters:

layerId - ID for layer of interest

Returns:

one of the RENDER_ constants

See Also:

• Xj3DConstants

setActiveLayers

void setActiveLayers(LayerManager[] layers,
 int numLayers)

Set the list of current layers that should be rendered.

Parameters:

layers - The list of layer managers to be rendered

numLayers - The number of active items in the list

setRenderOrder

void setRenderOrder(int[] order,
 int numValid)

Set the rendering order for all the layers on this manager

Parameters:

order - The index of the list of rendered layers ids

numValid - The number of valid items in the order list

shutdown

void shutdown()

Shutdown the node manager now. If this is using any external resources it should remove those now as the entire application is about to die

setErrorReporter

void setErrorReporter(org.j3d.util.ErrorReporter reporter)

Register an error reporter with the engine so that any errors generated by the loading of script code can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old.

Parameters:

reporter - The instance to use or null

clear

void clear()

Force clearing all currently managed layers from this manager now. This is used to indicate that a new world is about to be loaded and everything should be cleaned out now.