Aviatrix3D
2.0 Dev

org.j3d.aviatrix3d
Class Layer

java.lang.Object
  extended byorg.j3d.aviatrix3d.SceneGraphObject
      extended byorg.j3d.aviatrix3d.Layer
Direct Known Subclasses:
CompositeLayer, Layer2D, SimpleLayer

public abstract class Layer
extends SceneGraphObject

An abstract layer definition that can be applied at the root of the scene graph.

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.5 $
Author:
Justin Couch

Field Summary
static int COMPOSITE
          The layer is a composite type, having many viewports defined
static int FLAT
          The layer is a 2D type, having only 2D rendering used
protected  int layerType
          The layer type constant
static int SIMPLE
          The layer is a simple type, having single 3D viewport defined
 
Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject
alive, LISTENER_SET_NOT_LIVE_MESSAGE, updateHandler, WRITE_TIMING_MSG
 
Constructor Summary
protected Layer(int type)
          Construct a new layer of the given type.
 
Method Summary
 int compareTo(Layer layer)
          Compares this object with the specified object for order.
 boolean equals(Layer layer)
          Compares this object with the specified object to check for equivalence.
 boolean equals(java.lang.Object o)
          Compare this object for equality to the given object.
 int getType()
          Get the type that this layer represents
 
Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject
checkForCyclicChild, checkForCyclicParent, dataChanged, getUserData, isLive, setLive, setUpdateHandler, setUserData
 
Methods inherited from class java.lang.Object
clone, 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 3D viewport defined

See Also:
Constant Field Values

COMPOSITE

public static final int COMPOSITE
The layer is a composite type, having many viewports 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

layerType

protected final int layerType
The layer type constant

Constructor Detail

Layer

protected Layer(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

equals

public boolean equals(java.lang.Object o)
Compare this object for equality to the given object.

Parameters:
o - The object to be compared
Returns:
True if these represent the same values

getType

public int getType()
Get the type that this layer represents

Returns:
A layer type descriptor

compareTo

public int compareTo(Layer layer)
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Derived instances should override this to add texture-specific extensions.

Parameters:
layer - The layer instance to be compared
Returns:
-1, 0 or 1 depending on order

equals

public boolean equals(Layer layer)
Compares this object with the specified object to check for equivalence.

Parameters:
layer - The layer instance to be compared
Returns:
true if the objects represent identical values

Aviatrix3D
2.0 Dev

Latest Info from http://aviatrix3d.j3d.org/
Copyright © 2003 - 2005 j3d.org