package Savage.Tools.Animation;
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.Networking.*;
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.
/**
* Double-click TouchSensor design pattern, implemented as a reusable prototype node.
Related links: Catalog page DoubleClickTouchSensorPrototype, source DoubleClickTouchSensorPrototype.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 DoubleClickTouchSensorPrototype
{
/** Default constructor to create this object. */
public DoubleClickTouchSensorPrototype ()
{
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("DoubleClickTouchSensorPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Double-click TouchSensor design pattern, implemented as a reusable prototype node."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("26 May 2004"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("6 June 2020"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("DoubleClickTouchSensorExample.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/specifications/ISO-IEC-19775-FDIS-X3dAbstractSpecification/Part01/components/pointingsensor.html#TouchSensor"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("DoubleClickTouchSensor"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/DoubleClickTouchSensorPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.2, https://www.web3d.org/x3d/tools/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("DoubleClickTouchSensorPrototype.x3d"))
.addChild(new ProtoDeclare("DoubleClickTouchSensor").setName("DoubleClickTouchSensor").setAppinfo("DoubleClickTouchSensor functionality activates when user double clicks (or double selects) within maxDelayInterval")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("describe the purpose of this sensor"))
.addField(new field().setName("maxDelayInterval").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0.5).setAppinfo("seconds"))
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true))
.addField(new field().setName("isActive").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("isOver").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("touchTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("seconds"))
.addField(new field().setName("hitPoint_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("hitNormal_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("hitTexCoord_changed").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("metadata").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("can contain one of Metadata nodes")
.addComments(" initialization node (if any) goes here "))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false)))
.setProtoBody(new ProtoBody()
.addChild(new TouchSensor("TouchSensorNode")
.setIS(new IS()
.addConnect(new connect().setNodeField("description").setProtoField("description"))
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))
.addConnect(new connect().setNodeField("isOver").setProtoField("isOver"))))
.addComments(" Only first node inside a ProtoBody is rendered. TouchSensor must remain outside Group to be externally active. ")
.addChild(new Group()
.addChild(new Script("DoubleClickTouchScript").setDirectOutput(true).setSourceCode("""
ecmascript:
// inputOnly events are handled by functions,
// initializeOnly fields are variable objects,
// outputOnly events are sent by setting values
function initialize ()
{
tracePrint ('initialize (); enabled=' + touchSensor.enabled);
}
// trigger on isActive to filter touchTime events when unclicking
function checkClicks (value, timestamp) // activated from TouchSensorNode.isActive
{
if (value == false) // doubleClick isActive=false events
{
if (isActive == true) // need to unclick
{
isActive = false; // send output events
touchTime = timestamp;
tracePrint ('DoubleClick isActive=false;');
}
return;
}
priorTouchTime = currentTouchTime;
currentTouchTime = timestamp;
computedDelay = (currentTouchTime - priorTouchTime);
if (priorTouchTime == -1)
{
tracePrint ('priorTouchTime == -1, return;');
return;
}
else if (computedDelay <= maxDelayInterval)
{
tracePrint ('computedDelay=' + computedDelay + ', DoubleClick isActive=true;');
isActive = true; // send output events
touchTime = timestamp;
hitPoint_changed = touchSensor.hitPoint_changed;
hitNormal_changed = touchSensor.hitNormal_changed;
hitTexCoord_changed = touchSensor.hitTexCoord_changed;
}
else
{
tracePrint ('computedDelay=' + computedDelay + ', single click');
return;
}
}
function set_description (newDescription)
{
description = newDescription;
}
function tracePrint (outputString)
{
if (traceEnabled) Browser.println ('[DoubleClickTouchSensor] ' + outputString);
}
""")
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("checkClicks").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("maxDelayInterval").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("seconds"))
.addField(new field().setName("priorTouchTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(-1))
.addField(new field().setName("currentTouchTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(-1))
.addField(new field().setName("touchSensor").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("permits controlled access to various TouchSensorNode fields")
.addChild(new TouchSensor().setUSE("TouchSensorNode")))
.addField(new field().setName("isActive").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("touchTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("seconds"))
.addField(new field().setName("hitPoint_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("hitNormal_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("hitTexCoord_changed").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("description").setProtoField("description"))
.addConnect(new connect().setNodeField("maxDelayInterval").setProtoField("maxDelayInterval"))
.addConnect(new connect().setNodeField("isActive").setProtoField("isActive"))
.addConnect(new connect().setNodeField("touchTime").setProtoField("touchTime"))
.addConnect(new connect().setNodeField("hitPoint_changed").setProtoField("hitPoint_changed"))
.addConnect(new connect().setNodeField("hitNormal_changed").setProtoField("hitNormal_changed"))
.addConnect(new connect().setNodeField("hitTexCoord_changed").setProtoField("hitTexCoord_changed"))
.addConnect(new connect().setNodeField("traceEnabled").setProtoField("traceEnabled"))))
.addChild(new ROUTE().setFromNode("TouchSensorNode").setFromField("isActive").setToNode("DoubleClickTouchScript").setToField("checkClicks"))
.addChild(new Collision("MetadataHolder").setEnabled(false)
.setIS(new IS()
.addConnect(new connect().setNodeField("proxy").setProtoField("metadata")))))))
.addComments(" ====================================== ")
.addComments(" Example use ")
.addChild(new Anchor().setDescription("DoubleClickTouchSensor Example").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"DoubleClickTouchSensorExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/DoubleClickTouchSensorExample.x3d","DoubleClickTouchSensorExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/DoubleClickTouchSensorExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"DoubleClickTouchSensorPrototype","defines a prototype","","Click text to see","DoubleClickTouchSensorExample scene"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.7)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,0.2))))));
}
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 DoubleClickTouchSensorPrototype 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 DoubleClickTouchSensorPrototype().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: \"Savage.Tools.Animation.DoubleClickTouchSensorPrototype\" 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("Savage.Tools.Animation.DoubleClickTouchSensorPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/DoubleClickTouchSensorPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/DoubleClickTouchSensorPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/DoubleClickTouchSensorPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/DoubleClickTouchSensorPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}