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

Class BaseGeoSRFParametersInfoNode

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.geospatial.BaseGeoSRFParametersInfoNode

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType

Direct Known Subclasses:

BaseGeoSRFParametersInfo

public abstract class BaseGeoSRFParametersInfoNode
extends AbstractNode

Common base implementation of the abstract node type X3DSRFParametersInfoNode node.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_RTCODE	Index of the rtCode field
protected static final int	LAST_SRF_PARAM_INFO_INDEX	The last index of the nodes used by the SRFParametersInfoNode
protected int	vfRtCode	field SFInt32 rtCode

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	BaseGeoSRFParametersInfoNode(String name)	Construct a default instance of this node type.

Method Summary

Modifier and Type	Method	Description
protected void	copy(BaseGeoSRFParametersInfoNode node)	Construct a new instance of this node based on the details from the given node.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int	getPrimaryType()	Get the primary type of this node.
int	getRtCode()	Get the value of the rtCode field.
void	setValue(int index, int value)	Set the value of the field at the given index as a single int value.

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, sendRoute, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, setValue, setValue, setValue, 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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields

Field Details

FIELD_RTCODE

protected static final int FIELD_RTCODE

Index of the rtCode field

See Also:

• Constant Field Values

LAST_SRF_PARAM_INFO_INDEX

protected static final int LAST_SRF_PARAM_INFO_INDEX

The last index of the nodes used by the SRFParametersInfoNode

See Also:

• Constant Field Values

vfRtCode

protected int vfRtCode

field SFInt32 rtCode

Constructor Details

BaseGeoSRFParametersInfoNode

protected BaseGeoSRFParametersInfoNode(String name)

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

Parameters:

name - The name of the type of node

Method Details

copy

protected void copy(BaseGeoSRFParametersInfoNode node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - Incorrect Node Type

getPrimaryType

public int getPrimaryType()

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

Returns:

The primary type

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

setValue

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

Set the value of the field at the given index as a single int value. 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 known

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

getRtCode

public int getRtCode()

Get the value of the rtCode field. The value is specified by section 11.2.7.6 of ISO/IEC 18026

Returns:

A value RT code value.