Package xj3d.filter.filters

Class ITSCreaseAnglerFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.filters.ITSCreaseAnglerFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class ITSCreaseAnglerFilter
extends AbstractFilter

Takes an IndexedTriangleSet and a creaseAngle parameter and outputs a geometry that accounts for the creaseAngle. Valid output with be either another IndexedTriangleSet or a TriangleSet. Preference will be given to an IndexedTriangleSet for speed purposes. All faces who's geometric normal is less then the creaseAngle will be calculated so that the faces are shaded smoothly across the edge; otherwise, normals shall be calculated so that a lighting discontinuity across the edge is produced. Input normals are ignored.

Version:

$Revision: 1.2 $

Author:

Alan Hudson

Field Summary

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

Method Summary

Modifier and Type	Method	Description
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(float[] value, int len)	Set the value of the field at the given index as an array of floats.
void	fieldValue(int[] value, int len)	Set the value of the field at the given index as an array of integers.
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	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	startExternProtoDecl(String name)	Notification of the start of an EXTERNPROTO declaration of the given name.
void	startField(String name)	Notification of a field declaration.
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.AbstractFilter

componentDecl, endDocument, endExternProtoDecl, endProtoBody, endProtoDecl, endScriptDecl, exportDecl, externProtoURI, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, getContentHandler, getErrorReporter, getLastErrorCode, getProtoHandler, getRouteHandler, getScriptHandler, importDecl, metaDecl, profileDecl, protoFieldDecl, protoIsDecl, routeDecl, scriptFieldDecl, setContentHandler, setDocumentLocator, setErrorReporter, setParsingType, setProtoHandler, setRouteHandler, setScriptHandler, startProtoBody, startScriptDecl

Methods inherited from class java.lang.Object

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

Constructor Details

ITSCreaseAnglerFilter

public ITSCreaseAnglerFilter()

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 AbstractFilter

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

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 AbstractFilter

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 AbstractFilter

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 AbstractFilter

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 AbstractFilter

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

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 AbstractFilter

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.

Specified by:

fieldValue in interface BinaryContentHandler

Specified by:

fieldValue in interface StringContentHandler

Overrides:

fieldValue in class AbstractFilter

Parameters:

value - The value of this field

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[] 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 AbstractFilter

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,
 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 AbstractFilter

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 AbstractFilter

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 AbstractFilter

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.

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 AbstractFilter

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 AbstractFilter.endExternProtoDecl() call you should only receive AbstractFilter.protoFieldDecl(int, java.lang.String, java.lang.String, java.lang.Object) calls.

Specified by:

startExternProtoDecl in interface ProtoHandler

Overrides:

startExternProtoDecl in class AbstractFilter

Parameters:

name - The node name of the extern proto

Throws:

SAVException - Always thrown

VRMLException - Never thrown

setArguments

public void setArguments(String[] arg)

Set the argument parameters to control the filter operation

Overrides:

setArguments in class AbstractFilter

Parameters:

arg - The array of argument parameters.