package Savage.Tools.Animation;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalSensor.*;
import org.web3d.x3d.jsail.EventUtilities.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Scripting.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> Attempt to control NavigationInfo speed and stack. </p>
 <p> Related links: Catalog page <a href="../../../../Tools/Animation/NavigationInfoStackIndex.html" target="_blank">NavigationInfoStack</a>,  source <a href="../../../../Tools/Animation/NavigationInfoStack.java">NavigationInfoStack.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/Animation/NavigationInfoStack.x3d">NavigationInfoStack.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Attempt to control NavigationInfo speed and stack. </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> 13 June 2004 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 28 November 2019 </td>
		</tr>
		<tr style="color:burntorange">
			<td style="text-align:right; vertical-align: text-top;"> <i> warning </i> </td>
			<td> under development </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/Animation/NavigationInfoStack.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/NavigationInfoStack.x3d</a> </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> license </i> </td>
			<td> <a href="../../../../Tools/Animation/../../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 NavigationInfoStack
{
	/** Default constructor to create this object. */
	public NavigationInfoStack ()
	{
	  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("NavigationInfoStack.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Attempt to control NavigationInfo speed and stack."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("13 June 2004"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("28 November 2019"))
    .addMeta(new meta().setName(meta.NAME_WARNING    ).setContent("under development"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/NavigationInfoStack.x3d"))
    .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_LICENSE    ).setContent("../../license.html")))
  .setScene(new Scene()
    .addChild(new WorldInfo().setTitle("NavigationInfoStack.x3d"))
    .addChild(new Group("NavigationInfoStackGroup")
      .addChild(new NavigationInfo("NavInfoDefault"))
      .addComments(" ========== ")
      .addChild(new NavigationInfo("NavInfo10mps").setSpeed(10))
      .addChild(new BooleanTrigger("NavSpeed10BooleanTrigger"))
      .addChild(new ProximitySensor("NavSpeed10ProximitySensor").setSize(200.0,200.0,200.0))
      .addChild(new ROUTE().setFromNode("NavSpeed10BooleanTrigger").setFromField("triggerTrue").setToNode("NavInfo10mps").setToField("set_bind"))
      .addChild(new ROUTE().setFromNode("NavSpeed10ProximitySensor").setFromField("exitTime").setToNode("NavSpeed10BooleanTrigger").setToField("set_triggerTime"))
      .addComments(" ========== ")
      .addChild(new NavigationInfo("NavInfo100mps").setSpeed(100))
      .addChild(new ProximitySensor("NavSpeed100ProximitySensor").setSize(2000.0,2000.0,2000.0))
      .addChild(new BooleanTrigger("NavSpeed100BooleanTrigger"))
      .addChild(new ROUTE().setFromNode("NavSpeed100BooleanTrigger").setFromField("triggerTrue").setToNode("NavInfo100mps").setToField("set_bind"))
      .addChild(new ROUTE().setFromNode("NavSpeed100ProximitySensor").setFromField("exitTime").setToNode("NavSpeed100BooleanTrigger").setToField("set_triggerTime"))
      .addComments(" ========== ")
      .addChild(new NavigationInfo("NavInfo1000mps").setSpeed(1000))
      .addChild(new ProximitySensor("NavSpeed1000ProximitySensor").setSize(20000.0,20000.0,20000.0))
      .addChild(new BooleanTrigger("NavSpeed1000BooleanTrigger"))
      .addChild(new ROUTE().setFromNode("NavSpeed1000BooleanTrigger").setFromField("triggerTrue").setToNode("NavInfo1000mps").setToField("set_bind"))
      .addChild(new ROUTE().setFromNode("NavSpeed1000ProximitySensor").setFromField("exitTime").setToNode("NavSpeed1000BooleanTrigger").setToField("set_triggerTime"))
      .addComments(" ========== ")
      .addChild(new Script("NavSpeedMonitorScript").setSourceCode("""
ecmascript:

function speed1Bound (value, timestamp)
{
	tracePrint ('NavInfoDefault (1 mps) bound');
}
function speed10Bound (value, timestamp)
{
	tracePrint ('NavInfo10mps bound');
}
function speed100Bound (value, timestamp)
{
	tracePrint ('NavInfo100mps bound');
}
function speed1000Bound (value, timestamp)
{
	tracePrint ('NavInfo1000mps bound');
}
function alwaysPrint (text)
{
	Browser.println ('[NavSpeedMonitorScript] ' + text);
}
function tracePrint (text)
{
	if (traceEnabled) Browser.println ('[NavSpeedMonitorScript] ' + text);
}
""")
        .addField(new field().setName("speed1Bound").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
        .addField(new field().setName("speed10Bound").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
        .addField(new field().setName("speed100Bound").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
        .addField(new field().setName("speed1000Bound").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
        .addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true)))
      .addChild(new ROUTE().setFromNode("NavInfoDefault").setFromField("isBound").setToNode("NavSpeedMonitorScript").setToField("speed1Bound"))
      .addChild(new ROUTE().setFromNode("NavInfo10mps").setFromField("isBound").setToNode("NavSpeedMonitorScript").setToField("speed10Bound"))
      .addChild(new ROUTE().setFromNode("NavInfo100mps").setFromField("isBound").setToNode("NavSpeedMonitorScript").setToField("speed100Bound"))
      .addChild(new ROUTE().setFromNode("NavInfo1000mps").setFromField("isBound").setToNode("NavSpeedMonitorScript").setToField("speed1000Bound"))));
            }
            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 NavigationInfoStack 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 NavigationInfoStack().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.Animation.NavigationInfoStack\" 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.Animation.NavigationInfoStack self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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