package Savage.Tools.Animation;
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.Navigation.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* This prototype generates bathymetry based on the input data, and uses Extrusion as the output geometry (with some problems as a result).
Related links: Catalog page BathymetryGeneratorViaExtrusionPrototype, source BathymetryGeneratorViaExtrusionPrototype.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 Jane Wu
*/
public class BathymetryGeneratorViaExtrusionPrototype
{
/** Default constructor to create this object. */
public BathymetryGeneratorViaExtrusionPrototype ()
{
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("BathymetryGeneratorViaExtrusionPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This prototype generates bathymetry based on the input data, and uses Extrusion as the output geometry (with some problems as a result)."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Jane Wu"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("8 January 2002"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("bathymetry"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#Extrusion"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/BathymetryGeneratorViaExtrusionPrototype.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("BathymetryGeneratorViaExtrusionPrototype.x3d"))
.addChild(new ProtoDeclare("BathymetryGenerator").setName("BathymetryGenerator")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("positionArray").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFVec3f(new MFVec3f(new double[] {0.0,0.0,0.0,10.0,-4.0,0.0,25.0,-6.0,0.0,30.0,-8.0,5.0,38.0,-15.0,5.0,45.0,-18.0,5.0,55.0,-22.0,5.0,60.0,-25.0,15.0,60.0,-27.0,22.0,55.0,-30.0,35.0,48.0,-35.0,35.0,35.0,-35.0,35.0,25.0,-45.0,35.0,20.0,-55.0,35.0,15.0,-70.0,35.0,3.0,-70.0,35.0,-5.0,-72.0,40.0,-5.0,-75.0,50.0,0.0,-80.0,55.0,15.0,-75.0,55.0,30.0,-70.0,55.0,35.0,-60.0,55.0,40.0,-50.0,55.0,50.0,-34.0,55.0,65.0,-23.0,70.0}))))
.addField(new field().setName("timeArray").setType(field.TYPE_MFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new double[] {1.0,3.0,6.0,8.0,10.0,12.0,14.0,15.0,17.0,18.0,23.0,28.0,35.0,37.0,39.0,43.0,45.0,47.0,48.0,53.0,58.0,60.0,61.0,65.0,70.0}).setAppinfo("for future development"))
.addField(new field().setName("colorSchemeDepthRangeArray").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFVec2f(new MFVec2f(new double[] {0.0,-10.0,-10.0,-20.0,-20.0,-30.0,-30.0,-40.0,-40.0,-50.0,-50.0,-60.0,-60.0,-70.0,-70.0,-999999.0}))))
.addField(new field().setName("colorSchemeColorArray").setType(field.TYPE_MFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFColor(new MFColor(new double[] {1.0,1.0,0.2,0.6,1.0,1.0,0.0,1.0,1.0,0.2,0.6,0.2,1.0,0.0,1.0,0.56,0.0,0.32,0.2,0.3,0.7,0.0,0.0,1.0}))))
.addField(new field().setName("beamWidth").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(2))
.addField(new field().setName("surfaceTransparency").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0.25))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false)))
.setProtoBody(new ProtoBody()
.addChild(new Group()
.addChild(new Transform("Bathymetry"))
.addChild(new Script("BathymetryScript").setDirectOutput(true).setSourceCode("""
ecmascript:
function initialize()
{
bathyNodeIndex = 0;
spineIndex = 0;
position = positionArray[0];
spine[spineIndex] = new SFVec3f(position.x, 0, position.z);
scale[spineIndex] = new SFVec2f(1, Math.abs(position.y));
spineIndex++;
previousPosition = new SFVec3f(position.x, position.y, position.z);
//Determine the initial depth range
for (j = 0; j < colorSchemeDepthRangeArray.length; j++)
{
if (position.y >= colorSchemeDepthRangeArray[j].y)
break;
}
currentDepthRangeIndex = j;
for (i = 1; i < positionArray.length; i++)
{
if (previousPosition.y == colorSchemeDepthRangeArray[currentDepthRangeIndex].y &&
positionArray[i].y != colorSchemeDepthRangeArray[currentDepthRangeIndex].y)
terminateExtrusionSegmentWithCurrentPosition(currentDepthRangeIndex);
//Update new position
position = positionArray[i];
//Determine the correct depth range
if (position.y <= previousPosition.y)
{
for (j = currentDepthRangeIndex; j < colorSchemeDepthRangeArray.length; j++)
{
if (position.y >= colorSchemeDepthRangeArray[j].y)
break;
if (previousPosition.y != colorSchemeDepthRangeArray[currentDepthRangeIndex].y)
terminateExtrusionSegmentWithDepthRangeBoundary(currentDepthRangeIndex);
}
currentDepthRangeIndex = j;
}
else
{
for (j = currentDepthRangeIndex; j > -1; j--)
{
if (position.y < colorSchemeDepthRangeArray[j-1].y)
break;
if (position.y > colorSchemeDepthRangeArray[j-1].y)
terminateExtrusionSegmentWithDepthRangeBoundary(j-1);
}
currentDepthRangeIndex = j;
}
spine[spineIndex] = new SFVec3f(position.x, 0, position.z);
scale[spineIndex] = new SFVec2f(1, Math.abs(position.y));
spineIndex++;
previousPosition = new SFVec3f(position.x, position.y, position.z);
}
terminateExtrusionSegmentWithCurrentPosition(currentDepthRangeIndex);
}
function terminateExtrusionSegmentWithDepthRangeBoundary(index)
{
depthRange = colorSchemeDepthRangeArray[index];
findCoordinate(previousPosition.x, position.x, previousPosition.y, position.y, depthRange.y);
xPrime = coordinate;
findCoordinate(previousPosition.z, position.z, previousPosition.y, position.y, depthRange.y);
zPrime = coordinate;
spine[spineIndex] = new SFVec3f(xPrime, 0, zPrime);
scale[spineIndex] = new SFVec2f(1, Math.abs(depthRange.y));
if (scale[scale.length-2].y > scale[scale.length-1].y)
color = colorSchemeColorArray[index+1];
else
color = colorSchemeColorArray[index];
createExtrusionShape(spine, scale, color);
//Reset values to start the next extrustion segment
spineIndex = 0;
resetSpine();
resetScale();
//Update the current segment end as the start of the next segment
spine[spineIndex] = new SFVec3f(xPrime, 0, zPrime);
scale[spineIndex] = new SFVec2f(1, Math.abs(depthRange.y));
spineIndex++;
}
function terminateExtrusionSegmentWithCurrentPosition(index)
{
if (scale[scale.length-1].y != Math.abs(colorSchemeDepthRangeArray[index].y))
index--;
if (scale[scale.length-2].y > scale[scale.length-1].y)
color = colorSchemeColorArray[index+1];
else
color = colorSchemeColorArray[index];
createExtrusionShape(spine, scale, color);
//Reset values to start the next extrustion segment
spineIndex = 0;
resetSpine();
resetScale();
//Update the current segment end as the start of the next segment
spine[spineIndex] = new SFVec3f(position.x, 0, position.z);
scale[spineIndex] = new SFVec2f(1, Math.abs(position.y));
spineIndex++;
//Update the previousPosition
previousPosition = new SFVec3f(position.x, position.y, position.z);
}
function findCoordinate(x1, x2, y1, y2, yPrime)
{
coordinate = ((x1 - x2) / (y1 - y2)) * yPrime + ((x2*y1 - x1*y2) / (y1 - y2));
}
function createExtrusionShape(spine, scale, color)
{
determineOrientation(spine);
tracePrint('An extrusion is created whose spine is: ' + spine);
tracePrint('and scale is: ' + scale);
tracePrint('orientation is: ' + orientation);
tracePrint('color is: ' + color);
alwaysPrint('number of spine points is: ' + spine.length);
alwaysPrint('orientation is: ' + orientation);
//Build the VRML string
extrusionSyntax = 'Shape {\n';
extrusionSyntax += ' appearance Appearance {' + '\n';
extrusionSyntax += ' material Material {' + '\n';
extrusionSyntax += ' diffuseColor ' + color + '\n';
extrusionSyntax += ' transparency ' + transparency + '\n';
extrusionSyntax += ' }' + '\n';
extrusionSyntax += ' }' + '\n';
extrusionSyntax += ' geometry Extrusion {' + '\n';
extrusionSyntax += ' crossSection [' + (beamWidth/(-2)) + ', 1, ' + (beamWidth/2) + ', 1, ' + (beamWidth/(-2)) + ', 1]' + '\n';
extrusionSyntax += ' scale ' + scale + '\n';
extrusionSyntax += ' spine ' + spine + '\n';
extrusionSyntax += ' orientation ' + orientation + '\n';
extrusionSyntax += ' creaseAngle 1.57' + '\n';
extrusionSyntax += ' }' + '\n';
extrusionSyntax += '}';
//Create Extrusion shape
tracePrint (extrusionSyntax);
bathySegment = new SFNode(extrusionSyntax);
bathyNodes[bathyNodeIndex] = bathySegment;
bathyNodeIndex++;
}
function determineOrientation(spine)
{
previousZAxis = null;
orientation = new MFRotation();
//Special cases
if (spine.length == 2)
{
if (spine[0].z == spine[1].z)
{
if (spine[0].x <= spine[1].x) //positive x direction
orientation[0] = orientation[1] = new SFRotation(0, 1, 0, 1.57);
else //negative x direction
orientation[0] = orientation[1] = new SFRotation(0, 1, 0, -1.57);
}
else
{
if (spine[0].x == spine[1].x) //parallet to the z axis
orientation[0] = orientation[1] = new SFRotation(0, 1, 0, 0);
else
{
angleRadian = Math.atan((spine[0].x- spine[1].x) / (spine[0].z - spine[1].z));
// angleRadian = Math.atan2((spine[0].x- spine[1].x), (spine[0].z - spine[1].z));
orientation[0] = orientation[1] = new SFRotation(0, 1, 0, angleRadian);
}
}
return;
}
for (n = 0; n < spine.length; n++)
{
//If spine is not closed, the Z axis used for the first spine point is the same as the Z axis for spine[1].
//The Z axis used for the last spine point is the same as the Z axis for spine[spine.length - 2].
if (n == 0)
si = 1;
else if (n == (spine.length - 1))
si = spine.length - 2;
else
si = n;
zAxis = (spine[si+1].subtract(spine[si])).cross((spine[si-1].subtract(spine[si])));
while (zAxis.x == 0 && zAxis.y == 0 && zAxis.z == 0)
{
if (previousZAxis == null)
{
++si;
if (si == (spine.length - 1)) //The entire spine is collinear
{
zAxis = new SFVec3f(1, 0, 0);
break;
}
zAxis = (spine[si+1].subtract(spine[si])).cross((spine[si-1].subtract(spine[si])));
}
else
zAxis = new SFVec3f(previousZAxis.x, previousZAxis.y, previousZAxis.z);
}
adjustedZAxis = zAxis;
if (n == 0)
previousZAxis = zAxis;
else
{
dotProduct = zAxis.dot(previousZAxis);
if (dotProduct < 0)
adjustedZAxis = new SFVec3f(zAxis.multiply(-1).x, zAxis.multiply(-1).y, zAxis.multiply(-1).z);
previousZAxis = adjustedZAxis;
}
zAxisNormalized = adjustedZAxis.normalize();
theta = Math.acos(zAxisNormalized.dot(new SFVec3f(0, -1, 0)));
if (spine[1].x < spine[0].x)
orientation[n] = new SFRotation(0, -1, 0, theta);
else
orientation[n] = new SFRotation(0, 1, 0, theta);
}
if (theta == 0)
Browser.println ('rotation angle = ' + theta);
else if (theta > 1.57 && theta < 3.14)
Browser.println ('rotation angle = ' + theta);
else if (theta > 3.14)
Browser.println ('rotation angle = ' + theta);
}
function resetSpine()
{
spine = new MFVec3f();
}
function resetScale()
{
scale = new MFVec2f();
}
function tracePrint(string)
{
if (traceEnabled)
Browser.println ('[BathymetryGenerator] ' + string);
}
function alwaysPrint(string)
{
Browser.println ('[BathymetryGenerator] ' + string);
}
""")
.addField(new field().setName("positionArray").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("timeArray").setType(field.TYPE_MFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("colorSchemeDepthRangeArray").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("colorSchemeColorArray").setType(field.TYPE_MFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("beamWidth").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("transparency").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("spine").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFVec3f(new MFVec3f(new double[] {0.0,0.0,0.0,0.0,1.0,0.0}))))
.addField(new field().setName("scale").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFVec2f(new MFVec2f(new double[] {1.0,1.0}))))
.addField(new field().setName("orientation").setType(field.TYPE_MFROTATION).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFRotation(new MFRotation(new double[] {0.0,0.0,1.0,0.0}))))
.addField(new field().setName("bathyColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFColor(1.0,1.0,1.0)))
.addField(new field().setName("bathyNodes").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("coordinate").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("previousPosition").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("position").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("bathyNodeIndex").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
.setIS(new IS()
.addConnect(new connect().setNodeField("positionArray").setProtoField("positionArray"))
.addConnect(new connect().setNodeField("timeArray").setProtoField("timeArray"))
.addConnect(new connect().setNodeField("colorSchemeDepthRangeArray").setProtoField("colorSchemeDepthRangeArray"))
.addConnect(new connect().setNodeField("colorSchemeColorArray").setProtoField("colorSchemeColorArray"))
.addConnect(new connect().setNodeField("beamWidth").setProtoField("beamWidth"))
.addConnect(new connect().setNodeField("transparency").setProtoField("surfaceTransparency"))
.addConnect(new connect().setNodeField("traceEnabled").setProtoField("traceEnabled"))))
.addChild(new ROUTE().setFromNode("BathymetryScript").setFromField("bathyNodes").setToNode("Bathymetry").setToField("addChildren"))
.addChild(new Shape()
.setGeometry(new Extrusion())))))
.addChild(new Viewpoint().setDescription("MainView").setPosition(0.0,-50.0,200.0))
.addChild(new ProtoInstance("BathymetryGenerator").setContainerField("children")
.addFieldValue(new fieldValue().setName("positionArray").setValue(new MFVec3f(new MFVec3f(new double[] {0.0,0.0,0.0,10.0,-4.0,0.0,25.0,-6.0,0.0,30.0,-8.0,5.0,38.0,-15.0,5.0,45.0,-18.0,5.0,55.0,-22.0,5.0,60.0,-25.0,15.0,60.0,-27.0,22.0,55.0,-30.0,35.0,48.0,-35.0,35.0,35.0,-35.0,35.0,25.0,-45.0,35.0,20.0,-55.0,35.0,15.0,-70.0,35.0,3.0,-70.0,35.0,-5.0,-72.0,40.0,-5.0,-75.0,50.0,0.0,-80.0,55.0,15.0,-75.0,55.0,30.0,-70.0,55.0,35.0,-60.0,55.0,40.0,-50.0,55.0,50.0,-34.0,55.0,65.0,-23.0,70.0}))))
.addFieldValue(new fieldValue().setName("surfaceTransparency").setValue(0.25))
.addFieldValue(new fieldValue().setName("traceEnabled").setValue(true))));
}
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 BathymetryGeneratorViaExtrusionPrototype 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 BathymetryGeneratorViaExtrusionPrototype().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.BathymetryGeneratorViaExtrusionPrototype\" 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.BathymetryGeneratorViaExtrusionPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/BathymetryGeneratorViaExtrusionPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/BathymetryGeneratorViaExtrusionPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/BathymetryGeneratorViaExtrusionPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/BathymetryGeneratorViaExtrusionPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}