package Savage.Tools.Terrain;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geospatial.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Time.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> Example of a tank placed on and oriented to a GeoTerrainGrid. </p>
 <p> Related links: Catalog page <a href="../../../../Tools/Terrain/DTEDSingleGridIndex.html" target="_blank">DTEDSingleGrid</a>,  source <a href="../../../../Tools/Terrain/DTEDSingleGrid.java">DTEDSingleGrid.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="../../../../Tools/Terrain/DTEDSingleGrid.x3d">DTEDSingleGrid.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Example of a tank placed on and oriented to a GeoTerrainGrid </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Brian Hittner, CPT, U.S.A. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> translator </i> </td>
			<td> Xeena VRML importer with significant manual corrections </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 10 October 2003 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> translated </i> </td>
			<td> 10 October 2003 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 28 November 2019 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> X3D-Edit 3.2, <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> generator </i> </td>
			<td> Vrml97ToX3dNist, <a href="http://ovrt.nist.gov/v2_x3d.html" target="_blank">http://ovrt.nist.gov/v2_x3d.html</a> </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/Tools/Terrain/DTEDSingleGrid.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Savage/Tools/Terrain/DTEDSingleGrid.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
			<td> <a href="../../../../Tools/Terrain/../../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 Brian Hittner, CPT, U.S.A.
 */

public class DTEDSingleGrid
{
	/** Default constructor to create this object. */
	public DTEDSingleGrid ()
	{
	  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()
    .addComponent(new component().setName("Geospatial").setLevel(1))
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("DTEDSingleGrid.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Example of a tank placed on and oriented to a GeoTerrainGrid"))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Brian Hittner, CPT, U.S.A."))
    .addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Xeena VRML importer with significant manual corrections"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("10 October 2003"))
    .addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("10 October 2003"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("28 November 2019"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit 3.2, https://www.web3d.org/x3d/tools/X3D-Edit"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("Vrml97ToX3dNist, http://ovrt.nist.gov/v2_x3d.html"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Terrain/DTEDSingleGrid.x3d"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("../../license.html")))
  .setScene(new Scene()
    .addChild(new WorldInfo().setTitle("DTEDSingleGrid.x3d"))
    .addChild(new ExternProtoDeclare("GeoLocation3").setName("GeoLocation3").setUrl(new String[] {"GeoLocation3.x3d#GeoLocation3","https://www.web3d.org/x3d/content/examples/Savage/Tools/Terrain/GeoLocation3.x3d#GeoLocation3","GeoLocation3.wrl#GeoLocation3","https://www.web3d.org/x3d/content/examples/Savage/Tools/Terrain/GeoLocation3.wrl#GeoLocation3"})
      .addField(new field().setName("geoOrigin").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("geoSystem").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("geoCoords").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("children").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("autoElevation").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("autoSurfaceOrientation").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("debug").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("set_geoCoords").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTONLY))
      .addField(new field().setName("geoCoords_changed").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
      .addField(new field().setName("set_autoElevation").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
      .addField(new field().setName("autoElevation_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
      .addField(new field().setName("set_autoSurfaceOrientation").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
      .addField(new field().setName("autoSurfaceOrientation_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
    .addChild(new NavigationInfo().setSpeed(5000).setType(new String[] {"WALK"}))
    .addChild(new Background())
    .addChild(new GeoViewpoint("ViewPoint").setOrientation(1.0,0.0,0.0,-0.5).setPosition(29.705,52.635,2500.0)
      .setGeoOrigin(new GeoOrigin("ORIGIN").setGeoCoords(29.0,52.0,0.0)))
    .addChild(new Group("Top")
      .addChild(new Inline().setUrl(new String[] {"N2942E5237DTED2.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Terrain/N2942E5237DTED2.x3d","N2942E5237DTED2.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Terrain/N2942E5237DTED2.wrl"})))
    .addChild(new ProtoInstance("GeoLocation3", "UNITLOC").setContainerField("children")
      .addFieldValue(new fieldValue().setName("debug").setValue(true))
      .addFieldValue(new fieldValue().setName("children")
        .addChild(new Transform().setRotation(0.0,1.0,0.0,0.7854).setScale(10.0,10.0,10.0).setTranslation(0.0,15.0,0.0)
          .addChild(new Inline().setUrl(new String[] {"../../GroundVehicles/M1A1/M1A1.x3d","https://www.web3d.org/x3d/content/examples/Savage/GroundVehicles/M1A1/M1A1.x3d","../../GroundVehicles/M1A1/M1A1.wrl","https://www.web3d.org/x3d/content/examples/Savage/GroundVehicles/M1A1/M1A1.wrl"}))))
      .addFieldValue(new fieldValue().setName("geoCoords").setValue("29.7118644 52.6271186 0"))
      .addFieldValue(new fieldValue().setName("geoOrigin")
        .addChild(new GeoOrigin().setUSE("ORIGIN")))
      .addFieldValue(new fieldValue().setName("autoSurfaceOrientation").setValue(true))
      .addFieldValue(new fieldValue().setName("autoElevation").setValue(true))
      .addFieldValue(new fieldValue().setName("geoSystem").setValue(new String[] {"GD","WE"})))
    .addChild(new GeoPositionInterpolator("Interpolator").setKey(new double[] {0.0,0.99}).setKeyValue(new MFVec3d(new double[] {29.71186441,52.6271187,0.0,29.7288,52.64406,0.0}))
      .setGeoOrigin(new GeoOrigin().setUSE("ORIGIN")))
    .addChild(new TimeSensor("Clock").setCycleInterval(100.0).setLoop(true))
    .addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("Interpolator").setToField("set_fraction"))
    .addChild(new ROUTE().setFromNode("Interpolator").setFromField("geovalue_changed").setToNode("UNITLOC").setToField("set_geoCoords")));
            }
            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 DTEDSingleGrid 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 DTEDSingleGrid().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.Tools.Terrain.DTEDSingleGrid\" 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.Tools.Terrain.DTEDSingleGrid self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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