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

Class BaseGeoSRFTemplate

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType

Direct Known Subclasses:

NRGeoSRFTemplate, OGLGeoSRFTemplate

public class BaseGeoSRFTemplate
extends BaseGeoSRFParametersNode

Common implementation of an GeoSRFTParametersInfo node.

Version:

$Revision: 1.2 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ORM_CODE	Index of the ormCode field
protected static final int	FIELD_SRFT_CODE	Index of the srtfCode field
protected static final int	FIELD_SRFT_PARAMETERS	Index of the srtfParameters field
protected static final VRMLFieldDeclaration[]	fieldDecl	Array of VRMLFieldDeclarations
protected static final Map<String,Integer>	fieldMap	Hashmap between a field name and its index
protected static final int	LAST_PARAMS_INFO_INDEX	The last index of the fields used by the metadata
protected VRMLProtoInstance	pSrfParameters	Proto version of the srtfParametersInfo node
protected int	vfOrmCode	field SFInt32 ormCode
protected VRMLNodeType	vfSrfParameters	initializeOnly SFNode srtfParametersInfo
protected int	vfSrftCode	field SFInt32 srftCode

Fields inherited from class org.web3d.vrml.renderer.common.nodes.geospatial.BaseGeoSRFParametersNode

LAST_SRF_PARAM_INDEX

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
BaseGeoSRFTemplate()	Construct a default GeoMetaData instance
BaseGeoSRFTemplate(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	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, VRMLNodeType child)	Set the value of the field at the given index as a node.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.geospatial.BaseGeoSRFParametersNode

copy, getPrimaryType

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, setUserData, 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

Field Details

FIELD_ORM_CODE

protected static final int FIELD_ORM_CODE

Index of the ormCode field

See Also:

• Constant Field Values

FIELD_SRFT_CODE

protected static final int FIELD_SRFT_CODE

Index of the srtfCode field

See Also:

• Constant Field Values

FIELD_SRFT_PARAMETERS

protected static final int FIELD_SRFT_PARAMETERS

Index of the srtfParameters field

See Also:

• Constant Field Values

LAST_PARAMS_INFO_INDEX

protected static final int LAST_PARAMS_INFO_INDEX

The last index of the fields used by the metadata

See Also:

• Constant Field Values

fieldDecl

protected static final VRMLFieldDeclaration[] fieldDecl

Array of VRMLFieldDeclarations

fieldMap

protected static final Map<String,Integer> fieldMap

Hashmap between a field name and its index

vfSrfParameters

protected VRMLNodeType vfSrfParameters

initializeOnly SFNode srtfParametersInfo

pSrfParameters

protected VRMLProtoInstance pSrfParameters

Proto version of the srtfParametersInfo node

vfSrftCode

protected int vfSrftCode

field SFInt32 srftCode

vfOrmCode

protected int vfOrmCode

field SFInt32 ormCode

Constructor Details

BaseGeoSRFTemplate

public BaseGeoSRFTemplate()

Construct a default GeoMetaData instance

BaseGeoSRFTemplate

public BaseGeoSRFTemplate(VRMLNodeType 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

Method Details

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

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 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 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 index is not a valid field

InvalidFieldValueException - The field value is not legal for the field specified.

setValue

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

Set the value of the field at the given index as a node. This would be used to set SFNode 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 node does not match the required type.