Package org.web3d.vrml.export

Class X3DClassicRetainedExporter

java.lang.Object

org.web3d.vrml.export.Exporter

org.web3d.vrml.export.BaseRetainedExporter

org.web3d.vrml.export.X3DClassicRetainedExporter

All Implemented Interfaces:

SceneGraphTraversalSimpleObserver, BinaryContentHandler, ContentHandler, ProtoHandler, RouteHandler, ScriptHandler, StringContentHandler

public class X3DClassicRetainedExporter
extends BaseRetainedExporter
implements SceneGraphTraversalSimpleObserver

X3D Classic exporter using a retained Scenegraph.

Known Issues: Proto node fields are copied into instances

Version:

$Revision: 1.25 $

Author:

Alan Hudson

Field Summary

Fields inherited from class org.web3d.vrml.export.BaseRetainedExporter

builder, componentList, CONTAINER_PROPS_FILE, containerFields, convertOldContent, currentConnection, currentDefMap, currentIsMap, currentPrototypeDecl, defaultNode, defaultNodes, encodingTo, epToUrl, fieldReader, fieldRemap, geospatialFound, geospatialNodes, hanimFound, hanimNodes, isCache, nodeFactory, oldProtos, oStream, p, processingDocument, profile, protoCreator, scene, scriptPatterns, scriptReplacements, sigDigits, startTime, stripWhitespace, upgrading

Fields inherited from class org.web3d.vrml.export.Exporter

errorReporter, lastErrorCode, majorVersion, minorVersion

Constructor Summary

Constructors

Constructor	Description
X3DClassicRetainedExporter(OutputStream os, int major, int minor, org.j3d.util.ErrorReporter errorReporter)	Create a new exporter for the given spec version
X3DClassicRetainedExporter(OutputStream os, int major, int minor, org.j3d.util.ErrorReporter errorReporter, int sigDigits)	Create a new exporter for the given spec version

Method Summary

Modifier and Type	Method	Description
void	endDocument()	Declaration of the end of the document.
void	observedNode(VRMLNodeType parent, VRMLNodeType child, int field, boolean used)	Notification of a child node.
void	printComponents(ComponentInfo[] comps)	Print the component decl
void	printEndNode(VRMLNodeType node)	Print the end of a node.
void	printExporterInfo()	Print identifying information about this exporter
void	printExports(Map<String,String> exports)	Print Exports.
void	printExternalPrototypeDecl(CRExternPrototypeDecl proto)	Print an external proto declaration.
void	printHeader(int major, int minor)	Print the header.
void	printImports(Map<String,VRMLNode> imports)	Print Imports.
void	printMetaData(Map<String,String> meta)	Print the MetaData.
void	printProfile(String profile)	Print the profile decl.
void	printPrototypeDecl(PrototypeDecl proto)	Print a proto declaration.
void	printROUTE(ROUTE route, Map<VRMLNode,String> defMap)	Print a ROUTE statement.
void	printStartNode(VRMLNodeType node, boolean use, Map<VRMLNode,String> defMap, Map<Integer,List<ProtoFieldInfo>> isMap)	Print the start of a node, and all its non node fields.
void	printStartScriptNode(AbstractDynamicFieldNode node, boolean use, Map<VRMLNode,String> defMap, Map<Integer,List<ProtoFieldInfo>> isMap)	Print the start of a node, and all its non node fields.
void	traverse(VRMLNode source, boolean ignoreFirst)	Print a node and its children.
void	writeScene(VRMLScene scene)	Write a scene out.

Methods inherited from class org.web3d.vrml.export.BaseRetainedExporter

componentDecl, convertFieldData, endExternProtoDecl, endField, endNode, endProtoBody, endProtoDecl, endScriptDecl, exportDecl, externProtoURI, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, fieldValue, findIS, getPublicId, getSystemId, importDecl, loadContainerProperties, metaDecl, printDefMap, printIS, profileDecl, protoFieldDecl, protoIsDecl, reverseMap, routeDecl, scriptFieldDecl, setConvertOldContent, setDocumentLocator, startDocument, startExternProtoDecl, startField, startNode, startProtoBody, startProtoDecl, startScriptDecl, useDecl

Methods inherited from class org.web3d.vrml.export.Exporter

getLastErrorCode

Methods inherited from class java.lang.Object

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

Constructor Details

X3DClassicRetainedExporter

public X3DClassicRetainedExporter(OutputStream os,
 int major,
 int minor,
 org.j3d.util.ErrorReporter errorReporter)

Create a new exporter for the given spec version

Parameters:

os - The stream to export the code to

major - The major version number of this scene

minor - The minor version number of this scene

errorReporter - The error reporter to use

X3DClassicRetainedExporter

public X3DClassicRetainedExporter(OutputStream os,
 int major,
 int minor,
 org.j3d.util.ErrorReporter errorReporter,
 int sigDigits)

Create a new exporter for the given spec version

Parameters:

os - The stream to export the code to

major - The major version number of this scene

minor - The minor version number of this scene

errorReporter - The error reporter to use

sigDigits - The number of significant digits to use in printing floats

Method Details

writeScene

public void writeScene(VRMLScene scene)

Write a scene out.

Parameters:

scene - The scene to write

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 BaseRetainedExporter

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.

printHeader

public void printHeader(int major,
 int minor)

Print the header.

Specified by:

printHeader in class BaseRetainedExporter

Parameters:

major - The major version

minor - The minor version

printExporterInfo

public void printExporterInfo()

Description copied from class: BaseRetainedExporter

Print identifying information about this exporter

Specified by:

printExporterInfo in class BaseRetainedExporter

printProfile

public void printProfile(String profile)

Print the profile decl.

Specified by:

printProfile in class BaseRetainedExporter

Parameters:

profile - The profile

printComponents

public void printComponents(ComponentInfo[] comps)

Print the component decl

Specified by:

printComponents in class BaseRetainedExporter

Parameters:

comps - The component list

printMetaData

public void printMetaData(Map<String,String> meta)

Print the MetaData.

Specified by:

printMetaData in class BaseRetainedExporter

Parameters:

meta - The scene Metadata map

printROUTE

public void printROUTE(ROUTE route,
 Map<VRMLNode,String> defMap)

Print a ROUTE statement.

Specified by:

printROUTE in class BaseRetainedExporter

Parameters:

route - The ROUTE to print

defMap - The DEF map

printExports

public void printExports(Map<String,String> exports)

Print Exports.

Specified by:

printExports in class BaseRetainedExporter

Parameters:

exports - A map of exports(name,AS).

printImports

public void printImports(Map<String,VRMLNode> imports)

Print Imports.

Specified by:

printImports in class BaseRetainedExporter

Parameters:

imports - A map of imports(exported, String[] {def, as}.

traverse

public void traverse(VRMLNode source,
 boolean ignoreFirst)

Print a node and its children.

Parameters:

source - The root node

ignoreFirst - Should we ignore the first node. Used for WorldRoot and ProtoBody

printStartScriptNode

public void printStartScriptNode(AbstractDynamicFieldNode node,
 boolean use,
 Map<VRMLNode,String> defMap,
 Map<Integer,List<ProtoFieldInfo>> isMap)

Print the start of a node, and all its non node fields.

Parameters:

node - The node to print

use - Is it a USE

defMap - The current mapping of nodes to DEF names

isMap - The current mapping of fields to IS names

printStartNode

public void printStartNode(VRMLNodeType node,
 boolean use,
 Map<VRMLNode,String> defMap,
 Map<Integer,List<ProtoFieldInfo>> isMap)

Print the start of a node, and all its non node fields.

Parameters:

node - The node to print

use - Is it a USE

defMap - The current mapping of nodes to DEF names

isMap - The current mapping of fields to IS names

printEndNode

public void printEndNode(VRMLNodeType node)

Print the end of a node.

Parameters:

node - The node

observedNode

public void observedNode(VRMLNodeType parent,
 VRMLNodeType child,
 int field,
 boolean used)

Notification of a child node.

Specified by:

observedNode in interface SceneGraphTraversalSimpleObserver

Parameters:

parent - The parent node of this node

child - The child node that is being observed

field - The index of the child field in its parent node

used - true if the node reference is actually a USE

printPrototypeDecl

public void printPrototypeDecl(PrototypeDecl proto)

Print a proto declaration.

Specified by:

printPrototypeDecl in class BaseRetainedExporter

Parameters:

proto - The decl to print

printExternalPrototypeDecl

public void printExternalPrototypeDecl(CRExternPrototypeDecl proto)

Print an external proto declaration.

Parameters:

proto - The decl to print