package X3dForWebAuthors.KelpForestExhibit;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.EnvironmentalSensor.*;
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.Rendering.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* A Fog node that adjusts as the viewer's orientation and position changes. This is a good candidate to become a Prototype since Fog does not automatically bind when inlined.
Related links: Catalog page ChangingFog, source ChangingFog.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 Matthew Braun
*/
public class ChangingFog
{
/** Default constructor to create this object. */
public ChangingFog ()
{
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()
.addComments(" javascript code for rotation calculations was derived from: ")
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("ChangingFog.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("A Fog node that adjusts as the viewer's orientation and position changes. This is a good candidate to become a Prototype since Fog does not automatically bind when inlined."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Matthew Braun"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("20 September 2001"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://astronomy.swin.edu.au/pbourke/geometry/rotate/"))
.addMeta(new meta().setName(meta.NAME_RIGHTS ).setContent("Copyright (c) Matthew Braun 2001"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("Fog"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/ChangingFog.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("ChangingFog.x3d"))
.addChild(new NavigationInfo().setAvatarSize(new double[] {0.01,0.0,0.0}))
.addChild(new Viewpoint().setDescription("Start").setFieldOfView(0.9).setPosition(0.0,0.0,0.0))
.addChild(new Viewpoint().setDescription("Looking up from start").setOrientation(1.0,0.0,0.0,1.57).setPosition(0.0,0.0,0.0))
.addChild(new Viewpoint().setDescription("10m above, looking straight up").setOrientation(1.0,0.0,0.0,1.57).setPosition(0.0,10.0,0.0))
.addChild(new Viewpoint().setDescription("10m above start").setPosition(0.0,10.0,0.0))
.addChild(new Viewpoint().setDescription("10m above, looking straight down").setOrientation(1.0,0.0,0.0,-1.57).setPosition(0.0,10.0,0.0))
.addChild(new Viewpoint().setDescription("10m below, looking down").setOrientation(1.0,0.0,0.0,-1.57).setPosition(0.0,-10.0,0.0))
.addChild(new Viewpoint().setDescription("10m below start").setPosition(0.0,-10.0,0.0))
.addChild(new Viewpoint().setDescription("10m below, looking up").setOrientation(1.0,0.0,0.0,1.57).setPosition(0.0,-10.0,0.0))
.addChild(new Fog("Water").setColor(0.2,0.2,0.4).setFogType("EXPONENTIAL"))
.addComments(" Proximity sensor must be large enough to encompass the entire scene ")
.addChild(new ProximitySensor("ProxSensor").setSize(1000.0,1000.0,1000.0))
.addComments(" TimeSensor triggering reduces frequency of calculations for performance reasons. ")
.addChild(new TimeSensor("Clock").setLoop(true))
.addChild(new Script("ChangeVisibility").setSourceCode("""
ecmascript:
// REF: http://astronomy.swin.edu.au/pbourke/geometry/rotate/
function initialize () {
visibility = 20;
depth = 0;
pos = (0,0,0);
Browser.println ('Position output from ProximitySensor.');
}
function get_clock_hit (clock_msg) {
run_script = true;
}
function get_depth ( position ) {
pos = position;
depth = position[1] - 30;
}
function set_visibility( rotation ) {
if (run_script) {
//z coordinate of the default viewpoint direction(0,0,-1)
initZ = -1;
rX = rotation[0]; // x coordinate of the rotation
rY = rotation[1]; // y coordinate of the rotation
rZ = rotation[2]; // z coordinate of the rotation
theta = rotation[3]; // angle of rotation in radians
Browser.println ('theta:' + theta);
cosTheta = Math.cos(theta);
sinTheta = Math.sin(theta);
Browser.println ('cosTheta:' + cosTheta + ' sinTheta:'+ sinTheta);
// calculate the y coordinate of the point after rotation
/* there are 8 other terms in the full conversion, but 6 are equal
to zero because of the choice of a starting point on the z-axis. The
other two are not calculated since all we need is the y coordinate
*/
finalY = ((1 - cosTheta) * rY * rZ - rX * sinTheta) * initZ;
Browser.println ('final y:' + finalY);
//calculate the elevation/depression angle of the final point location
elevation = Math.asin(finalY);
Browser.println ('elevation:' + elevation);
directionFactor = 1 + 0.2 * (4 * elevation / Math.PI);
depthAdjust = (60 + depth)/60
depthFactor = Math.max(depthAdjust,0.05);
visibility_changed = 60 * depthFactor * directionFactor;
Browser.println ('depth=' + depth + ', elevation=' + elevation +
', visibility_changed=' + visibility_changed);
run_script = false;
}
}
""")
.addField(new field().setName("get_clock_hit").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("run_script").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.addField(new field().setName("get_depth").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("visibility_changed").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("set_visibility").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addComments(" "))
.addChild(new ROUTE().setFromNode("Clock").setFromField("cycleTime").setToNode("ChangeVisibility").setToField("get_clock_hit"))
.addChild(new ROUTE().setFromNode("ProxSensor").setFromField("position_changed").setToNode("ChangeVisibility").setToField("get_depth"))
.addChild(new ROUTE().setFromNode("ProxSensor").setFromField("orientation_changed").setToNode("ChangeVisibility").setToField("set_visibility"))
.addChild(new ROUTE().setFromNode("ChangeVisibility").setFromField("visibility_changed").setToNode("Water").setToField("visibilityRange"))
.addComments(" A set of arrows is used to show visibility and direction ")
.addChild(new Transform("Pointer").setTranslation(0.0,0.0,-15.0)
.addChild(new Transform().setTranslation(0.0,4.0,0.0)
.addChild(new Shape()
.setGeometry(new Cone().setBottomRadius(0.4))
.setAppearance(new Appearance("ShapeApp")
.setMaterial(new Material().setAmbientIntensity(0.8).setDiffuseColor(1.0,1.0,0.3).setShininess(0.6)))))
.addChild(new Shape()
.setGeometry(new Cylinder().setHeight(6).setRadius(0.2))
.setAppearance(new Appearance().setUSE("ShapeApp"))))
.addChild(new Transform().setTranslation(0.0,10.0,0.0)
.addChild(new Transform().setUSE("Pointer")))
.addChild(new Transform().setTranslation(0.0,-10.0,0.0)
.addChild(new Transform().setUSE("Pointer")))
.addComments(" A pair of disks used to show visibility ")
.addChild(new Transform().setTranslation(0.0,15.0,0.0)
.addChild(new Shape("Disk")
.setGeometry(new Cylinder().setHeight(0.01))
.setAppearance(new Appearance().setUSE("ShapeApp"))))
.addChild(new Transform().setTranslation(0.0,-15.0,0.0)
.addChild(new Shape().setUSE("Disk")))
.addComments(" An indexed face set box used to bound the working area ")
.addChild(new Transform().setScale(20.0,20.0,20.0)
.addChild(new Shape("IFSBox")
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,1.0)))
.setGeometry(new IndexedFaceSet().setCcw(false).setColorPerVertex(false).setColorIndex(new int[] {0,2,2,2,2,1}).setCoordIndex(new int[] {0,1,2,3,-1,7,6,5,4,-1,0,4,5,1,-1,1,5,6,2,-1,2,6,7,3,-1,3,7,4,0})
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,-1.0,-1.0,1.0,-1.0,-1.0,-1.0,1.0,1.0,-1.0,1.0,1.0,-1.0,-1.0,-1.0,-1.0,-1.0})))
.setColor(new Color().setColor(new MFColor(new double[] {1.0,1.0,1.0,0.0,0.0,0.0,0.2,0.2,0.8})))))));
}
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 ChangingFog 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 ChangingFog().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: \"X3dForWebAuthors.KelpForestExhibit.ChangingFog\" 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("X3dForWebAuthors.KelpForestExhibit.ChangingFog self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// KelpForestExhibit/ChangingFog_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "KelpForestExhibit/ChangingFog_JavaExport.x3d";
String filenameX3DV = "KelpForestExhibit/ChangingFog_JavaExport.x3dv";
String filenameJSON = "KelpForestExhibit/ChangingFog_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}