org.j3d.aviatrix3d
Class Layer

java.lang.Object
  org.j3d.aviatrix3d.SceneGraphObject
      org.j3d.aviatrix3d.Layer

public class Layer

extends SceneGraphObject

A single layer of a composited set of scenes to form a complete visual system.

Note: This class does nothing in Aviatrix3D 1.0

A layer is a composite of objects that are applied in a sequential manner to the given surface. Between each layer the depth buffer is cleared and a new rendering is applied directly over the top of the previous. Colour buffers or other buffers are not cleared.

Version:

$Revision: 1.4 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject

alive, LISTENER_SET_NOT_LIVE_MESSAGE, updateHandler, WRITE_TIMING_MSG

Constructor Summary

Layer()
Construct a new layer instance that does not have a pre-assigned scene.

Method Summary

Scene	getScene() Get the currently set scene instance.
protected void	setLive(boolean state) Notification that this object is live now.
void	setScene(Scene sc) Set the scene to be used by this layer.
protected void	setUpdateHandler(NodeUpdateHandler handler) Set the scenegraph update handler for this node.

Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject

checkForCyclicChild, checkForCyclicParent, dataChanged, getUserData, isLive, setUserData

Methods inherited from class java.lang.Object

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

Constructor Detail

Layer

public Layer()

Construct a new layer instance that does not have a pre-assigned scene.

Method Detail

setUpdateHandler

protected void setUpdateHandler(NodeUpdateHandler handler)

Set the scenegraph update handler for this node. It will notify all its children of the value. A null value will clear the current handler.

Overrides:

setUpdateHandler in class SceneGraphObject

Parameters:

handler - The instance to use as a handler

setLive

protected void setLive(boolean state)

Notification that this object is live now. Overridden to make sure that the live state of the nodes represents the same state as the parent scene graph.

Overrides:

setLive in class SceneGraphObject

Parameters:

state - true if this should be marked as live now

setScene

public void setScene(Scene sc)
              throws InvalidWriteTimingException

Set the scene to be used by this layer. If a previous scene was used, it is replaced by this scene. Note that a scene can not have more than one parent, so sharing it between layers is not an option.

Parameters:

sc - The scene instance to use

Throws:

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener callback method

getScene

public Scene getScene()

Get the currently set scene instance. If no scene is set, null is returned.

Returns:

The current scene instance or null