package Basic.development;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Provides Prototype XML-tag-definition examples to demonstrate DTD modularization and extensibility in X3D scenes. Also see SpinGroupInternalSubsetDeclaration.x3d.
Related links: Catalog page ProtoTagDtdDeclarationExamples, source ProtoTagDtdDeclarationExamples.java, X3D Resources, X3D Scene Authoring Hints, and X3D Tooltips.
This program uses the
X3D Java Scene Access Interface Library (X3DJSAIL).
It has been produced using the
X3dToJava.xslt
stylesheet
(version control)
which is used to create Java source code from an original .x3d model.
* @author Don Brutzman
*/
public class ProtoTagDtdDeclarationExamples
{
/** Default constructor to create this object. */
public ProtoTagDtdDeclarationExamples ()
{
initialize();
}
/** Create and initialize the X3D model for this object. */
public final void initialize()
{
try { // catch-all
x3dModel = new X3D().setProfile(X3D.PROFILE_IMMERSIVE).setVersion(X3D.VERSION_3_0)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("ProtoTagDtdDeclarationExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("17 April 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName("e-mail").setContent("brutzman@nps.navy.mil"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Provides Prototype XML-tag-definition examples to demonstrate DTD modularization and extensibility in X3D scenes. Also see SpinGroupInternalSubsetDeclaration.x3d"))
.addMeta(new meta().setName(meta.NAME_WARNING ).setContent("You must view full source of the DTD declarations (ProtoTagDtdDeclarationExamples.x3d.txt) to fully understand validation techniques in this file."))
.addMeta(new meta().setName(meta.NAME_ERROR ).setContent("internal subset deficiency: nodeType attributes need to be converted to containerField attributes."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ProtoTagDtdDeclarationExamples.x3d.txt"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("SpinGroupInternalSubsetDeclaration.x3d.txt"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Basic/development/ProtoTagDtdDeclarationExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.1, https://www.web3d.org/x3d/content/README.X3D-Edit.html"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addComments(" ********************************************************************* ")
.addComments(" *** Step 5: Copy/edit ProtoDeclare, (optionally ProtoInstance) *** ")
.addComments(" *** and the tagset version for your nodes of interest. *** ")
.addComments(" *** When instantiating field Node/Nodes or field values, *** ")
.addComments(" *** use fieldValue tags to override the initial values. *** ")
.addComments(" *** The following example content instantiates prototype *** ")
.addComments(" *** NewTransformExample using tags and ProtoInstance. *** ")
.addComments(" ********************************************************************* ")
.addComments(" Declaring the NewTransformExample PROTO: ")
.addChild(new ProtoDeclare("NewTransformExample").setName("NewTransformExample")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("rotation").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFRotation(0.0,0.0,1.0,0.0)))
.addField(new field().setName("center").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("scale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(1.0,1.0,1.0)))
.addField(new field().setName("scaleOrientation").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFRotation(0.0,0.0,1.0,0.0)))
.addField(new field().setName("bboxCenter").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("bboxSize").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(-1.0,-1.0,-1.0)))
.addField(new field().setName("children").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)
.addChild(new WorldInfo().setInfo(new String[] {"overridden at run time"}))))
.setProtoBody(new ProtoBody()
.addComments(" Transform is first node, which determines node type, and encloses children for instances. ")
.addChild(new Transform("InitialTransform")
.setIS(new IS()
.addConnect(new connect().setNodeField("translation").setProtoField("translation"))
.addConnect(new connect().setNodeField("rotation").setProtoField("rotation"))
.addConnect(new connect().setNodeField("center").setProtoField("center"))
.addConnect(new connect().setNodeField("scale").setProtoField("scale"))
.addConnect(new connect().setNodeField("scaleOrientation").setProtoField("scaleOrientation"))
.addConnect(new connect().setNodeField("bboxCenter").setProtoField("bboxCenter"))
.addConnect(new connect().setNodeField("bboxSize").setProtoField("bboxSize"))
.addConnect(new connect().setNodeField("children").setProtoField("children"))))))
.addComments(" Instantiating the NewTransformExample PROTO using a ProtoInstance tag: ")
.addChild(new ProtoInstance("NewTransformExample").setContainerField("children")
.addFieldValue(new fieldValue().setName("translation").setValue(new SFVec3f(0.0,1.5,0.0)))
.addFieldValue(new fieldValue().setName("children")
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.1,0.8,0.8)))
.setGeometry(new Text().setString(new String[] {"ProtoTagDtdDeclaration Examples","using a regular ProtoInstance"})
.setFontStyle(new FontStyle("FS").setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.7))))))
.addComments(" Instantiating the NewTransformExample node using a customized tag: ")
.addChild(new NewTransformExample().setCenter(0.0,0.0,0.0).setRotation(0.0,0.0,1.0,0.0).setScale(1.0,1.0,1.0).setScaleOrientation(0.0,0.0,1.0,0.0).setTranslation(0.0,-0.5,0.0)
.addFieldValue(new fieldValue().setName("children")
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.1,0.8,0.2)))
.setGeometry(new Text().setString(new String[] {"plus header-declared XML tag from","XML document subset declaration"})
.setFontStyle(new FontStyle().setUSE("FS"))))))
.addChild(new Transform().setTranslation(0.0,-2.0,0.0)
.addChild(new Anchor().setDescription("Click to view source (ProtoTagDtdDeclarationExamples.x3d.txt)").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"ProtoTagDtdDeclarationExamples.x3d.txt","https://www.web3d.org/x3d/content/examples/development/ProtoTagDtdDeclarationExamples.x3d.txt"})
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.8,0.4,0.1)))
.setGeometry(new Text().setString(new String[] {"(click to see source)"})
.setFontStyle(new FontStyle().setUSE("FS")))))));
}
catch (Exception ex)
{
System.err.println ("*** Further hints on X3DJSAIL errors and exceptions at");
System.err.println ("*** https://www.web3d.org/specifications/java/X3DJSAIL.html");
throw (ex);
}
}
// end of initialize() method
/** The initialized model object, created within initialize() method. */
private X3D x3dModel;
/**
* Provide a
* shallow copy
* of the X3D model.
* @see X3D
* @return ProtoTagDtdDeclarationExamples model
*/
public X3D getX3dModel()
{
return x3dModel;
}
/**
* Default main() method provided for test purposes, uses CommandLine to set global ConfigurationProperties for this object.
* @param args array of input parameters, provided as arguments
* @see X3D.handleArguments(args)
* @see X3D.validationReport()
* @see CommandLine
* @see CommandLine.USAGE
* @see ConfigurationProperties
*/
public static void main(String args[])
{
System.out.println("Build this X3D model, showing validation diagnostics...");
X3D thisExampleX3dModel = new ProtoTagDtdDeclarationExamples().getX3dModel();
// System.out.println("X3D model construction complete.");
// next handle command line arguments
boolean hasArguments = (args != null) && (args.length > 0);
boolean validate = true; // default
boolean argumentsLoadNewModel = false;
String fileName = new String();
if (args != null)
{
for (String arg : args)
{
if (arg.toLowerCase().startsWith("-v") || arg.toLowerCase().contains("validate"))
{
validate = true; // making sure
}
if (arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_X3D) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_CLASSICVRML) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_X3DB) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_VRML97) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_EXI) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_GZIP) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_ZIP) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_HTML) ||
arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_XHTML))
{
argumentsLoadNewModel = true;
fileName = arg;
}
}
}
if (argumentsLoadNewModel)
System.out.println("WARNING: \"Basic.development.ProtoTagDtdDeclarationExamples\" model invocation is attempting to load file \"" + fileName + "\" instead of simply validating itself... file loading ignored.");
else if (hasArguments) // if no arguments provided, this method produces usage warning
thisExampleX3dModel.handleArguments(args);
if (validate)
{
// System.out.println("--- TODO fix duplicated outputs ---"); // omit when duplicated outputs problem is solved/refactored
String validationResults = thisExampleX3dModel.validationReport();
// System.out.println("-----------------------------------"); // omit when duplicated outputs problem is solved/refactored
System.out.print("Basic.development.ProtoTagDtdDeclarationExamples self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// development/ProtoTagDtdDeclarationExamples_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "development/ProtoTagDtdDeclarationExamples_JavaExport.x3d";
String filenameX3DV = "development/ProtoTagDtdDeclarationExamples_JavaExport.x3dv";
String filenameJSON = "development/ProtoTagDtdDeclarationExamples_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}