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

Class BaseScalarInterpolator

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseInterpolatorNode

org.web3d.vrml.renderer.common.nodes.interpolator.BaseScalarInterpolator

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLInterpolatorNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRScalarInterpolator, OGLScalarInterpolator

public abstract class BaseScalarInterpolator
extends BaseInterpolatorNode

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

Version:

$Revision: 1.15 $

Author:

Justin Couch

Field Summary

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	BaseScalarInterpolator()	Initialise the time dependent node and it's fields that are held locally.
protected	BaseScalarInterpolator(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.
float[]	getKeyValue()	Get the currently set key value.
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.
float	getValue()	Get the current value available at this time.
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	setKeyValue(float[] keyValues, int numValid)	Set the key value (MFVec3f) to the new value.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(float value)	Set the value (SFFloat) to the new value.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.

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

copy, getFraction, getKey, getNumKey, 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, 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

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

Constructor Details

BaseScalarInterpolator

protected BaseScalarInterpolator()

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

BaseScalarInterpolator

protected BaseScalarInterpolator(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.

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.

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 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,
 float[] 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, SFFloat and SFRotation field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseInterpolatorNode

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(float value)

Set the value (SFFloat) to the new value. Null values will be ignored.

Parameters:

value - The new value to use

getValue

public float getValue()

Get the current value available at this time. If no fraction has been set yet, this will return the keyValue[0]. This is a live copy of the internal data so don't change it!

Returns:

The current keyValue

setKeyValue

public void setKeyValue(float[] keyValues,
 int numValid)

Set the key value (MFVec3f) to the new value. If the value is null, it will clear the currently set list and return it to an empty list.

Parameters:

keyValues - The new values to use

numValid - sets the used length of the keyValue array

getKeyValue

public float[] getKeyValue()

Get the currently set key value. If the value is not set you will get a zero length array returned.

Returns:

The current key value