package X3dForWebAuthors.Chapter07EventAnimationInterpolation;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Rendering.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Time.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> Example normal (perpendicular vector) animation, where orange vectors show normal direction at each polygon vertex. </p>
 <p> Related links: Catalog page <a href="../../../Chapter07EventAnimationInterpolation/NormalInterpolatorExampleIndex.html" target="_blank">NormalInterpolatorExample</a>,  source <a href="../../../Chapter07EventAnimationInterpolation/NormalInterpolatorExample.java">NormalInterpolatorExample.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="../../../Chapter07EventAnimationInterpolation/NormalInterpolatorExample.x3d">NormalInterpolatorExample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Example normal (perpendicular vector) animation, where orange vectors show normal direction at each polygon vertex. </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> 3 May 2008 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 25 August 2023 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter19-NormalsShading/Figure19.27SquareFaceAnimatingNormals.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter19-NormalsShading/Figure19.27SquareFaceAnimatingNormals.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> subject </i> </td>
			<td> X3D NormalInterpolator example </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/X3dForWebAuthors/Chapter07EventAnimationInterpolation/NormalInterpolatorExample.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation/NormalInterpolatorExample.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://savage.nps.edu/X3D-Edit" target="_blank">https://savage.nps.edu/X3D-Edit</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
			<td> <a href="../../../Chapter07EventAnimationInterpolation/../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 NormalInterpolatorExample
{
	/** Default constructor to create this object. */
	public NormalInterpolatorExample ()
	{
	  initialize();
	}

	/** Create and initialize the X3D model for this object. */
	public final void initialize()
	{
            try { // catch-all
  x3dModel = new X3D().setProfile(X3D.PROFILE_INTERCHANGE).setVersion(X3D.VERSION_3_3)
  .setHead(new head()
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("NormalInterpolatorExample.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Example normal (perpendicular vector) animation, where orange vectors show normal direction at each polygon vertex."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("3 May 2008"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("25 August 2023"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter19-NormalsShading/Figure19.27SquareFaceAnimatingNormals.x3d"))
    .addMeta(new meta().setName(meta.NAME_SUBJECT    ).setContent("X3D NormalInterpolator example"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation/NormalInterpolatorExample.x3d"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("../license.html")))
  .setScene(new Scene()
    .addChild(new WorldInfo().setTitle("NormalInterpolatorExample.x3d"))
    .addChild(new Viewpoint().setDescription("Animating normals on right vertices of a quadrilateral").setPosition(0.0,0.0,8.0))
    .addChild(new Viewpoint().setDescription("Other side - note difference in animated shading").setOrientation(0.0,1.0,0.0,3.14159).setPosition(0.0,0.0,-7.0))
    .addChild(new Shape()
      .setGeometry(new IndexedFaceSet("FlatSquare").setDEF("FlatSquare").setSolid(false).setCoordIndex(new int[] {0,1,2,3}).setNormalIndex(new int[] {0,1,2,3})
        .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-2.0,-2.0,0.0,2.0,-2.0,0.0,2.0,2.0,0.0,-2.0,2.0,0.0})))
        .addComments(" Normal vector with 4 SFVec3f triplet values, one for each corner of quadrilateral ")
        .setNormal(new Normal("AnimatedNormalNode").setVector(new MFVec3f(new double[] {0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0}))))
      .setAppearance(new Appearance()
        .setMaterial(new Material("LightBlue").setDiffuseColor(0.3,0.6,0.9))))
    .addComments(" NormalInterpolator keyValue array must match sizes of target Normal vector and key arrays ")
    .addComments(" Thus this keyValue array has 4 * 3 = 12 total SFVec3f triplet values ")
    .addChild(new NormalInterpolator("NormalPath").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new MFVec3f(new double[] {0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0,1.0,0.0,0.0,1.0,0.0,0.0,0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0,0.0,0.0,1.0})))
    .addChild(new ROUTE().setFromNode("NormalPath").setFromField("value_changed").setToNode("AnimatedNormalNode").setToField("set_vector"))
    .addChild(new TimeSensor("Clock").setCycleInterval(8).setLoop(true))
    .addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("NormalPath").setToField("set_fraction"))
    .addComments(" This block above completes the primary functionality of this scene. More to follow, however! ")
    .addComments(" ============================================================================================================== ")
    .addComments(" Note that a Normal is not rendered - it is invisible. So this scene adds some lines to visualize what is happening. ")
    .addChild(new Shape()
      .setGeometry(new IndexedLineSet().setCoordIndex(new int[] {0,1,-1,2,3,-1,4,5,-1,6,7,-1})
        .setCoord(new Coordinate("NormalVectors").setPoint(new MFVec3f(new double[] {-2.0,-2.0,0.0,-2.0,-2.0,1.0,2.0,-2.0,0.0,2.0,-2.0,1.0,2.0,2.0,0.0,2.0,2.0,1.0,-2.0,2.0,0.0,-2.0,2.0,1.0}))))
      .setAppearance(new Appearance()
        .setMaterial(new Material().setEmissiveColor(0.9,0.6,0.1))))
    .addChild(new CoordinateInterpolator("NormalVectorsAnimation").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new MFVec3f(new double[] {-2.0,-2.0,0.0,-2.0,-2.0,1.0,2.0,-2.0,0.0,2.0,-2.0,1.0,2.0,2.0,0.0,2.0,2.0,1.0,-2.0,2.0,0.0,-2.0,2.0,1.0,-2.0,-2.0,0.0,-2.0,-2.0,1.0,2.0,-2.0,0.0,3.0,-2.0,0.0,2.0,2.0,0.0,3.0,2.0,0.0,-2.0,2.0,0.0,-2.0,2.0,1.0,-2.0,-2.0,0.0,-2.0,-2.0,1.0,2.0,-2.0,0.0,2.0,-2.0,1.0,2.0,2.0,0.0,2.0,2.0,1.0,-2.0,2.0,0.0,-2.0,2.0,1.0})))
    .addChild(new ROUTE().setFromNode("NormalVectorsAnimation").setFromField("value_changed").setToNode("NormalVectors").setToField("point"))
    .addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("NormalVectorsAnimation").setToField("set_fraction")));
            }
            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 NormalInterpolatorExample 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 NormalInterpolatorExample().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: \"X3dForWebAuthors.Chapter07EventAnimationInterpolation.NormalInterpolatorExample\" 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("X3dForWebAuthors.Chapter07EventAnimationInterpolation.NormalInterpolatorExample self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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