package X3dForAdvancedModeling.Animation;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Diagnostic scene for tools to test event-graph loop detection.
Related links: Catalog page EventGraphLoopTest, source EventGraphLoopTest.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 EventGraphLoopTest
{
/** Default constructor to create this object. */
public EventGraphLoopTest ()
{
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_4_0)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("EventGraphLoopTest.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Diagnostic scene for tools to test event-graph loop detection"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("4 February 2024"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("4 May 2024"))
.addMeta(new meta().setName(meta.NAME_WARNING ).setContent("includes intentional event loop"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/stylesheets/X3dToXhtml.xslt"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("EventGraphLoopTestConsoleLog.txt"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("EventGraphLoopTestIndex.html"))
.addMeta(new meta().setName(meta.NAME_SPECIFICATIONSECTION).setContent("X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 4 Concepts, 4.4.8.4 Loops"))
.addMeta(new meta().setName(meta.NAME_SPECIFICATIONURL).setContent("https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Loops"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("X3D event graph loop detection"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/EventGraphLoopTest.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("EventGraphLoopTest.x3d"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {1.0,1.0,0.858824})))
.addChild(new TimeSensor("Clock1").setCycleInterval(8).setLoop(true))
.addChild(new TimeSensor("Clock2").setCycleInterval(2))
.addChild(new TimeSensor("Clock3").setCycleInterval(2))
.addChild(new ROUTE().setFromNode("Clock1").setFromField("cycleTime").setToNode("Clock2").setToField("startTime"))
.addChild(new ROUTE().setFromNode("Clock2").setFromField("cycleTime").setToNode("Clock3").setToField("startTime"))
.addChild(new ROUTE().setFromNode("Clock3").setFromField("cycleTime").setToNode("Clock1").setToField("startTime"))
.addChild(new Script("ClockReporter").setSourceCode("""
ecmascript:
function initialize()
{
Browser.println ('[Script ClockReporter] initialize()');
}
function clockStart1 (eventValue)
{
// input eventValue received for inputOutput field
clockStart1 = eventValue;
Browser.println ('[Script ClockReporter] clockStart1(' + eventValue + ')');
}
function clockStart2 (eventValue)
{
// input eventValue received for inputOutput field
clockStart2 = eventValue;
Browser.println ('[Script ClockReporter] clockStart2(' + eventValue + ')');
}
function clockStart3 (eventValue)
{
// input eventValue received for inputOutput field
clockStart3 = eventValue;
loopCounter++;
// send single-line MFString output event to Text node's string field
loopCounterString = new MFString('loop ' + loopCounter);
Browser.println ('[Script ClockReporter] clockStart3(' + eventValue + ') received event to start text spinning');
}
""")
.addField(new field().setName("clockStart1").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(-1))
.addField(new field().setName("clockStart2").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(-1))
.addField(new field().setName("clockStart3").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(-1))
.addField(new field().setName("handleClock1").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("enable indirect contol of node by this Script")
.addChild(new TimeSensor().setUSE("Clock1")))
.addField(new field().setName("loopCounter").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0).setAppinfo("loop count"))
.addField(new field().setName("loopCounterString").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("display latest loop count")))
.addChild(new ROUTE().setFromNode("Clock3").setFromField("cycleTime").setToNode("ClockReporter").setToField("clockStart3"))
.addComments(" debug ")
.addChild(new Transform("RotatingTransform").setTranslation(0.0,1.0,0.0)
.addChild(new Shape("SpinnableTextShape")
.setGeometry(new Text().setString(new String[] {"EventGraphLoopTest","includes a","three-ROUTE event loop"})
.setFontStyle(new FontStyle("BoldFontStyle").setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.8).setCssStyle("BOLD")))
.setAppearance(new Appearance("TextAppearance")
.setMaterial(new Material().setDiffuseColor(1.0,0.4,0.2)))))
.addChild(new Transform("LoopCounterTransform").setScale(0.8,0.8,0.8).setTranslation(0.0,-1.5,0.0)
.addChild(new Shape("LoopCounterTextShape")
.setGeometry(new Text("LoopCounterText").setString(new String[] {"loop 0"})
.setFontStyle(new FontStyle().setUSE("BoldFontStyle")))
.setAppearance(new Appearance().setUSE("TextAppearance"))))
.addChild(new ROUTE().setFromNode("ClockReporter").setFromField("loopCounterString").setToNode("LoopCounterText").setToField("string"))
.addChild(new OrientationInterpolator("Spinner").setKey(new double[] {0.0,0.3333,0.6667,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,0.0,0.0,1.0,0.0,2.094395,0.0,1.0,0.0,4.18879,0.0,1.0,0.0,0.0})))
.addChild(new ROUTE().setFromNode("Clock3").setFromField("fraction_changed").setToNode("Spinner").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("Spinner").setFromField("value_changed").setToNode("RotatingTransform").setToField("rotation")));
}
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 EventGraphLoopTest 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 EventGraphLoopTest().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: \"X3dForAdvancedModeling.Animation.EventGraphLoopTest\" 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("X3dForAdvancedModeling.Animation.EventGraphLoopTest self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Animation/EventGraphLoopTest_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Animation/EventGraphLoopTest_JavaExport.x3d";
String filenameX3DV = "Animation/EventGraphLoopTest_JavaExport.x3dv";
String filenameJSON = "Animation/EventGraphLoopTest_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}