package Savage.Tools.Authoring;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
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 output from AnimatedViewpointRecorderExample showing results from four separate, previously computed, animated viewpoint recordings. </p>
 <p> Related links: Catalog page <a href="../../../../Tools/Authoring/AnimatedViewpointRecorderSampleIndex.html" target="_blank">AnimatedViewpointRecorderSample</a>,  source <a href="../../../../Tools/Authoring/AnimatedViewpointRecorderSample.java">AnimatedViewpointRecorderSample.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/Authoring/AnimatedViewpointRecorderSample.x3d">AnimatedViewpointRecorderSample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Example output from AnimatedViewpointRecorderExample showing results from four separate, previously computed, animated viewpoint recordings. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Don Brutzman, Ken Curtin, Duane Davis, Christos Kalogrias </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 9 November 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> reference </i> </td>
			<td> <a href="../../../../Tools/Authoring/AnimatedViewpointRecorderPrototype.x3d">AnimatedViewpointRecorderPrototype.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="../../../../Tools/Authoring/AnimatedViewpointRecorderExample.x3d">AnimatedViewpointRecorderExample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> subject </i> </td>
			<td> recording animated viewpoint tour </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/Authoring/AnimatedViewpointRecorderSample.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/AnimatedViewpointRecorderSample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
			<td> <a href="../../../../Tools/Authoring/../../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, Ken Curtin, Duane Davis, Christos Kalogrias
 */

public class AnimatedViewpointRecorderSample
{
	/** Default constructor to create this object. */
	public AnimatedViewpointRecorderSample ()
	{
	  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("AnimatedViewpointRecorderSample.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Example output from AnimatedViewpointRecorderExample showing results from four separate, previously computed, animated viewpoint recordings."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman, Ken Curtin, Duane Davis, Christos Kalogrias"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("9 November 2003"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("28 November 2019"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("AnimatedViewpointRecorderPrototype.x3d"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("AnimatedViewpointRecorderExample.x3d"))
    .addMeta(new meta().setName(meta.NAME_SUBJECT    ).setContent("recording animated viewpoint tour"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/AnimatedViewpointRecorderSample.x3d"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("../../license.html")))
  .setScene(new Scene()
    .addChild(new WorldInfo().setTitle("AnimatedViewpointRecorderSample.x3d"))
    .addChild(new Inline("HelloWorld").setUrl(new String[] {"../../../HelloWorld.x3d","https://www.web3d.org/x3d/content/examples/Basic/HelloWorld.x3d","../../../HelloWorld.wrl","https://www.web3d.org/x3d/content/examples/Basic/HelloWorld.wrl"}))
    .addComments(" ********** start recorded Animated Tour 0 using .x3d syntax ********** ")
    .addChild(new Group()
      .addChild(new Viewpoint("AnimatedViewpointRecorderViewpoint0").setDescription("Animated Tour 0").setOrientation(1.0,0.0,0.0,-0.000690534).setPosition(0.0,0.00675263,10.0))
      .addComments(" samplingInterval=0.1 seconds, default TimeSensor loop=true ")
      .addChild(new TimeSensor("AnimatedViewpointRecorderTimer0").setCycleInterval(6.407).setLoop(true))
      .addChild(new PositionInterpolator("AnimatedViewpointRecorderPosition0").setKey(new double[] {0.0,0.01717,0.03418,0.05135,0.06836,0.08538,0.10254,0.11956,0.13657,0.15374,0.17075,0.18792,0.20493,0.22194,0.23911,0.25613,0.27329,0.29031,0.30732,0.32449,0.3415,0.35851,0.37568,0.3927,0.40986,1.0}).setKeyValue(new MFVec3f(new double[] {0.0,0.00675263,10.0,0.0,0.884067,9.96085,0.0,2.67779,9.63481,0.0,4.76304,8.79281,0.0,6.80765,7.32502,0.0,8.50591,5.25829,0.0,9.61809,2.73724,0.0,10.0,0.00103736,0.0,9.61675,-2.74195,0.0,8.48232,-5.29625,0.0,6.68996,-7.43266,0.0,4.32236,-9.01761,0.0,1.62865,-9.86648,0.0,-1.19496,-9.92834,0.0,-3.94716,-9.18803,0.0,-6.3587,-7.71796,0.0,-8.27764,-5.61075,0.0,-9.51627,-3.07256,0.0,-9.99581,-0.289271,0.0,-9.67145,2.54224,0.0,-8.57491,5.14498,0.0,-6.79438,7.33731,0.0,-4.44863,8.95597,0.0,-1.76712,9.84261,0.0,1.0812,9.94136,0.0,-1.0,7.0})))
      .addChild(new OrientationInterpolator("AnimatedViewpointRecorderOrientation0").setKey(new double[] {0.0,0.01717,0.03418,0.05135,0.06836,0.08538,0.10254,0.11956,0.13657,0.15374,0.17075,0.18792,0.20493,0.22194,0.23911,0.25613,0.27329,0.29031,0.30732,0.32449,0.3415,0.35851,0.37568,0.3927,0.40986,1.0}).setKeyValue(new MFRotation(new double[] {1.0,0.0,0.0,-0.000690534,1.0,0.0,0.0,-0.0885223,1.0,0.0,0.0,-0.271086,1.0,0.0,0.0,-0.496447,1.0,0.0,0.0,-0.748806,1.0,0.0,0.0,-1.01711,1.0,0.0,0.0,-1.29353,1.0,0.0,0.0,-1.57069,1.0,0.0,0.0,-1.84855,1.0,0.0,0.0,-2.12895,1.0,0.0,0.0,-2.40873,1.0,0.0,0.0,-2.69462,1.0,0.0,0.0,-2.978,1.0,0.0,-0.0,-3.26137,1.0,0.0,-0.0,-3.54735,1.0,0.0,-0.0,-3.83073,1.0,0.0,-0.0,-4.1167,1.0,0.0,-0.0,-4.40008,1.0,0.0,-0.0,-4.68346,1.0,0.0,-0.0,-4.96943,1.0,0.0,-0.0,-5.25281,1.0,0.0,-0.0,-5.53619,1.0,0.0,-0.0,-5.82216,1.0,0.0,-0.0,-6.10554,-1.0,0.0,0.0,-6.17486,1.0,0.0,0.0,-0.0})))
      .addChild(new Group()
        .addChild(new ROUTE().setFromNode("AnimatedViewpointRecorderViewpoint0").setFromField("bindTime").setToNode("AnimatedViewpointRecorderTimer0").setToField("startTime"))
        .addChild(new ROUTE().setFromNode("AnimatedViewpointRecorderTimer0").setFromField("fraction_changed").setToNode("AnimatedViewpointRecorderPosition0").setToField("set_fraction"))
        .addChild(new ROUTE().setFromNode("AnimatedViewpointRecorderTimer0").setFromField("fraction_changed").setToNode("AnimatedViewpointRecorderOrientation0").setToField("set_fraction"))
        .addChild(new ROUTE().setFromNode("AnimatedViewpointRecorderPosition0").setFromField("value_changed").setToNode("AnimatedViewpointRecorderViewpoint0").setToField("position"))
        .addChild(new ROUTE().setFromNode("AnimatedViewpointRecorderOrientation0").setFromField("value_changed").setToNode("AnimatedViewpointRecorderViewpoint0").setToField("orientation")))));
            }
            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 AnimatedViewpointRecorderSample 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 AnimatedViewpointRecorderSample().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.Authoring.AnimatedViewpointRecorderSample\" 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.Authoring.AnimatedViewpointRecorderSample self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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