org.j3d.aviatrix3d
Class SimpleLayer2D

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

All Implemented Interfaces:

Cullable, LayerCullable

public class SimpleLayer2D
extends Layer

An layer definition that only allows a single viewport that covers the entire area as it's child.

Internationalisation Resource Names

• hasParentMsg: Error message when the (internal) caller tries to call setParent() when this class already has a parent.

Version:

$Revision: 2.5 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.j3d.aviatrix3d.Layer

COMPOSITE, COMPOSITE_2D, layerType, SIMPLE, SIMPLE_2D

Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject

alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler

Constructor Summary

SimpleLayer2D()
Construct a new layer instance

Method Summary

ViewportCullable	getCullableViewport(int viewportIndex) Get the cullable layer child that for the given layer index.
Viewport2D	getViewport() Get the currently set viewport instance.
boolean	isActiveSoundLayer() Check to see if this is the currently active layer for sound rendering.
void	makeActiveSoundLayer() Set this layer to be the currently active sound layer.
int	numCullableChildren() Returns the number of valid cullable children to process.
protected void	setLive(boolean state) Notification that this object is live now.
protected void	setUpdateHandler(NodeUpdateHandler handler) Set the scenegraph update handler for this node.
void	setViewport(Viewport2D vp) Set a new viewport instance to be used by this layer.

Methods inherited from class org.j3d.aviatrix3d.Layer

compareTo, equals, equals, getCullable, getType

Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleLayer2D

public SimpleLayer2D()

Construct a new layer instance

Method Detail

getCullableViewport

public ViewportCullable getCullableViewport(int viewportIndex)

Get the cullable layer child that for the given layer index.

Returns:

The layer cullable at the given index or null

numCullableChildren

public int numCullableChildren()

Returns the number of valid cullable children to process. If there are no valid cullable children, return 0.

Returns:

A number greater than or equal to zero

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

makeActiveSoundLayer

public void makeActiveSoundLayer()
                          throws InvalidWriteTimingException

Set this layer to be the currently active sound layer. The previously active layer will be disabled. This method can only be called during the dataChanged() callback.

Throws:

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

isActiveSoundLayer

public boolean isActiveSoundLayer()

Check to see if this is the currently active layer for sound rendering. This will only return true the frame after calling makeActiveSoundLayer(). The effects, however, will be rendered starting the frame that this is set.

Returns:

true if this is the layer that will generate sound rendering

setViewport

public void setViewport(Viewport2D vp)
                 throws InvalidWriteTimingException,
                        AlreadyParentedException

Set a new viewport instance to be used by this layer.

Note that a viewport cannot have more than one parent, so sharing it between layers will result in an error.

Parameters:

vp - The viewport instance to use, or null to clear

Throws:

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

AlreadyParentedException - This scene already has a current parent preventing it from being used

getViewport

public Viewport2D getViewport()

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

Returns:

The current viewport instance or null