Package xj3d.filter.filters

Class CombineTransformFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.BaseFilter

xj3d.filter.node.EncodedBaseFilter

xj3d.filter.filters.CombineTransformFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class CombineTransformFilter
extends EncodedBaseFilter

Filter for combing transform hierarchies. The transformational components of the Transforms are combined and when possible the coordinates of the children nodes are transformed to retain the information. Will respect DEFed nodes to indicate that a node is to be used by ROUTING or SCRIPS. Run removeUnneededDEF to preprocess the file. Differs a fair bit from FlattenTransform. Might eventually combine them but right now not certain this filter is a superset of the other. This filter makes use of the MatrixTransform node that some X3D browsers have. If your target browser does not have that node then don't use this filter. Or send me a piece of code that can convert an arbitrary 4x4 matrix back into Transform fields.

Version:

$Revision: 1.18 $

Author:

Alan Hudson

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
CombineTransformFilter()	Create an instance of the filter.

Method Summary

Modifier and Type	Method	Description
void	endDocument()	Declaration of the end of the document.
void	profileDecl(String profileName)	A profile declaration has been found in the code.
void	startDocument(String uri, String url, String encoding, String type, String version, String comment)	Declaration of the start of the document.
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.node.EncodedBaseFilter

encode, endField, endNode, 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, protoFieldDecl, protoIsDecl, scriptFieldDecl, setArguments, setContentHandler, setDocumentLocator, setErrorReporter, setProtoHandler, setRouteHandler, setScriptHandler, startExternProtoDecl, startField, 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

CombineTransformFilter

public CombineTransformFilter()

Create an instance of the filter.

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

profileDecl

public void profileDecl(String profileName)
                 throws SAVException,
VRMLException

A profile declaration has been found in the code. IAW the X3D specification, this method will only ever be called once in the lifetime of the parser for this document. The name is the name of the profile for the document to use.

Specified by:

profileDecl in interface ContentHandler

Overrides:

profileDecl in class BaseFilter

Parameters:

profileName - The name of the profile 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.

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

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