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

Class OGLLineSet

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseComponentGeometryNode

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

org.web3d.vrml.renderer.ogl.nodes.render.OGLLineSet

All Implemented Interfaces:

org.j3d.aviatrix3d.NodeUpdateListener, VRMLNode, FrameStateListener, VRMLComponentGeometryNodeType, VRMLGeometryNodeType, VRMLNodeComponentListener, VRMLNodeType, OGLGeometryNodeType, OGLVRMLNode

public class OGLLineSet
extends BaseLineSet
implements OGLGeometryNodeType, org.j3d.aviatrix3d.NodeUpdateListener

OpenGL implementation of an LineSet.

The point set directly maps to Aviatrix3D's LineArray class. When the coordinates change to a different length than the current set, it will notify the geometry listener to fetch the new information.

If the VRML file did not provide a Coordinate node, then this class will not present any geometry from the getGeometry() or getSceneGraphObject() calls. If the user later specifies the renderety through an event, the listener(s) will be notified.

In this implementation, if the length of the color array is shorter that the length of the coordinate array, colors will be ignored.

Version:

$Revision: 1.13 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.render.BaseLineSet

FIELD_VERTEXCOUNT, numVertexCount, vfVertexCount

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

ATTRIB_CHANGED, ATTRIB_INDEX_CHANGED, ATTRIB_NODE_MSG, ATTRIB_PROTO_MSG, BAD_NODE_MSG, BAD_PROTO_MSG, changeFlags, COLOR_NODE_MSG, COLOR_PROTO_MSG, COLORS_CHANGED, COLORS_INDEX_CHANGED, COORD_NODE_MSG, COORD_PROTO_MSG, COORDS_CHANGED, COORDS_INDEX_CHANGED, FIELD_ATTRIBS, FIELD_CCW, FIELD_COLOR, FIELD_COLORPERVERTEX, FIELD_COORD, FIELD_FOG_COORD, FIELD_NORMAL, FIELD_NORMALPERVERTEX, FIELD_SOLID, FIELD_TEXCOORD, FOG_CHANGED, FOG_INDEX_CHANGED, FOG_NODE_MSG, FOG_PROTO_MSG, LAST_GEOMETRY_INDEX, localColors, localColorsListeners, NORMALS_CHANGED, NORMALS_INDEX_CHANGED, pColor, pCoord, pFogCoord, pNormal, pTexCoord, TEXCOORDS_CHANGED, TEXCOORDS_INDEX_CHANGED, UNLIT_COLORS_CHANGED, VBO_MIN_VERTICES, vfAttribs, vfCcw, vfColor, vfColorPerVertex, vfCoord, vfFogCoord, vfNormal, vfNormalPerVertex, vfSolid, vfTexCoord

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
OGLLineSet()	Construct a new point set instance that contains no child nodes.
OGLLineSet(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	fieldChanged(VRMLNodeType node, int index)	Notification that the field from the node has changed.
org.j3d.aviatrix3d.Geometry	getGeometry()	Returns a OGL Geometry node that represents this piece of geometry.
int	getNumSets()	Get the number of texture coordinate sets contained by this node
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the Java3D scene graph object representation of this node.
String	getTexCoordGenMode(int setNum)	Get the texture coordinate generation mode.
void	notifyExternProtoLoaded(int index, VRMLNodeType node)	Notify a node that an ExternProto has resolved.
boolean	requiresUnlitColor()	Check to see if this geometry implementation type requires unlit color values to be set.
protected void	setColorNode(VRMLColorNodeType node)	Notification of the color node being set.
protected void	setCoordinateNode(VRMLCoordinateNodeType node)	Notification of the coordinate node being set.
void	setUnlitColor(float[] color)	Set the local colour override for this geometry.
void	setupFinished()	Notification that the construction phase of this node has finished.
protected void	setVertexCount(int[] counts, int numValid)	Set the value of the vertexCount field.
void	updateNodeBoundsChanges(Object src)	Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.
void	updateNodeDataChanges(Object src)	Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.render.BaseLineSet

getFieldDeclaration, getFieldIndex, getFieldValue, getNodeFieldIndices, getNumFields, isLightingEnabled, sendRoute, setValue

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

addLocalColorsListener, addTexCoordGenModeChanged, copy, fireLocalColorsChanged, getComponents, getPrimaryType, hasColorPerVertex, hasLocalColorAlpha, hasLocalColors, hasNormalPerVertex, isCCW, isSolid, removeLocalColorsListener, removeTexCoordGenModeChanged, setComponent, setComponents, setFogCoordinateNode, setNormalNode, setTexCoordNode, setTextureCount, setValue, setValue

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

addLocalColorsListener, addTexCoordGenModeChanged, hasLocalColorAlpha, hasLocalColors, isCCW, isLightingEnabled, isSolid, removeLocalColorsListener, removeTexCoordGenModeChanged, setTextureCount

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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

addNodeListener, clearRemovedLayerIds, getFieldValue, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Constructor Details

OGLLineSet

public OGLLineSet()

Construct a new point set instance that contains no child nodes.

OGLLineSet

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

getGeometry

public org.j3d.aviatrix3d.Geometry getGeometry()

Description copied from interface: OGLGeometryNodeType

Returns a OGL Geometry node that represents this piece of geometry. If no geometry is available, then return null.

Specified by:

getGeometry in interface OGLGeometryNodeType

Returns:

The geometry needed to represent this object

getNumSets

public int getNumSets()

Get the number of texture coordinate sets contained by this node

Specified by:

getNumSets in interface VRMLGeometryNodeType

Overrides:

getNumSets in class BaseComponentGeometryNode

Returns:

the number of texture coordinate sets

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

Overrides:

getTexCoordGenMode in class BaseComponentGeometryNode

Parameters:

setNum - The set which this tex gen mode refers

Returns:

The mode or NULL

requiresUnlitColor

public boolean requiresUnlitColor()

Check to see if this geometry implementation type requires unlit color values to be set. For the most part this will always return false, but some will need it (points and lines). This value should be constant for the geometry regardless of whether a Color component has been provided or not. It is up to the implementation to decide when to pass these values on to the underlying rendering structures or not.

The default implementation returns false. Override if different behaviour is needed.

Specified by:

requiresUnlitColor in interface VRMLComponentGeometryNodeType

Overrides:

requiresUnlitColor in class BaseComponentGeometryNode

Returns:

true if we need unlit colour information

setUnlitColor

public void setUnlitColor(float[] color)

Set the local colour override for this geometry. Typically used to set the emissiveColor from the Material node into the geometry for the line and point-type geometries which are unlit in the X3D/VRML model.

The default implementation does nothing. Override to do something useful.

Specified by:

setUnlitColor in interface VRMLComponentGeometryNodeType

Overrides:

setUnlitColor in class BaseComponentGeometryNode

Parameters:

color - The colour value to use

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the Java3D scene graph object representation of this node. This will need to be cast to the appropriate parent type when being used.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The OGL representation.

notifyExternProtoLoaded

public void notifyExternProtoLoaded(int index,
 VRMLNodeType node)
                             throws InvalidFieldValueException

Description copied from interface: VRMLNodeType

Notify a node that an ExternProto has resolved. This will verify the objects type and add it to the render sceneGraph.

Specified by:

notifyExternProtoLoaded in interface VRMLNodeType

Overrides:

notifyExternProtoLoaded in class AbstractNode

Parameters:

index - The field index

node - The node resolved

Throws:

InvalidFieldValueException - If the proto contains he wrong type

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 BaseComponentGeometryNode

fieldChanged

public void fieldChanged(VRMLNodeType node,
 int index)

Notification that the field from the node has changed.

Specified by:

fieldChanged in interface VRMLNodeComponentListener

Parameters:

node - The component node that changed

index - The index of the field that has changed

setCoordinateNode

protected void setCoordinateNode(VRMLCoordinateNodeType node)

Notification of the coordinate node being set. If the passed value is null then that clears the node. The node passed is the actual geometry, not any proto wrapper, that will have been previously stripped. The default implementation does nothing.

Overrides:

setCoordinateNode in class BaseComponentGeometryNode

Parameters:

node - The node to use

setColorNode

protected void setColorNode(VRMLColorNodeType node)

Notification of the color node being set. If the passed value is null then that clears the node. The node passed is the actual color, not any proto wrapper, that will have been previously stripped. The default implementation does nothing. TODO determine if RGBA

Overrides:

setColorNode in class BaseComponentGeometryNode

Parameters:

node - The node to use

updateNodeBoundsChanges

public void updateNodeBoundsChanges(Object src)

Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.

Specified by:

updateNodeBoundsChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

updateNodeDataChanges

public void updateNodeDataChanges(Object src)

Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Specified by:

updateNodeDataChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

setVertexCount

protected void setVertexCount(int[] counts,
 int numValid)
                       throws InvalidFieldValueException

Set the value of the vertexCount field.

Overrides:

setVertexCount in class BaseLineSet

Parameters:

counts - The list of counts provided

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

Throws:

InvalidFieldValueException - One or more values were < 2