package Savage.Weapons.UnderwaterMines;
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.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Underwater mine prototype SphericalMine. Note level of detail (LOD) transitions when seen at transition ranges.
Related links: Catalog page SphericalMinePrototype, source SphericalMinePrototype.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 Don Brutzman
*/
public class SphericalMinePrototype
{
/** Default constructor to create this object. */
public SphericalMinePrototype ()
{
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("SphericalMinePrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Underwater mine prototype SphericalMine. Note level of detail (LOD) transitions when seen at transition ranges."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("26 June 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("2 September 2024"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Weapons/UnderwaterMines/SphericalMinePrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0, https://www.web3d.org/x3d/tools/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../../license.html")))
.setScene(new Scene()
.addComments(" SphericalMine is a simple notional mine ")
.addChild(new WorldInfo().setTitle("SphericalMinePrototype.x3d"))
.addChild(new ProtoDeclare("SphericalMine").setName("SphericalMine").setAppinfo("Spherical floating mine moored to bottom")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue("10 m: Spherical Mine").setAppinfo("Description for each mine contact."))
.addField(new field().setName("color").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(.8,.8,.8)).setAppinfo("Mine color can be used to indicate status (found/unknown/disabled/) tactic etc."))
.addField(new field().setName("translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(0.0,0.0,0.0)).setAppinfo("Location of mine center in local world coordinates."))
.addField(new field().setName("scale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(1.0,1.0,1.0)).setAppinfo("Scale factor to change spherical mine size default diameter = 1m."))
.addField(new field().setName("bboxCenter").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)).setAppinfo("Bounding box for collision detection of mine."))
.addField(new field().setName("tetherPoints").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new MFVec3f(new MFVec3f(new double[] {0.0,0.0,0.0,0.0,-10.0,0.0}))).setAppinfo("Top and bottom endpoints of line tether that anchors this mine to the bottom."))
.addField(new field().setName("proximityIsActive").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("proximityIsActive can be used to activate information or interaction when the viewer nears the mine."))
.addField(new field().setName("proximitySize").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(10.0,10.0,10.0)).setAppinfo("proximitySize provides overall box dimensions for proximity; thus (10 10 10) yields approximate radius 5 to 7 meters.")))
.setProtoBody(new ProtoBody()
.addChild(new Transform("LOCATOR")
.setIS(new IS()
.addConnect(new connect().setNodeField("translation").setProtoField("translation"))
.addConnect(new connect().setNodeField("scale").setProtoField("scale"))
.addConnect(new connect().setNodeField("bboxCenter").setProtoField("bboxCenter")))
.addChild(new LOD().setRange(new double[] {100.0,500.0,5000.0})
.addComments(" High resolution ")
.addChild(new Group()
.addChild(new Viewpoint("UW_MINE_VIEWPOINT")
.setIS(new IS()
.addConnect(new connect().setNodeField("description").setProtoField("description"))))
.addChild(new ProximitySensor("UW_MINE_PROXIMITY")
.setIS(new IS()
.addConnect(new connect().setNodeField("isActive").setProtoField("proximityIsActive"))
.addConnect(new connect().setNodeField("size").setProtoField("proximitySize"))))
.addChild(new Shape("UW_MINE_SPHERE")
.setGeometry(new Sphere().setRadius(.5))
.setAppearance(new Appearance("UW_MINE_APPEARANCE")
.setMaterial(new Material("UW_MINE_MATERIAL").setShininess(.5)
.setIS(new IS()
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("color"))))))
.addChild(new Transform().setTranslation(0.0,.49,0.0)
.addChild(new Transform("SPIKE").setCenter(0.0,-.1,0.0).setTranslation(0.0,.1,0.0)
.addChild(new Shape()
.setGeometry(new Cone().setBottom(false).setBottomRadius(.05).setHeight(.2))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(.8,.8,.8).setShininess(.5).setSpecularColor(.2,.2,.2))))))
.addChild(new Transform().setRotation(0.0,0.0,1.0,3.1416).setTranslation(0.0,-.49,0.0)
.addChild(new Transform().setUSE("SPIKE")))
.addChild(new Transform().setRotation(0.0,0.0,1.0,-1.57079).setTranslation(.49,0.0,0.0)
.addChild(new Transform().setUSE("SPIKE")))
.addChild(new Transform().setRotation(0.0,0.0,1.0,1.57079).setTranslation(-.49,0.0,0.0)
.addChild(new Transform().setUSE("SPIKE")))
.addChild(new Transform().setRotation(1.0,0.0,0.0,1.57079).setTranslation(0.0,0.0,.49)
.addChild(new Transform().setUSE("SPIKE")))
.addChild(new Transform().setRotation(1.0,0.0,0.0,-1.57079).setTranslation(0.0,0.0,-.49)
.addChild(new Transform().setUSE("SPIKE")))
.addChild(new Shape()
.setGeometry(new IndexedLineSet().setCoordIndex(new int[] {0,1,-1})
.setCoord(new Coordinate("UW_MINE_TETHER")
.setIS(new IS()
.addConnect(new connect().setNodeField("point").setProtoField("tetherPoints")))))))
.addComments(" Medium resolution ")
.addChild(new Group()
.addChild(new Viewpoint("UW_MINE_VIEWPOINT_MEDIUM")
.setIS(new IS()
.addConnect(new connect().setNodeField("description").setProtoField("description"))))
.addChild(new Shape().setUSE("UW_MINE_SPHERE")))
.addComments(" Low resolution ")
.addChild(new Shape()
.setGeometry(new Box().setSize(12.0,12.0,12.0))
.setAppearance(new Appearance().setUSE("UW_MINE_APPEARANCE")))
.addComments(" No resolution ")
.addChild(new WorldInfo().setInfo(new String[] {"null geometry"}))))))
.addComments(" Show default geometry, in case this Prototype library is viewed directly as a scene ")
.addChild(new Group("ShowSphericalMines")
.addChild(new ProtoInstance("SphericalMine", "BLUE_SPHERICAL_MINE").setContainerField("children")
.addFieldValue(new fieldValue().setName("description").setValue("10 m: blue SphericalMine default viewpoint"))
.addFieldValue(new fieldValue().setName("color").setValue(new SFColor(0.0,0.0,.8)))
.addFieldValue(new fieldValue().setName("translation").setValue(new SFVec3f(0.0,-10.0,0.0)))
.addFieldValue(new fieldValue().setName("bboxCenter").setValue(new SFVec3f(1.0,1.0,1.0)))
.addFieldValue(new fieldValue().setName("tetherPoints").setValue(new MFVec3f(new MFVec3f(new double[] {0.0,0.0,0.0,0.0,-10.0,0.0})))))
.addChild(new ProtoInstance("SphericalMine", "GREEN_SPHERICAL_MINE").setContainerField("children")
.addFieldValue(new fieldValue().setName("description").setValue("10 m: green SphericalMine default viewpoint"))
.addFieldValue(new fieldValue().setName("color").setValue(new SFColor(0.0,.8,0.0)))
.addFieldValue(new fieldValue().setName("translation").setValue(new SFVec3f(10.0,-10.0,0.0)))
.addFieldValue(new fieldValue().setName("bboxCenter").setValue(new SFVec3f(2.0,2.0,2.0)))
.addFieldValue(new fieldValue().setName("tetherPoints").setValue(new MFVec3f(new MFVec3f(new double[] {0.0,0.0,0.0,0.0,-10.0,0.0})))))
.addChild(new Background().setGroundColor(new MFColor(new double[] {0.0,.2,.2})).setSkyColor(new MFColor(new double[] {0.0,.3,.3})))
.addChild(new Viewpoint().setDescription("1 m: one closeup SphericalMine").setPosition(10.0,-10.0,2.0))
.addChild(new Viewpoint().setDescription("10 m: two pointy SphericalMines").setPosition(5.0,-10.0,10.0))
.addChild(new Viewpoint().setDescription("100+ m: two round SphericalMines").setPosition(5.0,-10.0,105.0))
.addChild(new Viewpoint().setDescription("500+ m: two boxy SphericalMines").setPosition(5.0,-10.0,510.0))
.addChild(new Viewpoint().setDescription("5000+ m: two invisible SphericalMines").setPosition(5.0,-10.0,5010.0)))
.addComments(" Proximity activation triggers switch in NavigationInfo mode between EXAMINE and WALK - pretty cool! ")
.addChild(new NavigationInfo("NAVIGATION").setSpeed(20).setType(new String[] {"WALK","EXAMINE","ANY"}))
.addChild(new Script("NAVIGATION_MODE").setSourceCode("""
ecmascript:
function inProximity ( value, eventTime )
{
if ( value == true )
{
type[0] = 'EXAMINE';
type[1] = 'WALK';
type[2] = 'ANY';
}
else
{
type[0] = 'WALK';
type[1] = 'EXAMINE';
type[2] = 'ANY';
}
// Browser.println ('inProximity=' + value + ', type=' + type);
}
""")
.addField(new field().setName("inProximity").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("type").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ROUTE().setFromNode("BLUE_SPHERICAL_MINE").setFromField("proximityIsActive").setToNode("NAVIGATION_MODE").setToField("inProximity"))
.addChild(new ROUTE().setFromNode("GREEN_SPHERICAL_MINE").setFromField("proximityIsActive").setToNode("NAVIGATION_MODE").setToField("inProximity"))
.addComments(" TODO match field name in Script exactly ")
.addChild(new ROUTE().setFromNode("NAVIGATION_MODE").setFromField("type").setToNode("NAVIGATION").setToField("set_type")));
}
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 SphericalMinePrototype 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 SphericalMinePrototype().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.Weapons.UnderwaterMines.SphericalMinePrototype\" 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.Weapons.UnderwaterMines.SphericalMinePrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Weapons/UnderwaterMines/SphericalMinePrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Weapons/UnderwaterMines/SphericalMinePrototype_JavaExport.x3d";
String filenameX3DV = "Weapons/UnderwaterMines/SphericalMinePrototype_JavaExport.x3dv";
String filenameJSON = "Weapons/UnderwaterMines/SphericalMinePrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}