Package xj3d.filter

Class AppearanceFilter

java.lang.Object

xj3d.filter.AbstractFilter

xj3d.filter.BaseFilter

xj3d.filter.AppearanceFilter

All Implemented Interfaces:

BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class AppearanceFilter
extends BaseFilter

Search for Shape nodes which do not specify an Appearance node and add a default appearance or material to those nodes.

If -appAndMat is specified in the filter options, will add a Material node to the generated Appearance node.

The diffuse color for the Material node can be specified using -diffuse a b c, for example -diffuse 1.0 0.8 0.2 By default, a 0.8 0.8 0.8 value will be supplied (and the default value will be stripped from the output by the default output processor).

Version:

$Revision: 1.9 $

Author:

Eric Fickenscher (orig. Brad Vender)

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
AppearanceFilter()	Basic constructor.

Method Summary

Modifier and Type	Method	Description
void	endNode()	Notification of the end of a node declaration.
void	setArguments(String[] args)	Set the argument parameters to control the filter operation.
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.BaseFilter

componentDecl, endDocument, endExternProtoDecl, endField, 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, startDocument, 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

AppearanceFilter

public AppearanceFilter()

Basic constructor. Note that boolean 'addMaterial' is initially set to 'false', which means that we will NOT be adding any material. This boolean may be set to true by calling the setArguments() method, in which case we WILL add a Material node.

Method Details

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

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

endNode

public void endNode()
             throws SAVException,
VRMLException

Notification of the end of a node declaration. If boolean addMaterial is set to TRUE, then when a Shape node ends we reset materialAdded, so that future Shapes can also have Material nodes added if necessary.

Specified by:

endNode in interface ContentHandler

Overrides:

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

setArguments

public void setArguments(String[] args)

Set the argument parameters to control the filter operation. Note that the boolean 'addMaterial' will remain false unless this method is called and one of the argument parameters contains SET_APPEARANCE_AND_MATERIAL.

Overrides:

setArguments in class BaseFilter

Parameters:

args - The array of argument parameters.