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

Class BaseIndexedFaceSet

java.lang.Object

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

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

org.web3d.vrml.renderer.common.nodes.BaseIndexedGeometryNode

org.web3d.vrml.renderer.common.nodes.geom3d.BaseIndexedFaceSet

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLComponentGeometryNodeType, VRMLGeometryNodeType, VRMLNodeComponentListener, VRMLNodeType

Direct Known Subclasses:

NRIndexedFaceSet, OGLIndexedFaceSet

public abstract class BaseIndexedFaceSet
extends BaseIndexedGeometryNode

An abstract implementation of an IndexedFaceSet

Version:

$Revision: 1.28 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_CONVEX	Index of the convex field
protected static final int	FIELD_CREASEANGLE	Index of the crease angle field
protected org.j3d.geom.GeometryData	geomData	Userdata kept in the triangle geometry
protected boolean	vfConvex	field SFBool solid TRUE
protected float	vfCreaseAngle	field SFFloat creaseAngle 0

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

FIELD_COLORINDEX, FIELD_COORDINDEX, FIELD_NORMALINDEX, FIELD_SET_COLORINDEX, FIELD_SET_COORDINDEX, FIELD_SET_NORMALINDEX, FIELD_SET_TEXCOORDINDEX, FIELD_TEXCOORDINDEX, LAST_INDEXEDGEOMETRY_INDEX, NORMAL_NODE_MSG, NORMAL_PROTO_MSG, numColorIndex, numCoordIndex, numNormalIndex, numTexCoordIndex, TEXCOORD_NODE_MSG, TEXCOORD_PROTO_MSG, vfColorIndex, vfCoordIndex, vfNormalIndex, vfTexCoordIndex

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

Modifier	Constructor	Description
protected	BaseIndexedFaceSet()	Construct a default instance of this class with the bind flag set to false and no time information set (effective value of zero).
protected	BaseIndexedFaceSet(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.
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.
void	notifyExternProtoLoaded(int index, VRMLNodeType node)	Notify a node that an ExternProto has resolved.
void	setValue(int index, boolean value)	Set the value of the field at the given index as an boolean.
void	setValue(int index, float value)	Set the value of the field at the given index as an boolean.
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.BaseIndexedGeometryNode

copy, sendRoute, setColorIndex, setCoordIndex, setNormalIndex, setTexCoordIndex, setValue

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

addLocalColorsListener, addTexCoordGenModeChanged, fireLocalColorsChanged, getComponents, getNumSets, getPrimaryType, getTexCoordGenMode, hasColorPerVertex, hasLocalColorAlpha, hasLocalColors, hasNormalPerVertex, isCCW, isLightingEnabled, isSolid, removeLocalColorsListener, removeTexCoordGenModeChanged, requiresUnlitColor, setColorNode, setComponent, setComponents, setCoordinateNode, setFogCoordinateNode, setNormalNode, setTexCoordNode, setTextureCount, setUnlitColor, setupFinished

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

Field Details

FIELD_CREASEANGLE

protected static final int FIELD_CREASEANGLE

Index of the crease angle field

See Also:

• Constant Field Values

FIELD_CONVEX

protected static final int FIELD_CONVEX

Index of the convex field

See Also:

• Constant Field Values

vfConvex

protected boolean vfConvex

field SFBool solid TRUE

vfCreaseAngle

protected float vfCreaseAngle

field SFFloat creaseAngle 0

geomData

protected org.j3d.geom.GeometryData geomData

Userdata kept in the triangle geometry

Constructor Details

BaseIndexedFaceSet

protected BaseIndexedFaceSet()

Construct a default instance of this class with the bind flag set to false and no time information set (effective value of zero).

BaseIndexedFaceSet

protected BaseIndexedFaceSet(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

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 BaseIndexedGeometryNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

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.

fieldChanged

public void fieldChanged(VRMLNodeType node,
 int index)

Notification that the field from the node has changed.

Parameters:

node - The component node that changed

index - The index of the field that has changed

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

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 BaseComponentGeometryNode

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 out of range for the field type.

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an boolean. This would be used to set SFFloat 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 out of range for the field type.

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 BaseComponentGeometryNode

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.