package Basic.ScriptConformance;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Script node interface between VRML and EcmaScript: this conformance example tests event-based VRML-EcmaScript functionality.
Related links: Catalog page ScriptNodeEventOutControl_EcmaScript, source ScriptNodeEventOutControl_EcmaScript.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 ScriptNodeEventOutControl_EcmaScript
{
/** Default constructor to create this object. */
public ScriptNodeEventOutControl_EcmaScript ()
{
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("ScriptNodeEventOutControl_EcmaScript.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Script node interface between VRML and EcmaScript: this conformance example tests event-based VRML-EcmaScript functionality."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("30 November 1997"))
.addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("13 May 2001"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Basic/ScriptConformance/ScriptNodeEventOutControl_EcmaScript.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("VRML 97 Specification, Annex C, ECMAScript scripting reference"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/javascript.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/javascript.html#AccessingFields"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("Makefile"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("Makefile.out"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ScriptNodeEventOutControl_EcmaScript-VrmlConsoleOutput.txt"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ScriptNodeEventOutControl_EcmaScriptSnapshots.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ScriptNodeEventOutControl_Java.x3d"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("VRML X3D EcmaScript Script conformance"))
.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("ScriptNodeEventOutControl_EcmaScript.x3d"))
.addChild(new Viewpoint().setDescription("View test").setPosition(0.0,0.0,12.0))
.addChild(new Group()
.addChild(new TouchSensor("ClickTextToTest").setDescription("Click text to test"))
.addChild(new Transform("TextPosition")
.addComments(" TextPosition translation is modified by InterfaceScriptNode. ")
.addChild(new Shape()
.addComments(" note \"\" means empty string, which skips a line and pushes the other text upwards by a line ")
.setGeometry(new Text("MessageToUser").setString(new String[] {"Default text in VRML scene will be replaced by","Java initialize() in Script using EventOut control.","This text appears first, if Java initialization fails.",""})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.8)))
.setAppearance(new Appearance()
.setMaterial(new Material("TextMaterial").setDiffuseColor(0.8,0.2,0.2).setShininess(0.9)))))
.addChild(new Script("InterfaceScriptNode").setSourceCode("""
ecmascript:
function initialize ()
{
DEBUG = true;
mode = 1;
if (DEBUG) Browser.println ('initialize ():');
changedText = new MFString (
'EcmaScript initialize () with eventOut control',
'has reinitialized the changedText node.',
'',
'Please click text for additional results.');
changedPosition = new SFVec3f ( 0, 3, 0 );
changedColor = new SFColor ( 0.8, 0.8, 0.2 );
if (DEBUG) Browser.println ('changedText =' + changedText);
if (DEBUG) Browser.println ('changedPosition =' + changedPosition);
if (DEBUG) Browser.println ('changedColor =' + changedColor);
}
function startTime (value, timestamp)
{
if (DEBUG) Browser.println ('==============================');
if (DEBUG) Browser.println ('touchEvent startTime =' + value);
mode = (mode + 1) % 3;
if (DEBUG) Browser.println ('mode =' + mode);
switch (mode)
{
case 0: // pre-initialize error messsage
changedText = new MFString (
'Default text in VRML scene will be replaced by',
'EcmaScript initialize() in Script using EventOut control.',
'This text appears first, if EcmaScript initialization fails.',
'');
changedPosition = new SFVec3f ( 0, 1, 0 );
changedColor = new SFColor ( 0.8, 0.2, 0.2 );
break;
case 1: // post-initialize ready-to-click message
initialize ();
break;
case 2: // post-click all-done message
changedText = new MFString (
'User click on text seen by EcmaScript',
'function via Script node eventIn.',
'Text & position successfully changed',
'via EventOut control. Test passed.');
changedPosition = new SFVec3f ( 0, -1, 0 );
changedColor = new SFColor ( 0.2, 0.8, 0.2 );
break;
}
if (mode != 1)
{
if (DEBUG) Browser.println ('changedText =' + changedText);
if (DEBUG) Browser.println ('changedPosition =' + changedPosition);
if (DEBUG) Browser.println ('changedColor =' + changedColor);
if (DEBUG) Browser.println ();
}
}
function shutdown()
{
if (DEBUG) Browser.println ('==============================');
if (DEBUG) Browser.println ('script shutdown.');
if (DEBUG) Browser.println ('==============================');
}
""")
.addComments(" No default values are allowed for eventIn or eventOut. ")
.addField(new field().setName("startTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("changedText").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("changedPosition").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("changedColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_OUTPUTONLY))))
.addChild(new ROUTE().setFromNode("ClickTextToTest").setFromField("touchTime").setToNode("InterfaceScriptNode").setToField("startTime"))
.addChild(new ROUTE().setFromNode("InterfaceScriptNode").setFromField("changedText").setToNode("MessageToUser").setToField("set_string"))
.addChild(new ROUTE().setFromNode("InterfaceScriptNode").setFromField("changedPosition").setToNode("TextPosition").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("InterfaceScriptNode").setFromField("changedColor").setToNode("TextMaterial").setToField("set_diffuseColor")));
}
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 ScriptNodeEventOutControl_EcmaScript 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 ScriptNodeEventOutControl_EcmaScript().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.ScriptConformance.ScriptNodeEventOutControl_EcmaScript\" 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.ScriptConformance.ScriptNodeEventOutControl_EcmaScript self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// ScriptConformance/ScriptNodeEventOutControl_EcmaScript_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "ScriptConformance/ScriptNodeEventOutControl_EcmaScript_JavaExport.x3d";
String filenameX3DV = "ScriptConformance/ScriptNodeEventOutControl_EcmaScript_JavaExport.x3dv";
String filenameJSON = "ScriptConformance/ScriptNodeEventOutControl_EcmaScript_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}