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

All Implemented Interfaces:: VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLInterpolatorNodeType, VRMLNodeType, VRMLWorldRootChildNodeType, OriginListener

Direct Known Subclasses:: NRGeoPositionInterpolator, OGLGeoPositionInterpolator

public abstract class BaseGeoPositionInterpolator extends BaseInterpolatorNode implements OriginListener

Abstract implementation of a position interpolator so that specific renderer instances can derive from it.

Interpolator nodes are designed for linear keyframed animation. Interpolators are driven by an input key ranging [0..1] and produce corresponding piecewise-linear output functions.

As interpolators all have the same number and named fields, we perform all of the setup here in this class. The handling of the basic fields are performed where you see the overridden methods, however routing and sets are not looked after.

If the key and keyValue fields are not the same length then we take the lesser of the two and only assign that many vertices to the interpolator to handle.

Version:: $Revision: 1.10 $
Author:: Justin Couch

Field Summary

Fields

Modifier and Type

Field

Description

protected static final int

FIELD_GEO_ORIGIN

Index of the geoOrigin field

protected static final int

FIELD_GEO_SYSTEM

Index of the geoSystem field

protected static final int

FIELD_GEO_VALUE_CHANGED

Index of the geovalue_changed field

protected static final int

LAST_GEO_INDEX

The last field index used by this class

protected double[]

local_origin

The origin in use

protected OriginManager

originManager

Manager for precision control

protected VRMLProtoInstance

pGeoOrigin

Proto version of the geoOrigin

protected boolean

useOriginManager

Flag indicating that the OriginManager is enabled

protected VRMLNodeType

vfGeoOrigin

field SFNode geoOrigin

protected String[]

vfGeoSystem

field MFString geoSystem ["GD","WE"]

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseInterpolatorNode
FIELD_FRACTION, FIELD_KEY, FIELD_KEY_VALUE, FIELD_VALUE, LAST_INTERPOLATOR_INDEX, numKey, vfFraction, vfKey

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

BaseGeoPositionInterpolator()

Initialise the time dependent node and it's fields that are held locally.

protected

BaseGeoPositionInterpolator(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.

int[]

getSecondaryType()

Get the secondary type of this node.

void

originChanged()

Notification that the origin has changed.

void

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

Send a routed value from this node to the given destination node.

void

setFraction(float newFraction)

Set a new value for the fraction field.

void

setKey(float[] keys, int numValid)

Set a new value for the key field.

void

setupFinished()

Notification that the construction phase of this node has finished.

void

setValue(int index, double[] value, int numValid)

Set the value of the field at the given index as an array of floats.

void

setValue(int index, float value)

Set the value of the field at the given index as a float.

void

setValue(int index, String[] value, int numValid)

Set the value of the field at the given index as an array of strings.

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.BaseInterpolatorNode
copy, getFraction, getKey, getNumKey, getPrimaryType, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode
addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, 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.nodes.FrameStateListener
allEventsComplete

Methods inherited from interface org.web3d.vrml.lang.VRMLNode
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, updateRefCount

Field Details
- FIELD_GEO_VALUE_CHANGED
  protected static final int FIELD_GEO_VALUE_CHANGED
  
  Index of the geovalue_changed field
  
  See Also:
  
  Constant Field Values
- FIELD_GEO_ORIGIN
  protected static final int FIELD_GEO_ORIGIN
  
  Index of the geoOrigin field
  
  See Also:
  
  Constant Field Values
- FIELD_GEO_SYSTEM
  protected static final int FIELD_GEO_SYSTEM
  
  Index of the geoSystem field
  
  See Also:
  
  Constant Field Values
- LAST_GEO_INDEX
  protected static final int LAST_GEO_INDEX
  
  The last field index used by this class
  
  See Also:
  
  Constant Field Values
- vfGeoSystem
  
  protected String[] vfGeoSystem
  
  field MFString geoSystem ["GD","WE"]
- pGeoOrigin
  
  protected VRMLProtoInstance pGeoOrigin
  
  Proto version of the geoOrigin
- vfGeoOrigin
  
  protected VRMLNodeType vfGeoOrigin
  
  field SFNode geoOrigin
- originManager
  
  protected OriginManager originManager
  
  Manager for precision control
- useOriginManager
  
  protected boolean useOriginManager
  
  Flag indicating that the OriginManager is enabled
- local_origin
  
  protected double[] local_origin
  
  The origin in use
Constructor Details
- BaseGeoPositionInterpolator
  
  protected BaseGeoPositionInterpolator()
  
  Initialise the time dependent node and it's fields that are held locally.
- BaseGeoPositionInterpolator
  
  protected BaseGeoPositionInterpolator(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 - The node is not the same type
Method Details
- setFraction
  
  public void setFraction(float newFraction)
  
  Set a new value for the fraction field. This will always evaluate even if the fraction is the same as the old fraction.
  
  Specified by:
  
  setFraction in interface VRMLInterpolatorNodeType
  
  Parameters:
  
  newFraction - The new value for fraction
- setKey
  
  public void setKey(float[] keys, int numValid)
  
  Set a new value for the key field. Null will delete all key values.
  
  Specified by:
  
  setKey in interface VRMLInterpolatorNodeType
  
  Overrides:
  
  setKey in class BaseInterpolatorNode
  
  Parameters:
  
  keys - The new key values to use
  
  numValid - The number of valid values to copy from the array
- 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.
  
  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
- 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
- getNumFields
  
  public int getNumFields()
  
  Get the number of fields.
  
  Specified by:
  
  getNumFields in interface VRMLNode
  
  Returns:
  
  The number of fields.
- getSecondaryType
  
  public int[] getSecondaryType()
  
  Get the secondary type of this node. Replaces the instanceof mechanism for use in switch statements.
  
  Specified by:
  
  getSecondaryType in interface VRMLNode
  
  Overrides:
  
  getSecondaryType in class AbstractNode
  
  Returns:
  
  The secondary 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 BaseInterpolatorNode
  
  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 BaseInterpolatorNode
  
  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, float value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a float. This would be used to set SFFloat field type for the field fraction
  
  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
- setValue
  
  public void setValue(int index, double[] value, int numValid) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation 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
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldException - The field index is not know
  
  InvalidFieldValueException - The value provided is not in range or not appropriate for this field
- setValue
  
  public void setValue(int index, String[] value, int numValid) throws InvalidFieldException, InvalidFieldValueException, InvalidFieldAccessException
  
  Set the value of the field at the given index as an array of strings. This would be used to set the MFString field type "type".
  
  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
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldException - The field index is not know
  
  InvalidFieldValueException - The value provided is not in range or not appropriate for this field
  
  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
  
  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.
- originChanged
  
  public void originChanged()
  
  Notification that the origin has changed.
  
  Specified by:
  
  originChanged in interface OriginListener

Class BaseGeoPositionInterpolator

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Details

FIELD_GEO_VALUE_CHANGED

FIELD_GEO_ORIGIN

FIELD_GEO_SYSTEM

LAST_GEO_INDEX

vfGeoSystem

pGeoOrigin

vfGeoOrigin

originManager

useOriginManager

local_origin

Constructor Details

BaseGeoPositionInterpolator

BaseGeoPositionInterpolator

Method Details

setFraction

setKey

setupFinished

getFieldIndex

getNodeFieldIndices

getFieldDeclaration

getNumFields

getSecondaryType

getFieldValue

sendRoute

setValue

setValue

setValue

setValue

originChanged