Package xj3d.filter.filters

Class WorldOffsetFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.BaseFilter

xj3d.filter.filters.WorldOffsetFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class WorldOffsetFilter
extends BaseFilter

Takes the contents of the entire file and offsets it by the given argument amount by placing a TransformGroup at the root of the scene graph that encapsulates the entire world.

Filter Options

worldOffset x y z The amount to shift in each direction.

worldScale x y z The amount to scale in each direction.

Version:

$Revision: 1.5 $

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
WorldOffsetFilter()	Recenters the geometry

Method Summary

Modifier and Type	Method	Description
void	endDocument()	Declaration of the end of the document.
void	setArguments(String[] arg)	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	startNode(String name, String defName)	Notification of the start of a node.

Methods inherited from class xj3d.filter.BaseFilter

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

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

WorldOffsetFilter

public WorldOffsetFilter()

Recenters the geometry

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

setArguments

public void setArguments(String[] arg)

Set the argument parameters to control the filter operation

Overrides:

setArguments in class BaseFilter

Parameters:

arg - The array of argument parameters.