Package xj3d.filter.filters

Class IndexFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.BaseFilter

xj3d.filter.node.EncodedBaseFilter

xj3d.filter.filters.IndexFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class IndexFilter
extends EncodedBaseFilter

Filter for creating indexed versions of non-indexed geometry. This filter transforms TriangleSet, TriangleStripSet, TriangleFanSet and LineSet nodes to IndexedTriangleSet, IndexedTriangleStripSet, IndexedTriangleFanSet, and IndexedLineSet nodes respectively.

Version:

$Revision: 1.11 $

Author:

Rex Melton

Field Summary

Fields inherited from class xj3d.filter.node.EncodedBaseFilter

encMap, encodeNodes, encodeRoutes, encStack, factory, scene

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
IndexFilter()	Default Constructor

Method Summary

Modifier and Type	Method	Description
void	endDocument()	Declaration of the end of the document.
void	endNode()	Notification of the end of a node declaration.
void	startDocument(String uri, String url, String encoding, String type, String version, String comment)	Declaration of the start of the document.
void	startExternProtoDecl(String name)	Notification of the start of an EXTERNPROTO declaration of the given name.
void	startNode(String name, String defName)	Notification of the start of a node.
void	startProtoDecl(String name)	Notification of the start of an ordinary (inline) proto declaration.
void	useDecl(String defName)	The field value is a USE for the given node name.

Methods inherited from class xj3d.filter.node.EncodedBaseFilter

encode, endField, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, routeDecl, setDebug

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, setArguments, setContentHandler, setDocumentLocator, setErrorReporter, setProtoHandler, setRouteHandler, setScriptHandler, startField, startProtoBody, 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

IndexFilter

public IndexFilter()

Default Constructor

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 EncodedBaseFilter

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 VRML version 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 - The content provided is invalid for this part of the document or can't be parsed

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 EncodedBaseFilter

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

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 EncodedBaseFilter

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 EncodedBaseFilter

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 EncodedBaseFilter

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 - The content provided is invalid for this part of the document or can't be parsed

startProtoDecl

public void startProtoDecl(String name)
                    throws SAVException,
VRMLException

Notification of the start of an ordinary (inline) proto declaration. The proto has the given node name.

Specified by:

startProtoDecl in interface ProtoHandler

Overrides:

startProtoDecl in class BaseFilter

Parameters:

name - The name of the proto

Throws:

SAVException - Always thrown

VRMLException - Never thrown

startExternProtoDecl

public void startExternProtoDecl(String name)
                          throws SAVException,
VRMLException

Notification of the start of an EXTERNPROTO declaration of the given name. Between here and the matching BaseFilter.endExternProtoDecl() call you should only receive BaseFilter.protoFieldDecl(int, java.lang.String, java.lang.String, java.lang.Object) calls.

Specified by:

startExternProtoDecl in interface ProtoHandler

Overrides:

startExternProtoDecl in class BaseFilter

Parameters:

name - The node name of the extern proto

Throws:

SAVException - Always thrown

VRMLException - Never thrown