package X3dForAdvancedModeling.UserExperienceUX;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.EventUtilities.*;
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.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* This scene demonstrates how to receive a simple event and report it graphically, repeating every few seconds. Scene conversion from the XML encoding (.x3d) is then used to demonstrate X3DOM event handling within a web page (.xhtml).
Related links: Catalog page EventMonitorTest, source EventMonitorTest.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 EventMonitorTest
{
/** Default constructor to create this object. */
public EventMonitorTest ()
{
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_3)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("EventMonitorTest.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This scene demonstrates how to receive a simple event and report it graphically, repeating every few seconds. Scene conversion from the XML encoding (.x3d) is then used to demonstrate X3DOM event handling within a web page (.xhtml)."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName("acknowledgements").setContent("Chris Peri, Dave Arendash and Damon Hernandez"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("15 March 2014"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("31 October 2021"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("record log outputs, compare various X3D players"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("AEC Hackathon v1.1, Facebook Menlo Park California"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.aechackathon.org"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/UserExperienceUX/EventMonitorTest.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_GENERATOR ).setContent("https://www.web3d.org/x3d/stylesheets/X3dToX3dom.xslt"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addComments(" ================================================== ")
.addComments(" Reusable code block for X3DOM: indicate event status ")
.addChild(new WorldInfo().setTitle("EventMonitorTest.x3d"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.4,0.6,1.0})))
.addChild(new Viewpoint().setDescription("Event Monitor Text").setPosition(0.0,0.0,6.0))
.addChild(new Transform().setTranslation(-0.6,1.2,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"Event Status"})
.setFontStyle(new FontStyle("Font").setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setCssStyle("BOLD")))
.setAppearance(new Appearance()
.setMaterial(new Material("TextMaterial").setDiffuseColor(0.7,0.7,0.1)))))
.addChild(new Switch("EventSwitch").setWhichChoice(0)
.addChild(new Group("DisplayUp")
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"UP"})
.setFontStyle(new FontStyle().setUSE("Font")))
.setAppearance(new Appearance()
.setMaterial(new Material("UpColor").setDiffuseColor(0.2,0.7,0.3))))
.addChild(new Transform().setTranslation(-2.5,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Cone("SmallCone").setBottomRadius(0.4).setHeight(0.6))
.setAppearance(new Appearance()
.setMaterial(new Material().setUSE("UpColor"))))))
.addChild(new Group("DisplayDown")
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"DOWN"})
.setFontStyle(new FontStyle().setUSE("Font")))
.setAppearance(new Appearance()
.setMaterial(new Material("DownColor").setDiffuseColor(1.0,0.2,0.2))))
.addChild(new Transform().setRotation(1.0,0.0,0.0,3.14159).setTranslation(-2.5,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Cone().setUSE("SmallCone"))
.setAppearance(new Appearance()
.setMaterial(new Material().setUSE("DownColor")))))))
.addComments(" ================================================== ")
.addComments(" Test harness: produce true/false events, flip the Switch ")
.addChild(new IntegerTrigger("EventTrueTrigger").setIntegerKey(0))
.addChild(new ROUTE().setFromNode("EventTrueTrigger").setFromField("triggerValue").setToNode("EventSwitch").setToField("whichChoice"))
.addChild(new IntegerTrigger("EventFalseTrigger").setIntegerKey(1))
.addChild(new ROUTE().setFromNode("EventFalseTrigger").setFromField("triggerValue").setToNode("EventSwitch").setToField("whichChoice"))
.addChild(new Script("EventReceiverScript").setSourceCode("""
ecmascript:
function input (eventValue) // input eventValue received for inputOnly field
{
if (eventValue) eventIsTrue = true;
else eventIsFalse = true;
}
""")
.addField(new field().setName("input").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("eventIsTrue").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("eventIsFalse").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ROUTE().setFromNode("EventReceiverScript").setFromField("eventIsTrue").setToNode("EventTrueTrigger").setToField("set_boolean"))
.addChild(new ROUTE().setFromNode("EventReceiverScript").setFromField("eventIsFalse").setToNode("EventFalseTrigger").setToField("set_boolean"))
.addComments(" Testing block: alternate true/false ")
.addChild(new BooleanSequencer("BooleanSwitcher").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new boolean[] {true,false,false}))
.addChild(new ROUTE().setFromNode("BooleanSwitcher").setFromField("value_changed").setToNode("EventReceiverScript").setToField("input"))
.addChild(new TimeSensor("SwitchTestClock").setCycleInterval(6).setLoop(true))
.addChild(new ROUTE().setFromNode("SwitchTestClock").setFromField("fraction_changed").setToNode("BooleanSwitcher").setToField("set_fraction")));
}
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 EventMonitorTest 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 EventMonitorTest().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.UserExperienceUX.EventMonitorTest\" 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.UserExperienceUX.EventMonitorTest self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// UserExperienceUX/EventMonitorTest_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "UserExperienceUX/EventMonitorTest_JavaExport.x3d";
String filenameX3DV = "UserExperienceUX/EventMonitorTest_JavaExport.x3dv";
String filenameJSON = "UserExperienceUX/EventMonitorTest_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}