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

Class BaseSwitch

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseGroupingNode

org.web3d.vrml.renderer.common.nodes.group.BaseSwitch

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLGroupingNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRSwitch, OGLSwitch

public class BaseSwitch
extends BaseGroupingNode

common version of a Switch node.

This code assigns a LOD node as the implGroup. As this code is a grouping node, we allow the use of the children being specified as either the childre field or the level field. The former is VRML3.0 and the latter VRML 2.0

The LOD Behavior node is kept as a child of the group node that works here. When the VRML node is removed from the scene, the behavior is too. When the behavior is asked to be disabled, we just call the setEnable method on the behavior, we do not remove it.

If someone routes a range change to us, then we see if it is the same length. If it is, we just set the range values in the existing behavior. If not, then we have to replace the old LOD with a new LOD that has the correct number of nodes in it. If the size of the range grows such that it is greater than the number of children nodes, we disable the behavior until the number of children increase to the correct amount. In the branchgroup, the behavior is always

Version:

$Revision: 1.9 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_WHICH_CHOICE	Index of the whichChoice field
protected static final int	LAST_SWITCH_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected int	vfWhichChoice	The whichChoice field

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

childCount, FIELD_ADDCHILDREN, FIELD_BBOX_CENTER, FIELD_BBOX_DISPLAY, FIELD_BBOX_SIZE, FIELD_CHILDREN, FIELD_REMOVECHILDREN, FIELD_VISIBLE, hasBindables, LAST_GROUP_INDEX, shareCount, USE_BIND_MSG, vfBboxCenter, vfBboxDisplay, vfBboxSize, vfChildren, vfVisible

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

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

Method Summary

Modifier and Type	Method	Description
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.
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.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setValue(int index, int value)	Set the value of the field at the given index as an integer.
protected void	setWhichChoice(int newChoice)	Set which child to display

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

addChild, addChildNode, clearChildren, containsBindableNodes, copy, getBboxCenter, getBboxDisplay, getBboxSize, getChildren, getChildrenSize, getPrimaryType, getVisible, isShared, removeChildNode, setBboxCenter, setBboxDisplay, setBboxSize, setChildren, setChildren, setDEF, setShared, setupFinished, setValue, setValue, setValue, setValue, setVisible, updateRefCount

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

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, 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.nodes.FrameStateListener

allEventsComplete

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, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Field Details

FIELD_WHICH_CHOICE

protected static final int FIELD_WHICH_CHOICE

Index of the whichChoice field

See Also:

• Constant Field Values

LAST_SWITCH_INDEX

protected static final int LAST_SWITCH_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfWhichChoice

protected int vfWhichChoice

The whichChoice field

Constructor Details

BaseSwitch

public BaseSwitch()

Construct a default instance of this node. The defaults are set by the VRML specification.

BaseSwitch

public BaseSwitch(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a group node, an exception will be thrown. It does not copy the children nodes, just this node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

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.

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.

Returns:

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

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.

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Returns:

The number of fields.

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 BaseGroupingNode

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 BaseGroupingNode

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

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 node

Throws:

InvalidFieldException - The field index is not know

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setWhichChoice

protected void setWhichChoice(int newChoice)
                       throws InvalidFieldValueException

Set which child to display. -1 = NONE. A derived class may choose to override this method for a more specific implementation. It should make care to also call this version so that the internal field values are updated and the correct events are sent.

Parameters:

newChoice - The new child to display

Throws:

InvalidFieldValueException - whichChoice <= -1