package Savage.AuvWorkbench.OperatingAreas;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Navigation.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> Operations area top-level scene for open ocean, used by the AUV Workbench to build scenarios using unmanned vehicles. </p>
 <p> Related links: Catalog page <a href="../../../../AuvWorkbench/OperatingAreas/OpenOceanOpAreaIndex.html" target="_blank">OpenOceanOpArea</a>,  source <a href="../../../../AuvWorkbench/OperatingAreas/OpenOceanOpArea.java">OpenOceanOpArea.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="../../../../AuvWorkbench/OperatingAreas/OpenOceanOpArea.x3d">OpenOceanOpArea.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Operations area top-level scene for open ocean, used by the AUV Workbench to build scenarios using unmanned vehicles. </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> 25 August 2009 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 20 October 2019 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> TODO </i> </td>
			<td> more viewpoints NSEW, also axes </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/AuvWorkbench/OperatingAreas/OpenOceanOpArea.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Savage/AuvWorkbench/OperatingAreas/OpenOceanOpArea.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> X3D-Edit, <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="../../../../AuvWorkbench/OperatingAreas/../../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 OpenOceanOpArea
{
	/** Default constructor to create this object. */
	public OpenOceanOpArea ()
	{
	  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_2)
  .setHead(new head()
    .addComponent(new component().setName("DIS").setLevel(1))
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("OpenOceanOpArea.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Operations area top-level scene for open ocean, used by the AUV Workbench to build scenarios using unmanned vehicles."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("25 August 2009"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("20 October 2019"))
    .addMeta(new meta().setName(meta.NAME_TODO       ).setContent("more viewpoints NSEW, also axes"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/AuvWorkbench/OperatingAreas/OpenOceanOpArea.x3d"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit, https://www.web3d.org/x3d/tools/X3D-Edit"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("../../license.html")))
  .setScene(new Scene()
    .addComments(" Not geospatially oriented ")
    .addChild(new WorldInfo().setTitle("OpenOceanOpArea.x3d"))
    .addChild(new Background("DeepBottom").setGroundAngle(new double[] {0.05,1.52,1.56,1.57}).setGroundColor(new MFColor(new double[] {0.0,0.0,0.0,0.05,0.1,0.2,0.075,0.2,0.3,0.1,0.3,0.4,0.0,0.2,0.4})).setSkyAngle(new double[] {0.05,0.1,1.309,1.57}).setSkyColor(new MFColor(new double[] {0.8,0.8,0.2,0.1,0.1,0.6,0.1,0.1,0.6,0.1,0.25,0.8,0.6,0.6,0.9})))
    .addComments(" <Background DEF='SandyShallowBottom' groundAngle='0.05 1.52 1.56 1.570796' groundColor='0.2 0.2 0 0.3 0.3 0 0.5 0.5 0.3 0.1 0.3 0.4 0 0.2 0.4' skyAngle='0.05 0.1 1.309 1.571' skyColor='0.8 0.8 0.2 0.1 0.1 0.6 0.1 0.1 0.6 0.1 0.25 0.8 0.6 0.6 0.9'/> ")
    .addComments(" <DirectionalLight ambientIntensity='0.1' direction='-3 -3 0'/> ")
    .addComments(" OverheadViewpoint ROUTE: [from isBound to FastNI.set_bind ] ")
    .addChild(new Viewpoint("OverheadViewpoint").setDescription("Open Ocean Operations Area, 1000m up").setFieldOfView(1).setOrientation(1.0,0.0,0.0,-1.57079).setPosition(0.0,1000.0,0.0))
    .addChild(new Viewpoint("SouthViewpoint").setDescription("Open Ocean OpArea from South").setOrientation(1.0,0.0,0.0,-0.3805).setPosition(0.0,400.0,1000.0))
    .addChild(new Viewpoint("EastViewpoint").setDescription("Open Ocean OpArea from East").setOrientation(-0.1858,0.9649,0.1858,1.6066).setPosition(1000.0,400.0,0.0))
    .addChild(new Viewpoint("NorthViewpoint").setDescription("Open Ocean OpArea from North").setOrientation(0.0,0.982,0.1891,3.1416).setPosition(0.0,400.0,-1000.0))
    .addChild(new Viewpoint("WestViewpoint").setDescription("Open Ocean OpArea from West").setOrientation(0.1858,0.9649,0.1858,-1.6066).setPosition(-1000.0,400.0,0.0))
    .addChild(new NavigationInfo("SlowNI").setSpeed(100.0).setTransitionType(new String[] {"ANIMATE"}))
    .addComments(" FastNI ROUTE: [from OverheadViewpoint.isBound to set_bind ] ")
    .addChild(new NavigationInfo("FastNI").setSpeed(1000.0).setTransitionType(new String[] {"ANIMATE"}).setType(new String[] {"FLY","ANY"}))
    .addChild(new ROUTE().setFromNode("OverheadViewpoint").setFromField("isBound").setToNode("FastNI").setToField("set_bind"))
    .addChild(new ExternProtoDeclare("GridXZ").setName("GridXZ").setUrl(new String[] {"../../../Savage/Tools/Authoring/GridXZPrototype.x3d#GridXZ","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/GridXZPrototype.x3d#GridXZ","../../../Savage/Tools/Authoring/GridXZPrototype.wrl#GridXZ","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/GridXZPrototype.wrl#GridXZ"})
      .addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("labelColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("scale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("originLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("WestLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("NorthWestLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("NorthLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("NorthEastLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("EastLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("SouthEastLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("SouthLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
      .addField(new field().setName("SouthWestLabel").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)))
    .addChild(new ProtoInstance("GridXZ").setContainerField("children")
      .addFieldValue(new fieldValue().setName("description").setValue("GridXZ for AUV in Open Ocean"))
      .addFieldValue(new fieldValue().setName("labelColor").setValue(new SFColor(1.0,1.0,1.0)))
      .addFieldValue(new fieldValue().setName("scale").setValue(new SFVec3f(50.0,50.0,50.0)))
      .addFieldValue(new fieldValue().setName("originLabel").setValue(new String[] {"origin","0 0 0"}))
      .addFieldValue(new fieldValue().setName("WestLabel").setValue(new String[] {"West","-Y"}))
      .addFieldValue(new fieldValue().setName("NorthWestLabel").setValue(new String[] {"1000 0 -500"}))
      .addFieldValue(new fieldValue().setName("NorthLabel").setValue(new String[] {"North","+X"}))
      .addFieldValue(new fieldValue().setName("NorthEastLabel").setValue(new String[] {"500 0 500"}))
      .addFieldValue(new fieldValue().setName("EastLabel").setValue(new String[] {"East","+Y"}))
      .addFieldValue(new fieldValue().setName("SouthEastLabel").setValue(new String[] {"-500 0 500"}))
      .addFieldValue(new fieldValue().setName("SouthLabel").setValue(new String[] {"South","-X"}))
      .addFieldValue(new fieldValue().setName("SouthWestLabel").setValue(new String[] {"-500 0 -500"}))));
            }
            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 OpenOceanOpArea 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 OpenOceanOpArea().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.AuvWorkbench.OperatingAreas.OpenOceanOpArea\" 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.AuvWorkbench.OperatingAreas.OpenOceanOpArea self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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