Package xj3d.filter

Class ModifyViewpointFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.ModifyViewpointFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class ModifyViewpointFilter
extends AbstractFilter

A filter which changes the position and orientation of a viewpoint.

Version:

$Revision: 1.5 $

Author:

Rex Melton

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
ModifyViewpointFilter()	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	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	setArguments(String[] arg)	Parse and validate the argument parameters.
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.AbstractFilter

componentDecl, endExternProtoDecl, endField, endProtoBody, endProtoDecl, endScriptDecl, exportDecl, externProtoURI, 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, setDocumentLocator, setErrorReporter, setParsingType, setProtoHandler, setRouteHandler, setScriptHandler, startDocument, startExternProtoDecl, startProtoBody, startProtoDecl, startScriptDecl, useDecl

Methods inherited from class java.lang.Object

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

Constructor Details

ModifyViewpointFilter

public ModifyViewpointFilter()

Default Constructor

Method Details

setArguments

public void setArguments(String[] arg)

Parse and validate the argument parameters.

Overrides:

setArguments in class AbstractFilter

Parameters:

arg - The array of argument parameters.

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

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.

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