package Vrml2Sourcebook.Chapter30Scripts;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* A torus shape built with a donut-maker program script. Also see Figures 31.6 and 31.7 for comparison.
Related links: Catalog page Figure30_5ScriptTorusBuilder, source Figure30_5ScriptTorusBuilder.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 Figure 30.5, The VRML 2.0 Sourcebook, Copyright [1997] By Andrea L. Ames, David R. Nadeau, and John L. Moreland
*/
public class Figure30_5ScriptTorusBuilder
{
/** Default constructor to create this object. */
public Figure30_5ScriptTorusBuilder ()
{
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("Figure30_5ScriptTorusBuilder.x3d"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Figure 30.5, The VRML 2.0 Sourcebook, Copyright [1997] By Andrea L. Ames, David R. Nadeau, and John L. Moreland"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.wiley.com/legacy/compbooks/vrml2sbk/ch30/30fig05.htm"))
.addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("28 September 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("A torus shape built with a donut-maker program script. Also see Figures 31.6 and 31.7 for comparison."))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter30Scripts/Figure30_5ScriptTorusBuilder.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("Figure30_5ScriptTorusBuilder.x3d"))
.addChild(new Viewpoint().setDescription("Torus").setOrientation(1.0,0.0,0.0,-0.78).setPosition(0.0,5.0,5.0))
.addChild(new Group()
.addChild(new Shape()
.setGeometry(new Extrusion("Donut").setBeginCap(false).setConvex(false).setCreaseAngle(1.57).setEndCap(false))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,0.4,0.8))))
.addChild(new Script("DonutMakerExternalScript").setUrl(new String[] {"donutmaker.js","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter30Scripts/donutmaker.js"})
.addField(new field().setName("spineRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(2))
.addField(new field().setName("crossSectionRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(1))
.addField(new field().setName("spineResolution").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(16))
.addField(new field().setName("crossSectionResolution").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(16))
.addField(new field().setName("set_spineRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("set_crossSectionRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("spine_changed").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("crossSection_changed").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Script("DonutMakerInternalScript").setSourceCode("""
ecmascript:
function initialize( ) {
generateCrossSection( );
generateSpine( );
}
function set_crossSectionRadius( csr, ts ) {
crossSectionRadius = csr;
generateCrossSection( );
// Browser.println ('crossSectionRadius = ' + csr);
}
function set_spineRadius( sr, ts ) {
spineRadius = sr;
generateSpine( );
// Browser.println ('spineRadius = ' + sr);
}
function generateCrossSection( ) {
angle = 0.0;
delta = (2 * 3.141592653) / crossSectionResolution;
for ( i = 0; i <= crossSectionResolution; i++ ) {
crossSection_changed[i][0] = crossSectionRadius * Math.cos( angle );
crossSection_changed[i][1] = -crossSectionRadius * Math.sin( angle );
angle += delta;
}
// added code to make ends meet
crossSection_changed[crossSectionResolution + 1][0] = crossSection_changed[0][0];
crossSection_changed[crossSectionResolution + 1][1] = crossSection_changed[0][1];
}
function generateSpine( ) {
angle = 0.0;
delta = (2 * 3.141592653) / spineResolution;
for ( i = 0; i <= spineResolution; i++ ) {
spine_changed[i][0] = spineRadius * Math.cos( angle );
spine_changed[i][1] = 0.0;
spine_changed[i][2] = -spineRadius * Math.sin( angle );
angle += delta;
}
// added code to make ends meet
spine_changed[spineResolution + 1][0] = spine_changed[0][0];
spine_changed[spineResolution + 1][1] = 0.0;
spine_changed[spineResolution + 1][2] = spine_changed[0][2];
}
""")
.addField(new field().setName("spineRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(2))
.addField(new field().setName("crossSectionRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(1))
.addField(new field().setName("spineResolution").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(16))
.addField(new field().setName("crossSectionResolution").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(16))
.addField(new field().setName("set_spineRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("set_crossSectionRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("spine_changed").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("crossSection_changed").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))))
.addComments(" Either ROUTE from DonutMakerExternalScript or DonutMakerInternalScript, both methods work ")
.addChild(new ROUTE().setFromNode("DonutMakerInternalScript").setFromField("spine_changed").setToNode("Donut").setToField("set_spine"))
.addChild(new ROUTE().setFromNode("DonutMakerInternalScript").setFromField("crossSection_changed").setToNode("Donut").setToField("set_crossSection")));
}
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 Figure30_5ScriptTorusBuilder 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 Figure30_5ScriptTorusBuilder().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: \"Vrml2Sourcebook.Chapter30Scripts.Figure30_5ScriptTorusBuilder\" 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("Vrml2Sourcebook.Chapter30Scripts.Figure30_5ScriptTorusBuilder self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter30Scripts/Figure30_5ScriptTorusBuilder_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter30Scripts/Figure30_5ScriptTorusBuilder_JavaExport.x3d";
String filenameX3DV = "Chapter30Scripts/Figure30_5ScriptTorusBuilder_JavaExport.x3dv";
String filenameJSON = "Chapter30Scripts/Figure30_5ScriptTorusBuilder_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}