package Basic.Geospatial;
/*
Copyright (c) 1995-2023 held by the author(s). All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of the Web3D Consortium (https://www.web3d.org)
nor the names of its contributors may be used to endorse or
promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
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.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.
/**
*
Specification example: on-demand inlining via GeoInline for scene resource management.
Related links: A3_GeoInline.java source, A3_GeoInline catalog page, 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)
is used to create Java source code from an original .x3d
model.
* @author Martin Reddy SRI, original example
* @author Don Brutzman NPS, X3D encoding
*/
public class A3_GeoInline
{
/** Default constructor to create this object. */
public A3_GeoInline ()
{
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()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("A3_GeoInline.x3d"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Martin Reddy SRI, original example"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman NPS, X3D encoding"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("26 June 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("17 June 2020"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Specification example: on-demand inlining via GeoInline for scene resource management."))
.addMeta(new meta().setName(meta.NAME_WARNING ).setContent("GeoVRML 1.1 GeoInline functionality is embedded in X3D Inline node, GeoInline no longer supported in X3D."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.geovrml.org/1.0/doc/examples.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("originals/geoinlineTest.wrl"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("VRML 97 encoding http://www.geovrml.org/1.0/doc/examples/geoinline.wrl"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Basic/Geospatial/A3_GeoInline.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("A3_GeoInline.x3d"))
.addChild(new Group()
.addComments(" Original GeoVRML GeoInline node replaced by improved X3D Inline node ")
.addChild(new Inline("TestInline").setLoad(false).setUrl(new String[] {"BoxSimple.x3d","https://www.web3d.org/x3d/content/examples/Basic/Geospatial/BoxSimple.x3d","BoxSimple.wrl","https://www.web3d.org/x3d/content/examples/Basic/Geospatial/BoxSimple.wrl"}))
.addComments(" don't load TestInline until 'true' event sent "))
.addComments(" Two cones that are used to load and unload the URL for the box ")
.addChild(new Transform().setScale(0.5,0.5,0.5).setTranslation(2.0,1.0,0.0)
.addChild(new TouchSensor("LoadTrigger").setDescription("click to load inlined Box"))
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,0.0,0.0)))
.setGeometry(new Cone())))
.addChild(new Transform().setScale(0.5,0.5,0.5).setTranslation(1.5,1.2,0.3)
.addChild(new Shape()
.setGeometry(new Text().setLength(new double[] {0.0}).setString(new String[] {"Load Cube"})
.setFontStyle(new FontStyle()))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,0.6,0.3)))))
.addChild(new Transform().setRotation(1.0,0.0,0.0,3.1415).setScale(0.5,0.5,0.5).setTranslation(2.0,-1.0,0.0)
.addChild(new TouchSensor("UnLoadTrigger").setDescription("click to unload inlined Box"))
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,0.0,1.0)))
.setGeometry(new Cone())))
.addChild(new Transform().setScale(0.5,0.5,0.5).setTranslation(1.5,-1.5,0.3)
.addChild(new Shape()
.setGeometry(new Text().setLength(new double[] {0.0}).setString(new String[] {"Unload Cube"})
.setFontStyle(new FontStyle()))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.6,0.3,0.0)))))
.addComments(" a couple of scripts to process the events from clicking on the cones ")
.addChild(new Script("ReturnTrue").setSourceCode("""
ecmascript:
function set_value( value ) {
if ( value == true ) value_changed = true;
}
""")
.addField(new field().setName("set_value").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("value_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Script("ReturnFalse").setSourceCode("""
ecmascript:
function set_value( value ) {
if ( value == true ) value_changed = false;
}
""")
.addField(new field().setName("set_value").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("value_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ROUTE().setFromNode("LoadTrigger").setFromField("isActive").setToNode("ReturnTrue").setToField("set_value"))
.addChild(new ROUTE().setFromNode("ReturnTrue").setFromField("value_changed").setToNode("TestInline").setToField("set_load"))
.addChild(new ROUTE().setFromNode("UnLoadTrigger").setFromField("isActive").setToNode("ReturnFalse").setToField("set_value"))
.addChild(new ROUTE().setFromNode("ReturnFalse").setFromField("value_changed").setToNode("TestInline").setToField("set_load")));
}
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 A3_GeoInline 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 A3_GeoInline().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.Geospatial.A3_GeoInline\" 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.Geospatial.A3_GeoInline self-validation test results: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
}
}
}