package Savage.CommunicationsAndSensors.Sonobuoys;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> AN/SSQ-62B/C/D/E Directional Command Activated Sonobuoy System (DICASS) Sonobuoy. </p>
 <p> Related links: Catalog page <a href="../../../../CommunicationsAndSensors/Sonobuoys/DicassExampleIndex.html" target="_blank">DicassExample</a>,  source <a href="../../../../CommunicationsAndSensors/Sonobuoys/DicassExample.java">DicassExample.java</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dResources.html" target="_blank">X3D Resources</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html" target="_blank">X3D Scene Authoring Hints</a>, and <a href="https://www.web3d.org/x3d/content/X3dTooltips.html" target="_blank">X3D Tooltips</a>. </p>
	<table style="color:black; border:0px solid; border-spacing:10px 0px;">
        <caption>Scene Meta Information</caption>
		<tr style="background-color:silver; border-color:silver;">
			<td style="text-align:center; padding:10px 0px;"><i>meta tags</i></td>
			<td style="text-align:left;   padding:10px 0px;">&nbsp; Document Metadata </td>
		</tr>

		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> title </i> </td>
			<td> <a href="../../../../CommunicationsAndSensors/Sonobuoys/DicassExample.x3d">DicassExample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> AN/SSQ-62B/C/D/E Directional Command Activated Sonobuoy System (DICASS) Sonobuoy </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> coordinateSystem </i> </td>
			<td> x=East, z=North, y=Up </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Don Brutzman </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 30 January 2003 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 20 October 2019 </td>
		</tr>
		<tr style="color:burntorange">
			<td style="text-align:right; vertical-align: text-top;"> <i> warning </i> </td>
			<td> under development, updating script code to X3D </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="../../../../CommunicationsAndSensors/Sonobuoys/DICASS-an-ssq-62.pdf">DICASS-an-ssq-62.pdf</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="https://www.fas.org/man/dod-101/sys/ship/weaps/an-ssq-62.htm" target="_blank">https://www.fas.org/man/dod-101/sys/ship/weaps/an-ssq-62.htm</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> NAVY TRAINING SYSTEM PLAN FOR THE NAVY CONSOLIDATED SONOBUOYS N88-NTSP-A-50-8910B/A SEPTEMBER 1998 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="../../../../CommunicationsAndSensors/Sonobuoys/ntsp-Sonobuoy.pdf">ntsp-Sonobuoy.pdf</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="https://www.fas.org/man/dod-101/sys/ship/weaps/docs/ntsp-Sonobuoy.pdf" target="_blank">https://www.fas.org/man/dod-101/sys/ship/weaps/docs/ntsp-Sonobuoy.pdf</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="http://www.avtechtra.navy.mil/pdf/Sonobuoys_a.PDF" target="_blank">http://www.avtechtra.navy.mil/pdf/Sonobuoys_a.PDF</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="http://www.ultra-scs.com/sonobuoys/dicass.htm" target="_blank">http://www.ultra-scs.com/sonobuoys/dicass.htm</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="http://www.ultra-ussg.com/company/sonobuoy_history.cfm" target="_blank">http://www.ultra-ussg.com/company/sonobuoy_history.cfm</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> subject </i> </td>
			<td> DICASS sonobuoy </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> identifier </i> </td>
			<td> <a href="https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Sonobuoys/DicassExample.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Sonobuoys/DicassExample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> X3D-Edit 3.3, <a href="https://www.web3d.org/x3d/tools/X3D-Edit" target="_blank">https://www.web3d.org/x3d/tools/X3D-Edit</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
			<td> <a href="../../../../CommunicationsAndSensors/Sonobuoys/../../license.html">../../license.html</a> </td>
		</tr>
		<tr style="background-color:silver; border-color:silver;">
			<td style="text-align:center;" colspan="2">  &nbsp; </td>
		</tr>
	</table>

	<p>
		This program uses the
		<a href="https://www.web3d.org/specifications/java/X3DJSAIL.html" target="_blank">X3D Java Scene Access Interface Library (X3DJSAIL)</a>.
		It has been produced using the 
		<a href="https://www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">X3dToJava.xslt</a>
		stylesheet
	       (<a href="https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">version control</a>)
                which is used to create Java source code from an original <code>.x3d</code> model.
	</p>

	* @author Don Brutzman
 */

public class DicassExample
{
	/** Default constructor to create this object. */
	public DicassExample ()
	{
	  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("DicassExample.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("AN/SSQ-62B/C/D/E Directional Command Activated Sonobuoy System (DICASS) Sonobuoy"))
    .addMeta(new meta().setName("coordinateSystem").setContent("x=East, z=North, y=Up"))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("30 January 2003"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("20 October 2019"))
    .addMeta(new meta().setName(meta.NAME_WARNING    ).setContent("under development, updating script code to X3D"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("DICASS-an-ssq-62.pdf"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("https://www.fas.org/man/dod-101/sys/ship/weaps/an-ssq-62.htm"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("NAVY TRAINING SYSTEM PLAN FOR THE NAVY CONSOLIDATED SONOBUOYS N88-NTSP-A-50-8910B/A SEPTEMBER 1998"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("ntsp-Sonobuoy.pdf"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("https://www.fas.org/man/dod-101/sys/ship/weaps/docs/ntsp-Sonobuoy.pdf"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("http://www.avtechtra.navy.mil/pdf/Sonobuoys_a.PDF"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("http://www.ultra-scs.com/sonobuoys/dicass.htm"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("http://www.ultra-ussg.com/company/sonobuoy_history.cfm"))
    .addMeta(new meta().setName(meta.NAME_SUBJECT    ).setContent("DICASS sonobuoy"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Sonobuoys/DicassExample.x3d"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit 3.3, 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("DicassExample.x3d"))
    .addChild(new ExternProtoDeclare("DICASS").setName("DICASS").setAppinfo("AN/SSQ-62B/C/D/E Directional Command Activated Sonobuoy System (DICASS) Sonobuoy").setUrl(new String[] {"DicassPrototype.x3d#DICASS","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Sonobuoys/DicassPrototype.x3d#DICASS","DicassPrototype.wrl#DICASS","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Sonobuoys/DicassPrototype.wrl#DICASS"})
      .addField(new field().setName("ID").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("identifier label for this buoy"))
      .addField(new field().setName("version").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value: AN/SSQ-62B"))
      .addField(new field().setName("initialPositionXZ").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("local surface coordinates X=North Z=East"))
      .addField(new field().setName("orderedPositionXZ").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("local surface coordinates X=North Z=East"))
      .addField(new field().setName("initialDepth").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("meters depth use negative numbers for subsurface"))
      .addField(new field().setName("orderedDepth").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("meters depth use negative numbers for subsurface"))
      .addField(new field().setName("bindViewpoint").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("trigger event to bind/unbind viewpoint"))
      .addField(new field().setName("location_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("local coordinates X=North Y=altitude Z=East"))
      .addField(new field().setName("maxRange").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("maximum audible sonar detection range meters"))
      .addField(new field().setName("pingDuration").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("pingDuration corresponds to maxRange at 1500m/sec sound speed"))
      .addField(new field().setName("soundSpeed").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("in-water sound speed m/s, default value 1500").setDocumentation("https://en.wikipedia.org/wiki/Speed_of_sound#Seawater"))
      .addField(new field().setName("startPing").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("trigger event to start single ping"))
      .addField(new field().setName("startContinuousPings").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("trigger event to start continuous ping sequence"))
      .addField(new field().setName("linkText").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Can add linkable text for further information"))
      .addField(new field().setName("linkUrl").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("url for linkable text"))
      .addField(new field().setName("linkTargetWindow").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("target window for linkable text")))
    .addComments(" Rendered scene begins here ")
    .addChild(new Background("AquaTealBackground").setGroundColor(new MFColor(new double[] {0.0,0.25,0.25})).setSkyColor(new MFColor(new double[] {0.0,1.0,1.0})))
    .addChild(new NavigationInfo().setSpeed(100).setType(new String[] {"EXAMINE","FLY","ANY"}))
    .addChild(new ProtoInstance("DICASS", "DicassExample").setContainerField("children")
      .addFieldValue(new fieldValue().setName("ID").setValue(new String[] {"DicassExample"}))
      .addFieldValue(new fieldValue().setName("initialPositionXZ").setValue(new SFVec2f(0.0,0.0)))
      .addFieldValue(new fieldValue().setName("initialDepth").setValue(-1))
      .addFieldValue(new fieldValue().setName("linkText").setValue(new String[] {"click for online SAVAGE Archive"}))
      .addFieldValue(new fieldValue().setName("linkUrl").setValue(new String[] {"https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Sonobuoys/index.html"}))
      .addFieldValue(new fieldValue().setName("linkTargetWindow").setValue(new String[] {"target=_blank"})))
    .addComments(" Interface to test DICASS buoy ")
    .addChild(new Transform().setTranslation(0.0,0.0,2000.0)
      .addChild(new Viewpoint().setDescription("DICASS 2 km"))
      .addChild(new Transform().setTranslation(-3.5,-3.0,0.0)
        .addChild(new Shape()
          .setGeometry(new Text().setString(new String[] {"single ping"})
            .setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.9)))
          .setAppearance(new Appearance()
            .setMaterial(new Material("InterfaceMaterial").setDiffuseColor(0.8,0.5,0.1))))
        .addChild(new TouchSensor("SinglePingTouch").setDescription("Single Ping TouchSensor"))
        .addChild(new ROUTE().setFromNode("SinglePingTouch").setFromField("isActive").setToNode("DicassExample").setToField("startPing")))
      .addChild(new Transform().setTranslation(2.5,-3.0,0.0)
        .addChild(new Shape()
          .setGeometry(new Text().setString(new String[] {"continuous pings"})
            .setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.9)))
          .setAppearance(new Appearance()
            .setMaterial(new Material().setUSE("InterfaceMaterial"))))
        .addChild(new TouchSensor("ContinuousPingTouch").setDescription("Continuous Ping TouchSensor"))
        .addChild(new ROUTE().setFromNode("ContinuousPingTouch").setFromField("isActive").setToNode("DicassExample").setToField("startContinuousPings")))));
            }
            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 
	 * <a href="https://dzone.com/articles/java-copy-shallow-vs-deep-in-which-you-will-swim" target="_blank">shallow copy</a>
	 * of the X3D model.
	 * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html">X3D</a>
	 * @return DicassExample 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 <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#handleArguments-java.lang.String:A-">X3D.handleArguments(args)</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#validationReport--">X3D.validationReport()</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html">CommandLine</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html#USAGE">CommandLine.USAGE</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/ConfigurationProperties.html">ConfigurationProperties</a>
     */
    public static void main(String args[])
    {
        System.out.println("Build this X3D model, showing validation diagnostics...");
        X3D thisExampleX3dModel = new DicassExample().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.CommunicationsAndSensors.Sonobuoys.DicassExample\" 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.CommunicationsAndSensors.Sonobuoys.DicassExample self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

                // experimental: test X3DJSAIL output files
                // CommunicationsAndSensors/Sonobuoys/DicassExample_JavaExport.* file validation is checked when building X3D Example Archives
                String filenameX3D  = "CommunicationsAndSensors/Sonobuoys/DicassExample_JavaExport.x3d"; 
                String filenameX3DV = "CommunicationsAndSensors/Sonobuoys/DicassExample_JavaExport.x3dv"; 
                String filenameJSON = "CommunicationsAndSensors/Sonobuoys/DicassExample_JavaExport.json";
                thisExampleX3dModel.toFileX3D        (filenameX3D);
                thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO         thisExampleX3dModel.toFileJSON       (filenameJSON);
        }
    }
}
