Package xj3d.filter.filters

Class ExplodeShapesFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.NewAbstractFilter

xj3d.filter.filters.ExplodeShapesFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class ExplodeShapesFilter
extends NewAbstractFilter

Explodes the shapes in a file to create a cad-like exploded view.

Assumes that the FlattenTransform filter is run before this and has squashed all the objects down to single shape nodes that are at the file root. Works on the coordinates of the geometry, not any explicit bbox definitions.

Filter Options

-explodeFactor - Factor to multiply the center vector to space out items -addDEFLabels - Add screen aligned labels of the DEF name?

Version:

$Revision: 1.3 $

Author:

Alan Hudson

Field Summary

Fields inherited from class xj3d.filter.NewAbstractFilter

fieldHasEndedImplicitly, parentTypeStack, 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
ExplodeShapesFilter()	Recenters the geometry

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	fieldValue(float[] value, int len)	Set the value of the field at the given index as an array of floats.
void	fieldValue(String value)	The value of a normal field.
void	fieldValue(String[] values)	The value of a field given as an array of strings.
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	startField(String name)	Notification of a field declaration.
void	startNode(String name, String defName)	Notification of the start of a node.

Methods inherited from class xj3d.filter.NewAbstractFilter

componentDecl, endExternProtoDecl, endField, endProtoBody, endProtoDecl, endScriptDecl, exportDecl, externProtoURI, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, getContentHandler, getErrorReporter, getLastErrorCode, getProtoHandler, getRouteHandler, getScriptHandler, importDecl, metaDecl, protoFieldDecl, protoIsDecl, routeDecl, scriptFieldDecl, setArguments, setContentHandler, setDebug, setDocumentLocator, setErrorReporter, setProtoHandler, setRouteHandler, setScriptHandler, startExternProtoDecl, 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

ExplodeShapesFilter

public ExplodeShapesFilter()

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 NewAbstractFilter

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.

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 NewAbstractFilter

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.

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 NewAbstractFilter

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 NewAbstractFilter

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 NewAbstractFilter

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

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 NewAbstractFilter

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

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 NewAbstractFilter.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 NewAbstractFilter

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

The value of a field given as an array of strings.

Specified by:

fieldValue in interface StringContentHandler

Overrides:

fieldValue in class NewAbstractFilter

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(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 NewAbstractFilter

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.