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

Class BaseNurbsCurve2D

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.nurbs.BaseNurbsCurve2D

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLGeometryNodeType, VRMLNodeType, VRMLParametricGeometryNodeType

Direct Known Subclasses:

OGLNurbsCurve2D

public abstract class BaseNurbsCurve2D
extends AbstractNode
implements VRMLParametricGeometryNodeType

Common base implementation of the NurbsCurve node.

Because NURBS implementations involve complex retessellation, the implementation will automatically register itself with the frame state manager whenever any field changes.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_CLOSED
protected static final int	FIELD_CONTROL_POINT	Field index for controlPoint
protected static final int	FIELD_KNOT	Field index for controlPoint
protected static final int	FIELD_ORDER	Field index for controlPoint
protected static final int	FIELD_TESSELLATION	Field index for controlPoint
protected static final int	FIELD_WEIGHT	Field index for controlPoint
protected static final int	LAST_CURVE_INDEX	The last index in this node
protected static final int	NUM_FIELDS	Number of fields constant
protected boolean	vfClosed	The value of the closed field
protected double[]	vfControlPoint	The value of the controlPoint field
protected double[]	vfKnot	The value of the knot field
protected int	vfOrder	The value of the order field
protected int	vfTessellation	The value of the tessellation field
protected double[]	vfWeight	The value of the weight field

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	BaseNurbsCurve2D()	Create a new default instance of the node.
	BaseNurbsCurve2D(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	addLocalColorsListener(LocalColorsListener l)	Add a listener for local color changes.
void	addTexCoordGenModeChanged(TexCoordGenModeListener l)	Add a listener for texture coordinate generation mode changes.
protected net.jgeom.nurbs.BasicNurbsCurve	getCurveImpl()	Return a BasicNurbsCurve which is initialized to the current spline parameters -- degree, knots, and control points/weights.
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	getNumSets()	Get the number of texture coordinate sets contained by this node
int	getPrimaryType()	Get the primary type of this node.
String	getTexCoordGenMode(int setNum)	Get the texture coordinate generation mode.
boolean	hasLocalColorAlpha()	Specified whether this node has alpha values in the local colour information.
boolean	hasLocalColors()	Specified whether this node has color information.
boolean	isCCW()	Get the value of the CCW field.
boolean	isLightingEnabled()	Specifies whether this node requires lighting.
boolean	isSolid()	Get the value of the solid field.
protected boolean	regenerateCurve()	Request to regenerate the curve data now.
void	removeLocalColorsListener(LocalColorsListener l)	Remove a listener for local color changes.
void	removeTexCoordGenModeChanged(TexCoordGenModeListener l)	Remove a listener for texture coordinate generation mode changes.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setTextureCount(int count)	Set the number of textures that were found on the accompanying Appearance node.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, boolean value)	Set the value of the field at the given index as an boolean.
void	setValue(int index, double[] value, int numValid)	Set the value of the field at the given index as an array of doubles.
void	setValue(int index, int value)	Set the value of the field at the given index as an int.

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

Field Details

FIELD_CONTROL_POINT

protected static final int FIELD_CONTROL_POINT

Field index for controlPoint

See Also:

• Constant Field Values

FIELD_TESSELLATION

protected static final int FIELD_TESSELLATION

Field index for controlPoint

See Also:

• Constant Field Values

FIELD_WEIGHT

protected static final int FIELD_WEIGHT

Field index for controlPoint

See Also:

• Constant Field Values

FIELD_KNOT

protected static final int FIELD_KNOT

Field index for controlPoint

See Also:

• Constant Field Values

FIELD_ORDER

protected static final int FIELD_ORDER

Field index for controlPoint

See Also:

• Constant Field Values

FIELD_CLOSED

protected static final int FIELD_CLOSED

See Also:

• Constant Field Values

LAST_CURVE_INDEX

protected static final int LAST_CURVE_INDEX

The last index in this node

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfTessellation

protected int vfTessellation

The value of the tessellation field

vfControlPoint

protected double[] vfControlPoint

The value of the controlPoint field

vfWeight

protected double[] vfWeight

The value of the weight field

vfKnot

protected double[] vfKnot

The value of the knot field

vfOrder

protected int vfOrder

The value of the order field

vfClosed

protected boolean vfClosed

The value of the closed field

Constructor Details

BaseNurbsCurve2D

protected BaseNurbsCurve2D()

Create a new default instance of the node.

BaseNurbsCurve2D

public BaseNurbsCurve2D(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a Box node, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

hasLocalColors

public boolean hasLocalColors()

Specified whether this node has color information. If so, then it will be used for diffuse terms instead of materials.

Specified by:

hasLocalColors in interface VRMLGeometryNodeType

Returns:

true Use local color information for diffuse lighting.

hasLocalColorAlpha

public boolean hasLocalColorAlpha()

Specified whether this node has alpha values in the local colour information. If so, then it will be used for to override the material's transparency value.

Specified by:

hasLocalColorAlpha in interface VRMLGeometryNodeType

Returns:

true when the local color value has inbuilt alpha

addLocalColorsListener

public void addLocalColorsListener(LocalColorsListener l)

Add a listener for local color changes. Nulls and duplicates will be ignored.

Specified by:

addLocalColorsListener in interface VRMLGeometryNodeType

Parameters:

l - The listener.

removeLocalColorsListener

public void removeLocalColorsListener(LocalColorsListener l)

Remove a listener for local color changes. Nulls will be ignored.

Specified by:

removeLocalColorsListener in interface VRMLGeometryNodeType

Parameters:

l - The listener.

addTexCoordGenModeChanged

public void addTexCoordGenModeChanged(TexCoordGenModeListener l)

Add a listener for texture coordinate generation mode changes. Nulls and duplicates will be ignored.

Specified by:

addTexCoordGenModeChanged in interface VRMLGeometryNodeType

Parameters:

l - The listener.

removeTexCoordGenModeChanged

public void removeTexCoordGenModeChanged(TexCoordGenModeListener l)

Remove a listener for texture coordinate generation mode changes. Nulls will be ignored.

Specified by:

removeTexCoordGenModeChanged in interface VRMLGeometryNodeType

Parameters:

l - The listener.

getTexCoordGenMode

public String getTexCoordGenMode(int setNum)

Get the texture coordinate generation mode. NULL is returned if the texture coordinates are not generated.

Specified by:

getTexCoordGenMode in interface VRMLGeometryNodeType

Parameters:

setNum - The set which this tex gen mode refers

Returns:

The mode or NULL

setTextureCount

public void setTextureCount(int count)

Set the number of textures that were found on the accompanying Appearance node. Used to set the number of texture coordinates that need to be passed in to the renderer when no explicit texture coordinates were given. * @param count The number of texture coordinate sets to add

Specified by:

setTextureCount in interface VRMLGeometryNodeType

Parameters:

count - The number of texture coordinate sets to add

getNumSets

public int getNumSets()

Get the number of texture coordinate sets contained by this node

Specified by:

getNumSets in interface VRMLGeometryNodeType

Returns:

the number of texture coordinate sets

isSolid

public boolean isSolid()

Get the value of the solid field.

Specified by:

isSolid in interface VRMLGeometryNodeType

Returns:

true This object is solid (ie single sided)

isCCW

public boolean isCCW()

Get the value of the CCW field. If the node does not have one, this will return true.

Specified by:

isCCW in interface VRMLGeometryNodeType

Returns:

true if the vertices are CCW ordered

isLightingEnabled

public boolean isLightingEnabled()

Specifies whether this node requires lighting.

Specified by:

isLightingEnabled in interface VRMLGeometryNodeType

Returns:

Should lighting be enabled

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

Set the value of the field at the given index as an int. 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 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,
 boolean value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an boolean. This would be used to set SFBool 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 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 doubles. This would be used to set MFDouble 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

setupFinished

public void setupFinished()

Description copied from interface: VRMLNodeType

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. It is then responsible for calling its children's setupFinished.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

regenerateCurve

protected boolean regenerateCurve()

Request to regenerate the curve data now. The regenerated data will end up in the geometryData object. If some ofthe data is invalid, then the generation will create a curve with zero points in it and return false.

Returns:

true The generation succeeded

getCurveImpl

protected net.jgeom.nurbs.BasicNurbsCurve getCurveImpl()

Return a BasicNurbsCurve which is initialized to the current spline parameters -- degree, knots, and control points/weights.

Returns:

NurbsCurve implementation instance