Package org.web3d.vrml.renderer.common.nodes.layering

Class BaseLayerSet

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.layering.BaseLayerSet

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLLayerSetNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRLayerSet, OGLLayerSet

public class BaseLayerSet
extends AbstractNode
implements VRMLLayerSetNodeType

This is the base for the LayerSet node.

The basic definition of LayerSet is:

 LayerSet : X3DNode {
  MFNode  [in,out]  layers      []   [Layer]
  SFInt32 [in,out]  activeLayer 0    (-?,?)
  SFNode  [in,out]  metadata    NULL [X3DMetadataObject]
  MFInt32 [in,out]  order       []   [0,?)
 }
 

Version:

$Revision: 1.5 $

Author:

Brad Vender, Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ACTIVE_LAYER	Index of the mainLayer field
protected static final int	FIELD_LAYERS	Index of the layers field
protected static final int	FIELD_ORDER	Index of the order field
protected static final int	LAST_LAYERSET_INDEX	The last valid field index for this node
protected static final String	LAYER_NODE_MSG	Message for when the node in setValue() is not a Layer
protected static final String	LAYER_PROTO_MSG	Message for when the proto is not a Layer
protected int	vfActiveLayer	SFInt32 activeLayer 0
protected List<VRMLNodeType>	vfLayers	MFNode children NULL
protected int[]	vfOrder	MFInt32 order []

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseLayerSet()	Construct a new default instance of this class.
protected	BaseLayerSet(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
protected void	addChildNode(VRMLNodeType node)	Add a single child node to the list of available children.
void	allEventsComplete()	Process the end of frame event completion notification.
protected void	clearChildren()	Clear the child node list of all children in the VRML node.
int	getActiveNavigationLayer()	Get the ID of the layer that should be active for navigation in during this frame.
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
VRMLNodeType[]	getLayers()	Get the layers this set manages.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
int	getNumRenderedLayers()	Query how many layers should be actively rendered this frame.
int	getPrimaryType()	Get the primary type of this node.
void	getRenderOrder(int[] order)	Get the rendering order of the layers, copied into the given array.
boolean	hasLayerListChanged()	Check to see if the layers themselves have changed this frame.
boolean	hasRenderOrderChanged()	Check to see if the render order has changed this frame.
protected void	removeChildNode(VRMLNodeType node)	Remove the given node from this grouping node.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setLayers(VRMLNodeType[] layers)	Set the layers field with a collection of new layers.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, int value)	Set the value of the field at the given index as an integer.
void	setValue(int index, int[] value, int numValid)	Set the value of the field at the given index as an array of integers.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as an array of nodes.
void	setValue(int index, VRMLNodeType[] children, int numValid)	Set the value of the field at the given index as an array of nodes.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_LAYERS

protected static final int FIELD_LAYERS

Index of the layers field

See Also:

• Constant Field Values

FIELD_ACTIVE_LAYER

protected static final int FIELD_ACTIVE_LAYER

Index of the mainLayer field

See Also:

• Constant Field Values

FIELD_ORDER

protected static final int FIELD_ORDER

Index of the order field

See Also:

• Constant Field Values

LAST_LAYERSET_INDEX

protected static final int LAST_LAYERSET_INDEX

The last valid field index for this node

See Also:

• Constant Field Values

LAYER_PROTO_MSG

protected static final String LAYER_PROTO_MSG

Message for when the proto is not a Layer

See Also:

• Constant Field Values

LAYER_NODE_MSG

protected static final String LAYER_NODE_MSG

Message for when the node in setValue() is not a Layer

See Also:

• Constant Field Values

vfLayers

protected List<VRMLNodeType> vfLayers

MFNode children NULL

vfActiveLayer

protected int vfActiveLayer

SFInt32 activeLayer 0

vfOrder

protected int[] vfOrder

MFInt32 order []

Constructor Details

BaseLayerSet

protected BaseLayerSet()

Construct a new default instance of this class.

BaseLayerSet

protected BaseLayerSet(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a light node, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - Incorrect Node Type

Method Details

allEventsComplete

public void allEventsComplete()

Process the end of frame event completion notification. This is used to check range values for the layer nodes versus the order field request.

Specified by:

allEventsComplete in interface FrameStateListener

Overrides:

allEventsComplete in class AbstractNode

getLayers

public VRMLNodeType[] getLayers()

Get the layers this set manages. Provides a live reference not a copy.

Specified by:

getLayers in interface VRMLLayerSetNodeType

Returns:

An array of VRMLNodeTypes

setLayers

public void setLayers(VRMLNodeType[] layers)

Set the layers field with a collection of new layers.

Specified by:

setLayers in interface VRMLLayerSetNodeType

Parameters:

layers - Array of new layer instance nodes to use

Throws:

InvalidFieldValueException - One or more of the passed nodes does not represent a layer node

getActiveNavigationLayer

public int getActiveNavigationLayer()

Get the ID of the layer that should be active for navigation in during this frame.

Specified by:

getActiveNavigationLayer in interface VRMLLayerSetNodeType

Returns:

An int greater than or equal to zero

getNumRenderedLayers

public int getNumRenderedLayers()

Query how many layers should be actively rendered this frame. This will come from the order list's length

Specified by:

getNumRenderedLayers in interface VRMLLayerSetNodeType

Returns:

A positive number

getRenderOrder

public void getRenderOrder(int[] order)

Get the rendering order of the layers, copied into the given array. Assumes that the array must be at least getNumRenderedLayers() in length;

Specified by:

getRenderOrder in interface VRMLLayerSetNodeType

Parameters:

order - The array to copy values into

hasLayerListChanged

public boolean hasLayerListChanged()

Check to see if the layers themselves have changed this frame. If they have, we need to rebuild the user interface next time around.

Specified by:

hasLayerListChanged in interface VRMLLayerSetNodeType

Returns:

true if the layer list has changed since last frame

hasRenderOrderChanged

public boolean hasRenderOrderChanged()

Check to see if the render order has changed this frame. If it has, return true, otherwise return false. Can only be asked once per frame, and is reset to false after calling.

Specified by:

hasRenderOrderChanged in interface VRMLLayerSetNodeType

Returns:

true if the render order has changed since last frame

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Specified by:

getFieldDeclaration in interface VRMLNode

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Specified by:

getFieldIndex in interface VRMLNode

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class AbstractNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class AbstractNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 int value)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an integer. This would be used to set SFInt32 field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the field

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 int[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of integers. This would be used to set MFInt32 field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the field

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

child - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setValue

public void setValue(int index,
 VRMLNodeType[] children,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

children - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

clearChildren

protected void clearChildren()

Clear the child node list of all children in the VRML node. Override to provide.renderer-specific behaviour, but remember to also call this implementation too.

addChildNode

protected void addChildNode(VRMLNodeType node)
                     throws InvalidFieldValueException

Add a single child node to the list of available children. Override to provide.renderer-specific behaviour, but remember to also call this implementation too.

Parameters:

node - The node to add

Throws:

InvalidFieldValueException - This is a bindable node shared

removeChildNode

protected void removeChildNode(VRMLNodeType node)

Remove the given node from this grouping node. If the node is not a child of this node, the request is silently ignored.

Parameters:

node - The node to remove