Package xj3d.filter.filters

Class TriangulationFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.BaseFilter

xj3d.filter.filters.TriangulationFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class TriangulationFilter
extends BaseFilter

Generic triangulation filter that converts any geometry type it comes across to an indexed triangle form.

The output form is not always going to be an IndexedTriangleSet (though this could be implemented by way of argument flags in a later revision). The current implementation can process the following geometry types:

• Box
• Cone
• Cylinder
• Sphere
• ElevationGridGeometry
• ExtrusionGeometry
• IndexedFaceSetGeometry
• IndexedTriangleFanSetGeometry
• IndexedTriangleSetGeometry
• IndexedTriangleStripSetGeometry
• TriangleFanSetGeometry
• TriangleSetGeometry
• TriangleStripSetGeometry

The three basic indexed triangle nodes (Set, Strip, Fan) are passed through unchanged.

This filter will force an upgrade to X3D if VRML is detected. VRML Does not have the IndexedTriangle* nodes that are generated as output of this filter.

Version:

$Revision: 1.11 $

Author:

Justin Couch

Field Summary

Fields inherited from class xj3d.filter.BaseFilter

insideInvalidField, sceneMarker, suppressCalls

Fields inherited from class xj3d.filter.AbstractFilter

contentHandler, documentLocator, errorHandler, fieldHandler, fieldReader, fieldStack, lastErrorCode, majorVersion, minorVersion, nodeStack, parsingType, protoHandler, routeHandler, scriptHandler

Constructor Summary

Constructors

Constructor	Description
TriangulationFilter()	Create a new default filter for the conversion

Method Summary

Modifier and Type	Method	Description
void	endDocument()	Declaration of the end of the document.
void	endField()	Notification of the end of a field declaration.
void	endNode()	Notification of the end of a node declaration.
void	fieldValue(boolean value)	Set the value of the field at the given index as an boolean.
void	fieldValue(boolean[] value, int len)	Set the value of the field at the given index as an array of boolean.
void	fieldValue(double value)	Set the value of the field at the given index as an double.
void	fieldValue(double[] value, int len)	Set the value of the field at the given index as an array of doubles.
void	fieldValue(float value)	Set the value of the field at the given index as a float.
void	fieldValue(float[] value, int len)	Set the value of the field at the given index as an array of floats.
void	fieldValue(int value)	Set the value of the field at the given index as an integer.
void	fieldValue(int[] value, int len)	Set the value of the field at the given index as an array of integers.
void	fieldValue(long value)	Set the value of the field at the given index as an long.
void	fieldValue(long[] value, int len)	Set the value of the field at the given index as an array of longs.
void	fieldValue(String value)	The value of a normal field.
void	fieldValue(String[] values)	Set the value of the field at the given index as an array of strings.
void	fieldValue(String[] value, int len)	Set the value of the field at the given index as an array of strings.
void	routeDecl(String srcNodeName, String srcFieldName, String destNodeName, String destFieldName)	Notification of a ROUTE declaration in the file.
void	setArguments(String[] args)	Set the argument parameters to control the filter operation
void	startDocument(String uri, String url, String encoding, String type, String version, String comment)	Declaration of the start of the document.
void	startField(String name)	Notification of a field declaration.
void	startNode(String name, String defName)	Notification of the start of a node.
void	useDecl(String defName)	The field value is a USE for the given node name.

Methods inherited from class xj3d.filter.BaseFilter

componentDecl, endExternProtoDecl, endProtoBody, endProtoDecl, endScriptDecl, exportDecl, externProtoURI, getContentHandler, getErrorReporter, getLastErrorCode, getProtoHandler, getRouteHandler, getScriptHandler, importDecl, metaDecl, profileDecl, protoFieldDecl, protoIsDecl, scriptFieldDecl, setContentHandler, setDebug, setDocumentLocator, setErrorReporter, setProtoHandler, setRouteHandler, setScriptHandler, startExternProtoDecl, startProtoBody, startProtoDecl, startScriptDecl, suppressCalls

Methods inherited from class xj3d.filter.AbstractFilter

setParsingType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TriangulationFilter

public TriangulationFilter()

Create a new default filter for the conversion

Method Details

startDocument

public void startDocument(String uri,
 String url,
 String encoding,
 String type,
 String version,
 String comment)
                   throws SAVException,
VRMLException

Declaration of the start of the document. The parameters are all of the values that are declared on the header line of the file after the # start. The type string contains the representation of the first few characters of the file after the #. This allows us to work out if it is VRML97 or the later X3D spec.

Version numbers change from VRML97 to X3D and aren't logical. In the first, it is #VRML V2.0 and the second is #X3D V1.0 even though this second header represents a later spec.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class BaseFilter

Parameters:

uri - The URI of the file.

url - The base URL of the file for resolving relative URIs contained in the file

encoding - The encoding of this document - utf8 or binary

type - The bytes of the first part of the file header

version - The full VRML version string of this document

comment - Any trailing text on this line. If there is none, this is null.

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

endDocument

public void endDocument()
                 throws SAVException,
VRMLException

Declaration of the end of the document. There will be no further parsing and hence events after this.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class BaseFilter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

startNode

public void startNode(String name,
 String defName)
               throws SAVException,
VRMLException

Notification of the start of a node. This is the opening statement of a node and it's DEF name. USE declarations are handled in a separate method.

Specified by:

startNode in interface ContentHandler

Overrides:

startNode in class BaseFilter

Parameters:

name - The name of the node that we are about to parse

defName - The string associated with the DEF name. Null if not given for this node.

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

endNode

public void endNode()
             throws SAVException,
VRMLException

Notification of the end of a node declaration.

Specified by:

endNode in interface ContentHandler

Overrides:

endNode in class BaseFilter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

startField

public void startField(String name)
                throws SAVException,
VRMLException

Notification of a field declaration. This notification is only called if it is a standard node. If the node is a script or PROTO declaration then the ScriptHandler or ProtoHandler methods are used.

Specified by:

startField in interface ContentHandler

Overrides:

startField in class BaseFilter

Parameters:

name - The name of the field declared

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

useDecl

public void useDecl(String defName)
             throws SAVException,
VRMLException

The field value is a USE for the given node name. This is a terminating call for startField as well. The next call will either be another startField() or endNode().

Specified by:

useDecl in interface ContentHandler

Overrides:

useDecl in class BaseFilter

Parameters:

defName - The name of the DEF string to use

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

endField

public void endField()
              throws SAVException,
VRMLException

Notification of the end of a field declaration. This is called only at the end of an MFNode declaration. All other fields are terminated by either useDecl(String) or fieldValue(String). This will only ever be called if there have been nodes declared. If no nodes have been declared (ie "[]") then you will get a fieldValue(). call with the parameter value of null.

Specified by:

endField in interface ContentHandler

Overrides:

endField in class BaseFilter

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(String value)
                throws SAVException,
VRMLException

The value of a normal field. This is a string that represents the entire value of the field. MFStrings will have to be parsed. This is a terminating call for startField as well. The next call will either be another startField() or endNode().

If this field is an SFNode with a USE declaration you will have the useDecl(String) method called rather than this method. If the SFNode is empty the value returned here will be "NULL".

There are times where we have an MFField that is declared in the file to be empty. To signify this case, this method will be called with a parameter value of null. A lot of the time this is because we can't really determine if the incoming node is an MFNode or not.

Specified by:

fieldValue in interface BinaryContentHandler

Specified by:

fieldValue in interface StringContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The value of this field

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(String[] values)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of strings. This would be used to set MFString field types.

Specified by:

fieldValue in interface StringContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

values - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(int value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an integer. This would be used to set SFInt32 field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(int[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of integers. This would be used to set MFInt32 field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(boolean value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an boolean. This would be used to set SFBool field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(boolean[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of boolean. This would be used to set MFBool field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(float value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(float[] value,
 int len)
                throws SAVException,
VRMLException

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:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(long value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an long. This would be used to set SFTime field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(long[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of longs. This would be used to set MFTime field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(double value)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an double. This would be used to set SFDouble field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(double[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of doubles. This would be used to set MFDouble, SFVec2d and SFVec3d field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

public void fieldValue(String[] value,
 int len)
                throws SAVException,
VRMLException

Set the value of the field at the given index as an array of strings. This would be used to set MFString field types.

Specified by:

fieldValue in interface BinaryContentHandler

Overrides:

fieldValue in class BaseFilter

Parameters:

value - The new value to use for the node

len - The number of valid entries in the value array

Throws:

SAVException - This call is taken at the wrong time in the structure of the document.

VRMLException - This call is taken at the wrong time in the structure of the document.

routeDecl

public void routeDecl(String srcNodeName,
 String srcFieldName,
 String destNodeName,
 String destFieldName)
               throws SAVException,
VRMLException

Notification of a ROUTE declaration in the file. The context of this route should be assumed from the surrounding calls to start and end of proto and node bodies.

Specified by:

routeDecl in interface RouteHandler

Overrides:

routeDecl in class BaseFilter

Parameters:

srcNodeName - The name of the DEF of the source node

srcFieldName - The name of the field to route values from

destNodeName - The name of the DEF of the destination node

destFieldName - The name of the field to route values to

Throws:

SAVException - This call is taken at the wrong time in the structure of the document

VRMLException - The content provided is invalid for this part of the document or can't be parsed

setArguments

public void setArguments(String[] args)

Set the argument parameters to control the filter operation

Overrides:

setArguments in class BaseFilter

Parameters:

args - The array of argument parameters.