package X3dForWebAuthors.Chapter08UserInteractivity;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
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.Networking.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Shape.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Using a separate SphereSensor, Lefty shark can be oriented in any direction by remote control. Navigation locked so that no other scene rotation is possible.
Related links: Catalog page SphereSensorLefty, source SphereSensorLefty.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 Leonard Daly and Don Brutzman
*/
public class SphereSensorLefty
{
/** Default constructor to create this object. */
public SphereSensorLefty ()
{
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("SphereSensorLefty.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Using a separate SphereSensor, Lefty shark can be oriented in any direction by remote control. Navigation locked so that no other scene rotation is possible."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Leonard Daly and Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("10 June 2006"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_WARNING ).setContent("Xj3D not supporting SphereSensor autoOffset field correctly"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://X3dGraphics.com"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/X3dResources.html"))
.addMeta(new meta().setName(meta.NAME_RIGHTS ).setContent("Copyright 2006, Leonard Daly and Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("X3D book, X3D graphics, X3D-Edit, http://www.x3dGraphics.com"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter08UserInteractivity/SphereSensorLefty.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("SphereSensorLefty.x3d"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {1.0,1.0,1.0})))
.addChild(new NavigationInfo("LockUserSceneRotation").setType("\"NONE\""))
.addChild(new Viewpoint().setDescription("Book View").setOrientation(0.0,-1.0,0.0,0.05).setPosition(-0.06,-0.29,8.78))
.addChild(new Transform("UserInterfaceTranslation").setTranslation(2.0,-2.0,3.0)
.addComments(" Note that splitting the single Transform into two, and embedding SphereSensor here, shields it from affecting other nodes in scene ")
.addChild(new SphereSensor("Rotator").setDescription("drag sphere to rotate Lefty"))
.addComments(" this nested Transform allows rotation about the center of the local coordinate frame ")
.addChild(new Transform("UserInterfaceRotation")
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,0.0,1.0)))
.setGeometry(new Sphere().setRadius(.5)))))
.addComments(" note that the shark is translated to a different coordinate reference frame, so the SphereSensor is like a remote control ")
.addChild(new Transform("SharkRotation").setTranslation(0.0,0.0,7.0)
.addChild(new Inline().setUrl(new String[] {"../KelpForestExhibit/SharkLefty.x3d","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/SharkLefty.x3d","../KelpForestExhibit/SharkLefty.wrl","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/SharkLefty.wrl"})))
.addChild(new ROUTE().setFromNode("Rotator").setFromField("rotation_changed").setToNode("SharkRotation").setToField("rotation"))
.addComments(" note that the shark will rotate without this ROUTE but that user interaction feels smoother and more natural ")
.addChild(new ROUTE().setFromNode("Rotator").setFromField("rotation_changed").setToNode("UserInterfaceRotation").setToField("rotation")));
}
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 SphereSensorLefty 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 SphereSensorLefty().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.Chapter08UserInteractivity.SphereSensorLefty\" 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.Chapter08UserInteractivity.SphereSensorLefty self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter08UserInteractivity/SphereSensorLefty_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter08UserInteractivity/SphereSensorLefty_JavaExport.x3d";
String filenameX3DV = "Chapter08UserInteractivity/SphereSensorLefty_JavaExport.x3dv";
String filenameJSON = "Chapter08UserInteractivity/SphereSensorLefty_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}