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

Class BaseNormal

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseGeometricPropertyNode

org.web3d.vrml.renderer.common.nodes.render.BaseNormal

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLGeometricPropertyNodeType, VRMLNodeType, VRMLNormalNodeType

Direct Known Subclasses:

NRNormal, OGLNormal

public abstract class BaseNormal
extends BaseGeometricPropertyNode
implements VRMLNormalNodeType

Common base implementation of a normal node.

Vectors are held internally as a flat array of values. The point list returned will always be flat. We do this because renderers like point values into the geometry classes as a single flat array. The array returned will always contain exactly the number of points specified even though internally we may do other things.

The effect of this is that point values may be routed out of this node as a flat array of points rather than a 2D array. Receiving nodes should check for this version as well. This implementation will handle being routed either form. The Normal node is defined by the X3D specification as:

  Normal : X3DNormalNode {
    SFNode  [in,out] metadata NULL [X3DMetadataObject]
    MFVec3f [in,out] vector   []   (-inf,inf)
  }
 

Version:

$Revision: 1.13 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_VECTOR	Index of the vector field
protected static final int	LAST_NORMAL_INDEX	The last field index used by this class
protected int	numVector	actual length of vfVector
protected float[]	vfVector	exposedField MFVec3f

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	BaseNormal()	Default constructor creates a normal with no values.
	BaseNormal(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	getNumNormals()	Get the number of items in the normal array now.
int	getPrimaryType()	Get the primary type of this node.
void	getVector(float[] normals)	Get current value of field vector.
float[]	getVectorRef()	Get the internal reference to the raw or converted array of normals.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setVector(float[] newVector, int numValid)	Accessor method to set a new value for field attribute vector Vector is an array of triplicates of Vec3f data ie [V3f0-0,V3f0-1,V3f0-2,V3f1-0,V3f1-1,V3f1-2,V3f2-0...]

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

addComponentListener, fireComponentChanged, removeComponentListener

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, 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.nodes.FrameStateListener

allEventsComplete

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

addComponentListener, removeComponentListener

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, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_VECTOR

protected static final int FIELD_VECTOR

Index of the vector field

See Also:

• Constant Field Values

LAST_NORMAL_INDEX

protected static final int LAST_NORMAL_INDEX

The last field index used by this class

See Also:

• Constant Field Values

vfVector

protected float[] vfVector

exposedField MFVec3f

numVector

protected int numVector

actual length of vfVector

Constructor Details

BaseNormal

protected BaseNormal()

Default constructor creates a normal with no values.

BaseNormal

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

setVector

public void setVector(float[] newVector,
 int numValid)

Accessor method to set a new value for field attribute vector Vector is an array of triplicates of Vec3f data ie [V3f0-0,V3f0-1,V3f0-2,V3f1-0,V3f1-1,V3f1-2,V3f2-0...]

Specified by:

setVector in interface VRMLNormalNodeType

Parameters:

newVector - The new value for vector

numValid - The number of valid values to copy from the array

Throws:

ArrayIndexOutOfBoundsException

getNumNormals

public int getNumNormals()

Get the number of items in the normal array now. The number returned is the total number of values in the flat array. This will allow the caller to construct the correct size array for the getVector() call.

Specified by:

getNumNormals in interface VRMLNormalNodeType

Returns:

The number of values in the array

getVector

public void getVector(float[] normals)

Get current value of field vector. Vector is an array of SFVec3f float triples. Don't call if there are no vectors in the array.

Specified by:

getVector in interface VRMLNormalNodeType

Parameters:

normals - The array to copy the vector values into

getVectorRef

public float[] getVectorRef()

Get the internal reference to the raw or converted array of normals. Some of the concrete node types end up needing to convert the point values from double precision to single precision or needing to make geo-spatial projections. This is a reference to the post-processed data that may be directly used for rendering.

Note that the array may well be longer than the actual number of valid normals. Use getNumNormals() to determine the number of valid entries.

Specified by:

getVectorRef in interface VRMLNormalNodeType

Returns:

An array of float[] values for rendering process

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.

getPrimaryType

public int getPrimaryType()

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

Specified by:

getPrimaryType in interface VRMLNode

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

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 AbstractNode

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,
 int numValid)
              throws InvalidFieldException

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