package Basic.development;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
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.*;
import org.web3d.x3d.jsail.Texturing.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* <p> PositionInterpolator2D prototype declaration to pairwise interpolate across an array of Vector2Float/SFVec2f values to produce a single Vector2Float value - click text to see example. </p>
<p> Related links: Catalog page <a href="../../../development/PositionInterpolator2dPrototypeIndex.html" target="_blank">PositionInterpolator2dPrototype</a>, source <a href="../../../development/PositionInterpolator2dPrototype.java">PositionInterpolator2dPrototype.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/PositionInterpolator2dPrototype.x3d">PositionInterpolator2dPrototype.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
<td> PositionInterpolator2D prototype declaration to pairwise interpolate across an array of Vector2Float/SFVec2f values to produce a single Vector2Float value - click text to see example. </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
<td> Don Brutzman, Jeff Weekley, Jane Wu </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
<td> 16 October 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/concepts.html#4.6.8" target="_blank">https://www.web3d.org/technicalinfo/specifications/vrml97/part1/concepts.html#4.6.8</a> </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#CoordinateInterpolator" target="_blank">https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#CoordinateInterpolator</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> subject </i> </td>
<td> PositionInterpolator2D </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/PositionInterpolator2dPrototype.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/development/PositionInterpolator2dPrototype.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, Jeff Weekley, Jane Wu
*/
public class PositionInterpolator2dPrototype
{
/** Default constructor to create this object. */
public PositionInterpolator2dPrototype ()
{
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("PositionInterpolator2dPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("PositionInterpolator2D prototype declaration to pairwise interpolate across an array of Vector2Float/SFVec2f values to produce a single Vector2Float value - click text to see example."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman, Jeff Weekley, Jane Wu"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("16 October 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/concepts.html#4.6.8"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#CoordinateInterpolator"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("PositionInterpolator2D"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Basic/development/PositionInterpolator2dPrototype.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("PositionInterpolator2dPrototype.x3d"))
.addChild(new ProtoDeclare("PositionInterpolator2D").setName("PositionInterpolator2D").setAppinfo("Provide interpolation capability for Vector2Float/SFVec2f values").setDocumentation("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/concepts.html#4.6.8")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("set_fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("The set_fraction eventIn receives an SFFloat event and causes the interpolator function to evaluate resulting in a value_changed eventOut with the same timestamp as the set_fraction event.")
.addComments(" Regular interpolator-style input "))
.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("keyValue holds the array of Vector2FloatArrays that match each animation key.")
.addComments(" initial value is [] null array "))
.addField(new field().setName("key_changed").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Array sequentially increasing typically [0..1]. Must have the same number of keys as keyValues."))
.addField(new field().setName("set_keyValue").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Array of integer values. Must have the same number of keys as keyValues."))
.addField(new field().setName("keyValue").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("keyValue holds the array of Vector2Float values that match each animation key.")
.addComments(" initial value is [] null array "))
.addField(new field().setName("keyValue_changed").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Array of integer values. Must have the same number of keys as keyValues."))
.addField(new field().setName("value_changed").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("The interpolator function averages between respective keyValue Vector2Floats resulting in a Vector2Float value_changed eventOut with the same timestamp as the set_fraction event.")
.addComments(" Regular interpolator-style output ")))
.setProtoBody(new ProtoBody()
.addChild(new Group()
.addChild(new Switch().setWhichChoice(-1)
.addChild(new ScalarInterpolator("KeyHolder")
.setIS(new IS()
.addConnect(new connect().setNodeField("key").setProtoField("key"))))
.addChild(new Shape()
.setGeometry(new IndexedFaceSet()
.setTexCoord(new TextureCoordinate("KeyValueHolder")
.setIS(new IS()
.addConnect(new connect().setNodeField("point").setProtoField("keyValue")))))
.setAppearance(new Appearance("SilenceWarnings"))))
.addChild(new Script("InterpolationScript").setDirectOutput(true).setSourceCode("""
ecmascript:
// internal global persistent variables
var previousFraction;
var previousFractionIndex;
var blockSize;
var outputArray;
var traceEnabled = false;
function tracePrint (outputString)
{
if (traceEnabled) Browser.println ('[PositionInterpolator2d]' + outputString);
}
function alwaysPrint (outputString)
{
Browser.println ('[PositionInterpolator2d]' + outputString);
}
function initialize ()
{
key = keyHolderNode.key;
keyValue = keyValueHolderNode.point;
previousFractionIndex = -1;
previousFraction = 0;
// check key array ranges [0..1] and is monotonically increasing
// check that size of keyValue array is integer multiple of size of key array
tracePrint ('key =' + key);
tracePrint ('key.length=' + key.length);
tracePrint ('keyValue= ' + keyValue);
tracePrint ('keyValue.length=' + keyValue.length);
blockSize = keyValue.length/key.length;
tracePrint ('blockSize=' + blockSize);
if (blockSize != 1)
{
alwaysPrint ('*** warning: check sizes of key and keyValue, should be identical!');
}
if (key[0] != 0)
{
alwaysPrint ('*** warning: key[0] != 0');
}
if (key[key.length-1] != 1)
{
alwaysPrint ('*** warning: key[' + (key.length - 1) + '] != 1, reset from' + key[key.length-1] + ' to 1');
key[key.length-1] = 1;
}
for (index = 0; index < key.length; index++)
{
if ((key[index] < 0) || (key[index] > 1))
{
alwaysPrint ('*** warning: key[' + index + '] =' + key[index] + ', out of range [0..1]');
}
}
}
function set_fraction (inputFloat, timestamp) {
fraction = inputFloat;
outputResult = new SFVec2f ();
tracePrint ('previousFractionIndex=' + previousFractionIndex
+ ', fraction=' + fraction + ', previousFraction=' + previousFraction);
if (fraction < 0)
{
tracePrint ('*** illegal fraction' + fraction + ' set to 0');
fraction = 0;
previousFractionIndex = 0; // first
}
else if (fraction > 1)
{
alwaysPrint ('*** illegal fraction' + fraction + ' set to 1');
fraction = 1;
previousFractionIndex = key.length - 1; // last
}
else if (previousFractionIndex == -1)
{
previousFractionIndex = 0; // first
tracePrint ('previousFractionIndex initialized for first event');
}
else if ((fraction >= previousFraction) && (fraction >= key[previousFractionIndex+1]))
{
previousFractionIndex++;
}
else if (fraction < previousFraction) // regress, or loop repeat without reaching one
{
previousFractionIndex = 0;
while ((fraction >= key[previousFractionIndex+1]) && (previousFractionIndex < blockSize))
{
previousFractionIndex++;
}
tracePrint ('reset/reincrement previousFractionIndex to' + previousFractionIndex);
}
if (fraction == 1) // use final block
{
tracePrint ('(fraction == 1)');
// update outputResult with final keyValue
outputResult = keyValue[keyValue.length];
previousFractionIndex = -1; // setup for restart
tracePrint ('finished final fraction==1 block');
}
// when fraction matches index, calculate value_changed from corresponding keyValue array
else if (fraction == key[previousFractionIndex])
{
tracePrint ('(fraction == key[previousFractionIndex])');
// update outputResult with corresponding keyValue
outputResult = keyValue[previousFractionIndex];
}
else // calculate value_changed by interpolating between adjacent keyValue arrays
{
partialFraction = fraction - key[previousFractionIndex];
deltaFraction = key[previousFractionIndex+1] - key[previousFractionIndex];
percentFraction = partialFraction / deltaFraction;
// tracePrint ('deltaFraction =' + deltaFraction);
// tracePrint ('partialFraction =' + partialFraction);
tracePrint ('percentFraction =' + percentFraction);
// no arithmetic operators provided for SFVec2f, treat element by element
nextKeyValue = keyValue[previousFractionIndex + 1];
priorKeyValue = keyValue[previousFractionIndex];
tracePrint (' nextKeyValue =' + nextKeyValue);
tracePrint ('priorKeyValue =' + priorKeyValue);
deltaKeyValue = new SFVec2f ( nextKeyValue[0] - priorKeyValue[0],
nextKeyValue[1] - priorKeyValue[1]);
// tracePrint ('deltaKeyValue =' + deltaKeyValue);
// update outputResult
outputResult[0] = keyValue[previousFractionIndex][0]
+ percentFraction * deltaKeyValue[0];
outputResult[1] = keyValue[previousFractionIndex][1]
+ percentFraction * deltaKeyValue[1];
}
value_changed = outputResult;
previousFraction = fraction;
tracePrint ('value_changed=' + value_changed);
}
function set_key (inputArray, timestamp) {
key = inputArray; // update key Vector2FloatArray
keyHolderNode.key = key; // update holder
initialize (timestamp); // reverify key, keyValue sizes
}
function set_keyValue (inputArray, timestamp) {
keyValue = inputArray; // update keyValue Vector2FloatArray
keyValueHolderNode.point = keyValue; // update holder
initialize (timestamp); // reverify key, keyValue sizes
}
""")
.addComments(" Regular interpolator-style input ")
.addField(new field().setName("set_fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0).setAppinfo("local variable"))
.addField(new field().setName("set_key").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.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_MFVEC2F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("keyValueHolderNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new TextureCoordinate().setUSE("KeyValueHolder")))
.addField(new field().setName("keyValue_changed").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addComments(" Regular interpolator-style output ")
.addField(new field().setName("value_changed").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.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")))))))
.addComments(" ====================================== ")
.addComments(" Example use ")
.addChild(new Anchor().setDescription("PositionInterpolator2D Example").setUrl(new String[] {"PositionInterpolator2dExample.x3d","https://www.web3d.org/x3d/content/examples/Basic/development/PositionInterpolator2dExample.x3d","PositionInterpolator2dExample.wrl","https://www.web3d.org/x3d/content/examples/Basic/development/PositionInterpolator2dExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"PositionInterpolator2dPrototype","defines a prototype","","Click text to see","PositionInterpolator2dExample"," 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
* <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 PositionInterpolator2dPrototype 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 PositionInterpolator2dPrototype().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.PositionInterpolator2dPrototype\" 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.PositionInterpolator2dPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// development/PositionInterpolator2dPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "development/PositionInterpolator2dPrototype_JavaExport.x3d";
String filenameX3DV = "development/PositionInterpolator2dPrototype_JavaExport.x3dv";
String filenameJSON = "development/PositionInterpolator2dPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}