org.j3d.aviatrix3d
Class BufferState

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

Direct Known Subclasses:

AccumulationBufferState, ColorBufferState, DepthBufferState, GeneralBufferState, StencilBufferState

public abstract class BufferState
extends SceneGraphObject

Representation of scene graph objects that control the drawing buffer state at the root of the scene graph.

Buffer state information can be shared between scenes, though it is expected to be unlikely.

Internationalisation Resource Names

• nullParentMsg: Error message when the user tries to set this in something that is not part of the transform heirarchy.
• nullArrayParentMsg: Error message when the (internal) caller tries to call getParents() with a null array reference.

Version:

$Revision: 2.4 $

Author:

Justin

Field Summary

protected int	lastParent Index to the next place to add items in the nodeList
protected int	liveCount Counter for how many times we've been marked as live so to know when to notify the children of a change of state.
protected SceneGraphObject[]	parentList Listing of all the parents of this node

Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject

alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler

Constructor Summary

protected

BufferState() Initialise a new instance of the component, setting up the internal state needed.

Method Summary

protected void	addParent(SceneGraphObject p) Specify this nodes parent, overridden to provide behaviour that appends the node to the list rather than replacing it.
void	getParents(Node[] parents) Get the listing of the number of parents that this node currently has.
int	numParents() Request the number of parents this node currently contains
protected void	removeParent(SceneGraphObject p) Remove a parent from this shared group.

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

parentList

protected SceneGraphObject[] parentList

Listing of all the parents of this node

lastParent

protected int lastParent

Index to the next place to add items in the nodeList

liveCount

protected int liveCount

Counter for how many times we've been marked as live so to know when to notify the children of a change of state.

Constructor Detail

BufferState

protected BufferState()

Initialise a new instance of the component, setting up the internal state needed.

Method Detail

addParent

protected void addParent(SceneGraphObject p)
                  throws AlreadyParentedException,
                         InvalidNodeTypeException

Specify this nodes parent, overridden to provide behaviour that appends the node to the list rather than replacing it. The parent must be a group node in this case.

Parameters:

p - The new parent instance to add to the list

Throws:

AlreadyParentedException - There is a valid parent already set

InvalidNodeTypeException - Not a group node

removeParent

protected void removeParent(SceneGraphObject p)

Remove a parent from this shared group. Since setParent() cannot be used to remove a parent from the graph, you'll need to use this method to remove the parent.

Parameters:

p - The new parent instance to remove from the list

numParents

public int numParents()

Request the number of parents this node currently contains

Returns:

a positive number

getParents

public void getParents(Node[] parents)

Get the listing of the number of parents that this node currently has. The provided array must be at least big enough to copy all the values into it.

Parameters:

parents - An array to copy the parent listing into