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

Class BaseGeoMParameters

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType

Direct Known Subclasses:

NRGeoMParameters, OGLGeoMParameters

public class BaseGeoMParameters
extends BaseGeoSRFTParametersNode

Common implementation of an GeoMParameters node.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_CENTRAL_SCALE	Index of the centralScale field
protected static final int	FIELD_FALSE_EASTING	Index of the falseEasting field
protected static final int	FIELD_FALSE_NORTHING	Index of the falseNorthing field
protected static final int	FIELD_ORIGIN_LONGITUDE	Index of the originLongitude 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_TMPARAMS_INDEX	The last index of the nodes used by the GeoMParameters
protected double	vfCentralScale	initializeOnly SFDouble centralScale 0
protected double	vfFalseEasting	initializeOnly SFDouble falseEasting 0
protected double	vfFalseNorthing	initializeOnly SFDouble falseNorthing 0
protected double	vfOriginLongitude	initializeOnly SFDouble originLongitude 0

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

LAST_SRFT_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
BaseGeoMParameters()	Construct a default instance of this node.
BaseGeoMParameters(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	setValue(int index, double value)	Set the value of the field at the given index as an double.

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

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

Field Details

FIELD_CENTRAL_SCALE

protected static final int FIELD_CENTRAL_SCALE

Index of the centralScale field

See Also:

• Constant Field Values

FIELD_FALSE_EASTING

protected static final int FIELD_FALSE_EASTING

Index of the falseEasting field

See Also:

• Constant Field Values

FIELD_FALSE_NORTHING

protected static final int FIELD_FALSE_NORTHING

Index of the falseNorthing field

See Also:

• Constant Field Values

FIELD_ORIGIN_LONGITUDE

protected static final int FIELD_ORIGIN_LONGITUDE

Index of the originLongitude field

See Also:

• Constant Field Values

LAST_TMPARAMS_INDEX

protected static final int LAST_TMPARAMS_INDEX

The last index of the nodes used by the GeoMParameters

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

vfCentralScale

protected double vfCentralScale

initializeOnly SFDouble centralScale 0

vfFalseEasting

protected double vfFalseEasting

initializeOnly SFDouble falseEasting 0

vfFalseNorthing

protected double vfFalseNorthing

initializeOnly SFDouble falseNorthing 0

vfOriginLongitude

protected double vfOriginLongitude

initializeOnly SFDouble originLongitude 0

Constructor Details

BaseGeoMParameters

public BaseGeoMParameters()

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

BaseGeoMParameters

public BaseGeoMParameters(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

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,
 double value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an double. This would be used to set SFDouble or SFTime 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.