package Basic.development;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Networking.*;
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.
/**
* <p> BooleanSequencer is modeled after ScalarInterpolator and generates true or false values. </p>
<p> Related links: Catalog page <a href="../../../development/BooleanSequencerPrototypeIndex.html" target="_blank">BooleanSequencerPrototype</a>, source <a href="../../../development/BooleanSequencerPrototype.java">BooleanSequencerPrototype.java</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dResources.html" target="_blank">X3D Resources</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html" target="_blank">X3D Scene Authoring Hints</a>, and <a href="https://www.web3d.org/x3d/content/X3dTooltips.html" target="_blank">X3D Tooltips</a>. </p>
<table style="color:black; border:0px solid; border-spacing:10px 0px;">
<caption>Scene Meta Information</caption>
<tr style="background-color:silver; border-color:silver;">
<td style="text-align:center; padding:10px 0px;"><i>meta tags</i></td>
<td style="text-align:left; padding:10px 0px;"> Document Metadata </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> title </i> </td>
<td> <a href="../../../development/BooleanSequencerPrototype.x3d">BooleanSequencerPrototype.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
<td> BooleanSequencer is modeled after ScalarInterpolator and generates true or false values. </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
<td> Don Brutzman, Estuko Lippi, Jeff Weekley, Jane Wu </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
<td> 7 August 2001 </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
<td> 20 January 2020 </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
<td> <a href="https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#ScalarInterpolator" target="_blank">https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#ScalarInterpolator</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> subject </i> </td>
<td> boolean sequencer </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> identifier </i> </td>
<td> <a href="https://www.web3d.org/x3d/content/examples/Basic/development/BooleanSequencerPrototype.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/development/BooleanSequencerPrototype.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
<td> X3D-Edit 3.3, <a href="https://savage.nps.edu/X3D-Edit" target="_blank">https://savage.nps.edu/X3D-Edit</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
<td> <a href="../../../development/../license.html">../license.html</a> </td>
</tr>
<tr style="background-color:silver; border-color:silver;">
<td style="text-align:center;" colspan="2"> </td>
</tr>
</table>
<p>
This program uses the
<a href="https://www.web3d.org/specifications/java/X3DJSAIL.html" target="_blank">X3D Java Scene Access Interface Library (X3DJSAIL)</a>.
It has been produced using the
<a href="https://www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">X3dToJava.xslt</a>
stylesheet
(<a href="https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">version control</a>)
which is used to create Java source code from an original <code>.x3d</code> model.
</p>
* @author Don Brutzman, Estuko Lippi, Jeff Weekley, Jane Wu
*/
public class BooleanSequencerPrototype
{
/** Default constructor to create this object. */
public BooleanSequencerPrototype ()
{
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("BooleanSequencerPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("BooleanSequencer is modeled after ScalarInterpolator and generates true or false values."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman, Estuko Lippi, Jeff Weekley, Jane Wu"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("7 August 2001"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 January 2020"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#ScalarInterpolator"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("boolean sequencer"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Basic/development/BooleanSequencerPrototype.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("BooleanSequencerPrototype.x3d"))
.addChild(new ProtoDeclare("BooleanSequencer").setName("BooleanSequencer")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("set_fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Regular interpolator-style input, typical range [0..1]"))
.addField(new field().setName("set_key").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("key").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Array sequentially increasing typically [0..1]. Must have the same number of keys as keyValues.")
.addComments(" NULL initialization value "))
.addField(new field().setName("key_changed").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("set_keyValue").setType(field.TYPE_MFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("keyValue").setType(field.TYPE_MFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Array of true|false values. Must have the same number of keys as keyValues.")
.addComments(" NULL initialization value "))
.addField(new field().setName("keyValue_changed").setType(field.TYPE_MFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Regular interpolator-style input"))
.addField(new field().setName("value_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Regular interpolator-style input"))
.addField(new field().setName("previous").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Utility method"))
.addField(new field().setName("next").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Utility method")))
.setProtoBody(new ProtoBody()
.addChild(new Group()
.addChild(new ScalarInterpolator("KeyHolder")
.setIS(new IS()
.addConnect(new connect().setNodeField("key").setProtoField("key"))))
.addChild(new Anchor("KeyValueHolder")
.setIS(new IS()
.addConnect(new connect().setNodeField("description").setProtoField("keyValue"))))
.addChild(new Script("SequencerScript").setDirectOutput(true).setSourceCode("""
ecmascript:
var key, keyValue;
function initialize()
{
key = keyHolderNode.key;
keyValue = keyValueHolderNode.description;
tracePrint('key =' + key);
tracePrint('keyValue =' + keyValue);
keyValueToKeyValueArray ();
tracePrint('keyValueArray =' + keyValueArray);
forward = true;
tracePrint('Initializing a new BooleanSequencer. key.length=' + key.length + '; keyValueArray.length=' + keyValueArray.length);
validityCheck();
}
function keyValueToKeyValueArray ()
{
tracePrint('keyValueToKeyValueArray starting');
index = 0;
complete = false;
nextString = keyValue.toLowerCase();
tracePrint('initial nextString=' + nextString);
tokenCount=0;
while ((complete != true) && (nextString.length > 0))
{
tracePrint('nextString=' + nextString);
while ((nextString.substring(0,1) == ' ') || (nextString.substring(0,1) == ','))
nextString = nextString.slice(1);
tracePrint('deblanked nextString=' + nextString);
if (nextString.length == 0)
{
tracePrint ('nextString.length == 0');
complete = true;
}
if (nextString.length < 4)
{
alwaysPrint ('*** illegal keyValue input=' + nextString);
valid = false;
complete = true;
}
else if (nextString.substring(0,4) =='true')
{
keyValueArray[keyValueArray.length] = 1; // append
newString = nextString.slice(4);
nextString = newString;
tokenCount++;
tracePrint('found true, nextString=' + nextString + ', tokenCount=' + tokenCount);
}
else if (nextString.length < 5)
{
alwaysPrint ('*** illegal keyValue input=' + nextString);
valid = false;
complete = true;
}
else if (nextString.substring(0,5) =='false')
{
keyValueArray[keyValueArray.length] = 0; // append
newString = nextString.slice(5);
nextString = newString;
tokenCount++;
tracePrint('found false, nextString=' + nextString + ', tokenCount=' + tokenCount);
}
tracePrint(' intermediate keyValueArray=' + keyValueArray);
}
tracePrint('keyValueToKeyValueArray complete');
}
function set_fraction(value, timeStamp)
{
if (recheckValidity) validityCheck();
if (!valid) return; //BooleanSequencer ignored
tracePrint('fraction =' + value);
//Bounds checking
if (value < 0)
{
alwaysPrint('*** warning: fraction is less than 0. fraction reset to 0 ***');
value = 0;
}
else if (value > 1)
{
alwaysPrint('*** warning: fraction is greater than 1. fraction reset to 1 ***');
value = 1;
}
//Check animation direction
if (value < previousFraction && forward == true)
{
forward = false;
nextIndex = nextIndex - 1;
tracePrint('Animate backward');
}
else if (value > previousFraction && forward == false)
{
forward = true;
//nextIndex = 0;
tracePrint('Animate forward');
}
previousFraction = value;
if (forward == true)
{
for (i = nextIndex; i < key.length; i++)
{
if (value < key[i])
return;
nextIndex = i + 1;
tracePrint('nextIndex =' + nextIndex);
if (nextIndex < key.length)
{
if (value <= key[nextIndex])
{
//Fire event
if (keyValueArray[nextIndex-1] == 0)
value_changed = false;
else
value_changed = true;
tracePrint('value_changed eventOut is:' + value_changed);
}
}
else if (nextIndex == key.length)
{
//Fire event
if (keyValueArray[nextIndex-1] == 0)
value_changed = false;
else
value_changed = true;
tracePrint('value_changed eventOut is:' + value_changed);
}
else //nextIndex > key.length
{
//nextIndex = 0;
break;
}
}
}
else //backward
{
for (i = nextIndex; i > 0; i--)
{
if (value >= key[i])
return;
nextIndex = i - 1;
tracePrint('nextIndex =' + nextIndex);
if (nextIndex >= 0)
{
if (value >= key[nextIndex])
{
//Fire event
if (keyValueArray[nextIndex] == 0)
value_changed = false;
else
value_changed = true;
tracePrint('value_changed eventOut is:' + value_changed);
}
}
else //nextIndex < 0
{
//nextIndex = key.length;
break;
}
}
}
}
function set_key(value, timeStamp)
{
key = value;
keyHolderNode.key = key;
recheckValidity = true;
}
function set_keyValue(value, timeStamp)
{
keyValue = value;
keyValueHolderNode.description = keyValue;
recheckValidity = true;
keyValueToKeyValueArray ();
keyValue_changed = keyValue;
}
function validityCheck()
{
//Check if key & keyValueArray array length matches
if (key.length != keyValueArray.length)
{
alwaysPrint('*** error: key and keyValue arrays must be of the same length. BooleanSequencer ignored ***');
valid = false;
return;
}
//Check if key array has values in the range of [0..1] in an increasing order
if (key[0] < 0 || key[0] > 1)
{
alwaysPrint('*** error: key[0] value is NOT in the range of [0..1]. BooleanSequencer ignored ***');
valid = false;
return;
}
for (i = 1; i < key.length; i++)
{
if (key[i] < 0 || key[i] > 1)
{
alwaysPrint('*** error: key[' + i + '] value is NOT in the range of [0..1]. BooleanSequencer ignored ***');
valid = false;
return;
}
if (key[i] <= key [i-1])
{
alwaysPrint('*** error: values for key[] array must be listed in an increasing order. BooleanSequencer ignored ***');
valid = false;
return;
}
}
recheckValidity = false;
key_changed = key;
return;
}
function previous (SFBoolValue, timestamp)
{
nextIndex = nextIndex - 1;
if (nextIndex == 0) nextIndex = key.length - 1;
}
function next (SFBoolValue, timestamp)
{
nextIndex = nextIndex + 1;
if (nextIndex == key.length) nextIndex = 0;
}
function tracePrint(outputString)
{
if (traceEnabled) Browser.println ('[ BooleanSequencer ]' + outputString);
}
function alwaysPrint(outputString)
{
Browser.println ('[ BooleanSequencer ]' + outputString);
}
""")
.addComments(" Regular interpolator-style input ")
.addField(new field().setName("set_fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("typical range [0..1]"))
.addField(new field().setName("set_key").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Array sequentially increasing typically [0..1]. Must have the same number of keys as keyValues."))
.addField(new field().setName("keyHolderNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new ScalarInterpolator().setUSE("KeyHolder")))
.addField(new field().setName("key_changed").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("set_keyValue").setType(field.TYPE_MFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Array of true or false values. Must have the same number of keys as keyValues."))
.addField(new field().setName("keyValueHolderNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new Anchor().setUSE("KeyValueHolder")))
.addField(new field().setName("keyValue_changed").setType(field.TYPE_MFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addComments(" Regular interpolator-style output ")
.addField(new field().setName("value_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addComments(" Utility methods ")
.addField(new field().setName("previous").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("next").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addComments(" Script-specific interfaces, not needed for node definition ")
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.addField(new field().setName("keyValueArray").setType(field.TYPE_MFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addComments(" NULL initialization value "))
.addField(new field().setName("previousFraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0.0))
.addField(new field().setName("nextIndex").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
.addField(new field().setName("valid").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setValue(true))
.addField(new field().setName("recheckValidity").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.addField(new field().setName("forward").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true).setAppinfo("leftToRight"))
.addField(new field().setName("key").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY)
.addComments(" NULL initialization value "))
.addField(new field().setName("keyValue").setType(field.TYPE_MFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)
.addComments(" NULL initialization value "))
.setIS(new IS()
.addConnect(new connect().setNodeField("set_fraction").setProtoField("set_fraction"))
.addConnect(new connect().setNodeField("set_key").setProtoField("set_key"))
.addConnect(new connect().setNodeField("key_changed").setProtoField("key_changed"))
.addConnect(new connect().setNodeField("set_keyValue").setProtoField("set_keyValue"))
.addConnect(new connect().setNodeField("keyValue_changed").setProtoField("keyValue_changed"))
.addConnect(new connect().setNodeField("value_changed").setProtoField("value_changed"))
.addConnect(new connect().setNodeField("previous").setProtoField("previous"))
.addConnect(new connect().setNodeField("next").setProtoField("next")))))))
.addComments(" ===============Example============== ")
.addChild(new Anchor().setDescription("BooleanSequencerExample").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"BooleanSequencerExample.x3d","https://www.web3d.org/x3d/content/examples/Basic/development/BooleanSequencerExample.x3d","BooleanSequencerExample.wrl","https://www.web3d.org/x3d/content/examples/Basic/development/BooleanSequencerExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"BooleanSequencerPrototype","defines a prototype","","Click on this text to see","BooleanSequencerExample"," scene"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE)))
.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
* <a href="https://dzone.com/articles/java-copy-shallow-vs-deep-in-which-you-will-swim" target="_blank">shallow copy</a>
* of the X3D model.
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html">X3D</a>
* @return BooleanSequencerPrototype 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 <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#handleArguments-java.lang.String:A-">X3D.handleArguments(args)</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#validationReport--">X3D.validationReport()</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html">CommandLine</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html#USAGE">CommandLine.USAGE</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/ConfigurationProperties.html">ConfigurationProperties</a>
*/
public static void main(String args[])
{
System.out.println("Build this X3D model, showing validation diagnostics...");
X3D thisExampleX3dModel = new BooleanSequencerPrototype().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.development.BooleanSequencerPrototype\" 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.development.BooleanSequencerPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// development/BooleanSequencerPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "development/BooleanSequencerPrototype_JavaExport.x3d";
String filenameX3DV = "development/BooleanSequencerPrototype_JavaExport.x3dv";
String filenameJSON = "development/BooleanSequencerPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}