Package org.web3d.vrml.nodes.proto
Class ProtoBuilder
java.lang.Object
org.web3d.vrml.nodes.proto.ProtoBuilder
- All Implemented Interfaces:
BinaryContentHandler,ContentHandler,ProtoHandler,RouteHandler,ScriptHandler,StringContentHandler
public class ProtoBuilder
extends Object
implements StringContentHandler, BinaryContentHandler, ProtoHandler, ScriptHandler, RouteHandler
A SAV interface for dealing with building a single proto.
The builder is designed to create a single proto. However, that single proto may well have nested protos as part of it, so we must deal with that too.
The proto must be locally resident in this file, not an externproto.
- Version:
- $Revision: 1.63 $
- Author:
- Justin Couch
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a new default instance of the scene builder. -
Method Summary
Modifier and TypeMethodDescriptionvoidcomponentDecl(String componentInfo) A component declaration has been found in the code.voidDeclaration of the end of the document.voidNotification of the end of an EXTERNPROTO declaration.voidendField()Notification of the end of a field declaration.voidendNode()Notification of the end of a node declaration.voidNotification of the end of an ordinary proto body.voidNotification of the end of an ordinary proto declaration statement.voidNotification of the end of a script declaration.voidexportDecl(String defName, String exported) An EXPORT declaration has been found in the document.voidexternProtoURI(String[] values) Notification of the URI list for an EXTERNPROTO.voidfieldValue(boolean value) Set the value of the field at the given index as an boolean.voidfieldValue(boolean[] value, int len) Set the value of the field at the given index as an array of boolean.voidfieldValue(double value) Set the value of the field at the given index as an double.voidfieldValue(double[] value, int len) Set the value of the field at the given index as an array of doubles.voidfieldValue(float value) Set the value of the field at the given index as a float.voidfieldValue(float[] value, int len) Set the value of the field at the given index as an array of floats.voidfieldValue(int value) Set the value of the field at the given index as an integer.voidfieldValue(int[] value, int len) Set the value of the field at the given index as an array of integers.voidfieldValue(long value) Set the value of the field at the given index as an long.voidfieldValue(long[] value, int len) Set the value of the field at the given index as an array of longs.voidfieldValue(String value) The value of a normal field.voidfieldValue(String[] values) The value of an MFField where the underlying parser knows about how the values are broken up.voidfieldValue(String[] value, int len) Set the value of the field at the given index as an array of strings.Get the scene that was last built by this scene handler.voidimportDecl(String inline, String exported, String imported) An IMPORT declaration has been found in the document.voidA META declaration has been found in the code.voidnewProto(NodeTemplateToInstanceCreator creator) Start a new proto definition within the current document context.voidprofileDecl(String profileName) A profile declaration has been found in the code.voidprotoFieldDecl(int access, String type, String name, Object value) Notification of a proto's field declaration.voidprotoIsDecl(String fieldName) Notification of a field value uses an IS statement.voidreset()Reset the builder.voidNotification of a ROUTE declaration in the file.voidscriptFieldDecl(int access, String type, String name, Object value) Notification of a script's field declaration.voidSet the document locator that can be used by the implementing code to find out information about the current line information.voidsetErrorReporter(org.j3d.util.ErrorReporter reporter) Set the error handler instance used by this instance of the builder.voidsetGlobals(Map<String, VRMLNodeType> defs, Map<String, PrototypeDecl> protos, Map<String, ExternalPrototypeDecl> externProtos) Set the global DEF map to be used within fields.voidsetLoadRequirements(boolean useVrml97, boolean useBackgrounds, boolean useFogs, boolean useLights, boolean useAudio, boolean useViewpoints, boolean useExternals) Set the flags about what to load.voidDeclaration of the start of the document.voidstartExternProtoDecl(String name) Notification of the start of an EXTERNPROTO declaration of the given name.voidstartField(String name) Notification of a field declaration.voidNotification of the start of a node.voidNotification of the start of an ordinary proto body.voidstartProtoDecl(String name) Notification of the start of an ordinary (inline) proto declaration.voidNotification of the start of a script declaration.voidThe field value is a USE for the given node name.
-
Constructor Details
-
ProtoBuilder
Create a new default instance of the scene builder. This uses the default factory for nodes non-renderable nodes.- Parameters:
fac- The factory used to create internal nodes representations with.- Throws:
NullPointerException- The factory reference is null
-
-
Method Details
-
setDocumentLocator
Set the document locator that can be used by the implementing code to find out information about the current line information. This method is called by the parser to your code to give you a locator to work with. If this has not been set by the timestartDocument()has been called, you can assume that you will not have one available.- Specified by:
setDocumentLocatorin interfaceContentHandler- Parameters:
loc- The locator instance to use
-
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.0and the second is#X3D V1.0even though this second header represents a later spec.- Specified by:
startDocumentin interfaceContentHandler- Parameters:
uri- The URI of the file.url- The base URL of the file for resolving relative URIs contained in the fileencoding- The encoding of this document - utf8 or binarytype- The bytes of the first part of the file headerversion- The VRML version of this documentcomment- 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 documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
profileDecl
A profile declaration has been found in the code. A proto builder should never encounter this situation.- Specified by:
profileDeclin interfaceContentHandler- 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.
-
componentDecl
A component declaration has been found in the code. A proto builder should never encounter this situation.- Specified by:
componentDeclin interfaceContentHandler- Parameters:
componentInfo- The name of the component 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.
-
metaDecl
A META declaration has been found in the code. There may be zero or more meta declarations in the file, appearing just after the component declaration. Each meta declaration has a key and value strings. No information is to be implied from this. It is for extra data only.- Specified by:
metaDeclin interfaceContentHandler- Parameters:
key- The value of the key stringvalue- The value of the value string- 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.
-
importDecl
public void importDecl(String inline, String exported, String imported) throws SAVException, VRMLException An IMPORT declaration has been found in the document. All three parameters will always be provided, regardless of whether the AS keyword has been used or not. The parser implementation will automatically set the local import name as needed.- Specified by:
importDeclin interfaceContentHandler- Parameters:
inline- The name of the inline DEF nodesexported- The exported name from the inlined fileimported- The local name to use for the exported name- 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.
-
exportDecl
An EXPORT declaration has been found in the document. Both parameters will always be provided regardless of whether the AS keyword has been used. The parser implementation will automatically set the exported name as needed.- Specified by:
exportDeclin interfaceContentHandler- Parameters:
defName- The DEF name of the nodes to be exportedexported- The name to be exported as- 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
Declaration of the end of the document. There will be no further parsing and hence events after this.- Specified by:
endDocumentin interfaceContentHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
startNode
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:
startNodein interfaceContentHandler- Parameters:
name- The name of the node that we are about to parsedefName- 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 documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
endNode
Notification of the end of a node declaration.- Specified by:
endNodein interfaceContentHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
startField
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 theScriptHandlerorProtoHandlermethods are used.- Specified by:
startFieldin interfaceContentHandler- Parameters:
name- The name of the field declared- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
fieldValue
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 anotherstartField()orendNode().If this field is an SFNode with a USE declaration you will have the
useDecl(String)method called rather than this method.- Specified by:
fieldValuein interfaceBinaryContentHandler- Specified by:
fieldValuein interfaceStringContentHandler- Parameters:
value- The value of this field- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
fieldValue
The value of an MFField where the underlying parser knows about how the values are broken up. The parser is not required to support this callback, but implementors of this interface should understand it. The most likely time we will have this method called is for MFString or URL lists. If called, it is guaranteed to split the strings along the SF node type boundaries.- Specified by:
fieldValuein interfaceStringContentHandler- Parameters:
values- The list of string representing the values- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
useDecl
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 anotherstartField()orendNode().- Specified by:
useDeclin interfaceContentHandler- 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 documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
endField
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 eitheruseDecl(String)orfieldValue(String).- Specified by:
endFieldin interfaceContentHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
fieldValue
Set the value of the field at the given index as an integer. This would be used to set SFInt32 field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- 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
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:
fieldValuein interfaceBinaryContentHandler- Parameters:
value- The new value to use for the nodelen- 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
Set the value of the field at the given index as an boolean. This would be used to set SFBool field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- 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
Set the value of the field at the given index as an array of boolean. This would be used to set MFBool field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- Parameters:
value- The new value to use for the nodelen- 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
Set the value of the field at the given index as a float. This would be used to set SFFloat field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- 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
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:
fieldValuein interfaceBinaryContentHandler- Parameters:
value- The new value to use for the nodelen- 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
Set the value of the field at the given index as an long. This would be used to set SFTime field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- 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
Set the value of the field at the given index as an array of longs. This would be used to set MFTime field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- Parameters:
value- The new value to use for the nodelen- 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
Set the value of the field at the given index as an double. This would be used to set SFDouble field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- 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
Set the value of the field at the given index as an array of doubles. This would be used to set MFDouble, SFVec2d and SFVec3d field types.- Specified by:
fieldValuein interfaceBinaryContentHandler- Parameters:
value- The new value to use for the nodelen- 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
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:
fieldValuein interfaceBinaryContentHandler- Parameters:
value- The new value to use for the nodelen- 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
Notification of the start of an ordinary (inline) proto declaration. The proto has the given node name.- Specified by:
startProtoDeclin interfaceProtoHandler- Parameters:
name- The name of the proto- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
endProtoDecl
Notification of the end of an ordinary proto declaration statement.- Specified by:
endProtoDeclin interfaceProtoHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
protoFieldDecl
public void protoFieldDecl(int access, String type, String name, Object value) throws SAVException, VRMLException Notification of a proto's field declaration. This is used for both external and ordinary protos. Externprotos don't allow the declaration of a value for the field. In this case, the parameter value will be null.- Specified by:
protoFieldDeclin interfaceProtoHandler- Parameters:
access- The access type (eg exposedField, field etc)type- The field type (eg SFInt32, MFVec3d etc)name- The name of the fieldvalue- The default value of the field. Null if not allowed.- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
protoIsDecl
Notification of a field value uses an IS statement. If we are running in VRML97 mode, this will throw an exception if the field access types do not match.- Specified by:
protoIsDeclin interfaceProtoHandler- Parameters:
fieldName- The name of the field that is being IS'd- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
startProtoBody
Notification of the start of an ordinary proto body. All nodes contained between here and the correspondingendProtoBody()statement form the body and not the normal scene graph information.- Specified by:
startProtoBodyin interfaceProtoHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
endProtoBody
Notification of the end of an ordinary proto body. Parsing now returns to ordinary node declarations.- Specified by:
endProtoBodyin interfaceProtoHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
startExternProtoDecl
Notification of the start of an EXTERNPROTO declaration of the given name. Between here and the matchingendExternProtoDecl()call you should only receiveprotoFieldDecl(int, java.lang.String, java.lang.String, java.lang.Object)calls.- Specified by:
startExternProtoDeclin interfaceProtoHandler- Parameters:
name- The node name of the extern proto- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
endExternProtoDecl
Notification of the end of an EXTERNPROTO declaration.- Specified by:
endExternProtoDeclin interfaceProtoHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
externProtoURI
Notification of the URI list for an EXTERNPROTO. This is a complete list of URIs. The calling application is required to interpet the incoming strings. Even if the externproto has no URIs registered, this method shall be called. If there are none available, this will be called with a zero length list of values.- Specified by:
externProtoURIin interfaceProtoHandler- Parameters:
values- A list of strings representing all of the URI values- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
startScriptDecl
Notification of the start of a script declaration. All calls between now and the correspondingendScriptDecl()call belong to this script node. This method will be called after the ContentHandlerstartNode()method call. All DEF information is contained in that method call and this just signifies the start of script processing so that we know to treat the field parsing callbacks a little differently.- Specified by:
startScriptDeclin interfaceScriptHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
endScriptDecl
Notification of the end of a script declaration. This is guaranteed to be called before the ContentHandlerendNode()callback.- Specified by:
endScriptDeclin interfaceScriptHandler- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
scriptFieldDecl
public void scriptFieldDecl(int access, String type, String name, Object value) throws SAVException, VRMLException Notification of a script's field declaration. This is used for all fields excepturl,mustEvaluateanddirectOutputfields. These fields use the normal field callbacks ofContentHandler.- Specified by:
scriptFieldDeclin interfaceScriptHandler- Parameters:
access- The access type (eg exposedField, field etc)type- The field type (eg SFInt32, MFVec3d etc)name- The name of the fieldvalue- The default value of the field- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
routeDecl
public void routeDecl(String srcNodeName, String srcFieldName, String destNodeName, String destFieldName) throws SAVException, VRMLException Notification of a ROUTE declaration in the file. The context of this route should be assumed from the surrounding calls to start and end of proto and node bodies.- Specified by:
routeDeclin interfaceRouteHandler- Parameters:
srcNodeName- The name of the DEF of the source nodesrcFieldName- The name of the field to route values fromdestNodeName- The name of the DEF of the destination nodedestFieldName- The name of the field to route values to- Throws:
SAVException- This call is taken at the wrong time in the structure of the documentVRMLException- The content provided is invalid for this part of the document or can't be parsed
-
setErrorReporter
public void setErrorReporter(org.j3d.util.ErrorReporter reporter) Set the error handler instance used by this instance of the builder. The handler is used to report errors at the higher level. A value of null will clear the current instance and return to the default handling.- Parameters:
reporter- The instance to use or null to clear
-
getPrototype
Get the scene that was last built by this scene handler. If none of the methods have been called yet, this will return a null reference. The scene instance returned by this builder will not have had any external references resolved. Externprotos, scripts, Inlines and all other nodes that reference part of their data as a URL will need to be loaded separately.- Returns:
- The last built scene
-
reset
public void reset()Reset the builder. This is used to make sure that the builder has been reset after a parsing run just in case the last parsing run exited abnormally and left us in an odd state. Sometimes this can prevent us from parsing again. This method should be called just before theVRMLReader.parse()method is called.The flags set about what to load are not reset by this method.
-
setGlobals
public void setGlobals(Map<String, VRMLNodeType> defs, Map<String, PrototypeDecl> protos, Map<String, ExternalPrototypeDecl> externProtos) Set the global DEF map to be used within fields. This is maintained between resets so it should be cleared when necessary.- Parameters:
defs- The new DEF map to useprotos- The new proto map to useexternProtos- The new externproto map to use
-
setLoadRequirements
public void setLoadRequirements(boolean useVrml97, boolean useBackgrounds, boolean useFogs, boolean useLights, boolean useAudio, boolean useViewpoints, boolean useExternals) Set the flags about what to load. The flags defined here are matched by the Java 3D Loader interface. Nodes defined as externals are inlines and extern protos.- Parameters:
useVrml97- true if the semantics should be VRML97 capable rather than the looser VRML 3.0.useBackgrounds- true if BackgroundNodeTypes should be loadeduseFogs- true if FogNodeTypes should be loadeduseLights- true if LightNodeTypes should be loadeduseAudio- true if AudioClipNodeTypes should be loadeduseViewpoints- true if ViewpointNodeTypes should loadeduseExternals- true if ExternalNodeTypes should be loaded
-
newProto
Start a new proto definition within the current document context.- Parameters:
creator- The proto creator to wrap the template with
-