org.j3d.aviatrix3d
Class ViewportLayer

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

Direct Known Subclasses:

MultipassViewportLayer, SimpleViewportLayer, ViewportLayer2D

public abstract class ViewportLayer
extends SceneGraphObject

An abstract layer definition for per-viewport layer rendering.

A layer is a composite of objects that are applied in a sequential manner to the given surface, within one specific viewport. 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.

Implementation Notes

Even though this class is almost identical to the Layer class, a separate heirarchy is defined so that users cannot accidently use viewport layers at the root of the scene graph, and vice versa.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

static int	FLAT The layer is a 2D type, having only 2D rendering used
protected int	layerType The layer type constant
static int	MULTIPASS The layer contains multipass rendering
static int	SIMPLE The layer is a simple type, having single scene defined
protected int	viewHeight The width of the viewport in pixels
protected int	viewWidth The width of the viewport in pixels
protected int	viewX The lower left X position of the viewpoint, in pixels
protected int	viewY The lower left Y position of the viewpoint, in pixels

Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject

alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler

Constructor Summary

protected

ViewportLayer(int type) Construct a new layer of the given type.

Method Summary

int	getType() Get the type that this layer represents

Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject

checkForCyclicChild, checkForCyclicParent, dataChanged, getAppUpdateWriteTimingMessage, getBoundsWriteTimingMessage, getDataWriteTimingMessage, getUserData, isLive, setLive, setUpdateHandler, setUserData

Methods inherited from class java.lang.Object

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

Field Detail

SIMPLE

public static final int SIMPLE

The layer is a simple type, having single scene defined

See Also:

Constant Field Values

FLAT

public static final int FLAT

The layer is a 2D type, having only 2D rendering used

See Also:

Constant Field Values

MULTIPASS

public static final int MULTIPASS

The layer contains multipass rendering

See Also:

Constant Field Values

layerType

protected final int layerType

The layer type constant

viewX

protected int viewX

The lower left X position of the viewpoint, in pixels

viewY

protected int viewY

The lower left Y position of the viewpoint, in pixels

viewWidth

protected int viewWidth

The width of the viewport in pixels

viewHeight

protected int viewHeight

The width of the viewport in pixels

Constructor Detail

ViewportLayer

protected ViewportLayer(int type)

Construct a new layer of the given type. One of the standard types may be used, or a custom type.

Parameters:

type - The type constant for this layer

Method Detail

getType

public int getType()

Get the type that this layer represents

Returns:

A layer type descriptor