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.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Rendering.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Texturing.*;
import org.web3d.x3d.jsail.Time.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> This is a prototype for a CircleFish, which is also used by CircleFishLod. Default fish size: length is 1 m (Y-axis), max Height is 1 m (Z-axis), max Width is 10 cm (X-axis). </p>
 <p> Related links: Catalog page <a href="../../../Chapter07EventAnimationInterpolation/CircleFishPTPrototypeIndex.html" target="_blank">CircleFishPTPrototype</a>,  source <a href="../../../Chapter07EventAnimationInterpolation/CircleFishPTPrototype.java">CircleFishPTPrototype.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/CircleFishPTPrototype.x3d">CircleFishPTPrototype.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> This is a prototype for a CircleFish, which is also used by CircleFishLod. Default fish size: length is 1 m (Y-axis), max Height is 1 m (Z-axis), max Width is 10 cm (X-axis). </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Ildeniz Duman </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> translator </i> </td>
			<td> Scott Tufts </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 1 May 1998 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> translated </i> </td>
			<td> 11 December 2001 </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> reference </i> </td>
			<td> <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/CircleFishPrototype.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/CircleFishPrototype.x3d</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/X3dForWebAuthors/Chapter07EventAnimationInterpolation/CircleFishPTPrototype.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation/CircleFishPTPrototype.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 Ildeniz Duman
 */

public class CircleFishPTPrototype
{
	/** Default constructor to create this object. */
	public CircleFishPTPrototype ()
	{
	  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()
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("CircleFishPTPrototype.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This is a prototype for a CircleFish, which is also used by CircleFishLod. Default fish size: length is 1 m (Y-axis), max Height is 1 m (Z-axis), max Width is 10 cm (X-axis)."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Ildeniz Duman"))
    .addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Scott Tufts"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("1 May 1998"))
    .addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("11 December 2001"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("20 October 2019"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/CircleFishPrototype.x3d"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation/CircleFishPTPrototype.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("CircleFishPTPrototype.x3d"))
    .addChild(new ProtoDeclare("CircleFishPT").setName("CircleFishPT")
      .setProtoInterface(new ProtoInterface()
        .addField(new field().setName("skinPixelTexture").setType(field.TYPE_SFIMAGE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new int[] {0,0,0}))
        .addField(new field().setName("fishScale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(1.0,1.0,1.0)))
        .addField(new field().setName("fishColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.5,0.5,0.5)))
        .addField(new field().setName("finColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.5,0.5,0.5)))
        .addField(new field().setName("positionKey").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new double[] {0.0,0.125,0.25,0.375,0.5,0.625,0.750,0.8751}))
        .addField(new field().setName("positionKeyValue").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new MFVec3f(new MFVec3f(new double[] {1.5,2.0,0.0,1.5,0.0,-1.0,0.0,-1.0,-1.0,-1.5,0.0,-1.0,-1.5,2.0,0.0,-1.5,0.0,1.0,0.0,-2.0,1.0,1.5,0.0,1.0,1.5,2.0,0.0}))))
        .addField(new field().setName("orientationKey").setType(field.TYPE_MFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new double[] {0.0,0.25,0.5,0.750,1.0}))
        .addField(new field().setName("orientationKeyValue").setType(field.TYPE_MFROTATION).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new MFRotation(new MFRotation(new double[] {0.0,1.0,0.0,0.0,0.0,1.0,0.0,-1.57,0.0,1.0,0.0,-3.14,0.0,1.0,0.0,-4.71,0.0,1.0,0.0,-6.28}))))
        .addField(new field().setName("orbitTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(90)))
      .setProtoBody(new ProtoBody()
        .addChild(new Transform("Way")
          .addChild(new Transform().setRotation(1.0,0.0,0.0,1.395)
            .addChild(new Transform("FishTransform")
              .setIS(new IS()
                .addConnect(new connect().setNodeField("scale").setProtoField("fishScale")))
              .addChild(new Shape()
                .setAppearance(new Appearance()
                  .setMaterial(new Material("FishColor")
                    .setIS(new IS()
                      .addConnect(new connect().setNodeField("diffuseColor").setProtoField("fishColor"))))
                  .setTexture(new PixelTexture("FishTexture")
                    .setIS(new IS()
                      .addConnect(new connect().setNodeField("image").setProtoField("skinPixelTexture")))))
                .setGeometry(new Extrusion("FishBodyExtrusion").setCreaseAngle(0.57).setCrossSection(new MFVec2f(new double[] {-0.1,1.0,0.1,1.0,0.5,0.5,0.5,-0.5,0.1,-1.0,-0.1,-1.0,-0.5,-0.5,-0.5,0.5,-0.1,1.0})).setScale(new MFVec2f(new double[] {0.03,0.03,0.05,0.3,0.05,0.45,0.1,0.5,0.05,0.45,0.05,0.2,0.03,0.4})).setSpine(new MFVec3f(new double[] {0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.0,0.3,0.0,0.0,0.2,0.0,0.0,0.0,0.0}))))
              .addChild(new Shape()
                .setAppearance(new Appearance("FinSkin")
                  .setMaterial(new Material("FinColor").setTransparency(0.2)
                    .setIS(new IS()
                      .addConnect(new connect().setNodeField("diffuseColor").setProtoField("finColor"))))))
              .addChild(new Transform().setTranslation(0.015,0.8,-0.2)
                .addChild(new Shape("Eye")
                  .setAppearance(new Appearance()
                    .setMaterial(new Material().setDiffuseColor(0.5,0.5,0.5).setShininess(1).setSpecularColor(0.3,0.3,0.3)))
                  .setGeometry(new Sphere().setRadius(0.03))))
              .addChild(new Transform().setTranslation(-0.015,0.8,-0.2)
                .addChild(new Shape().setUSE("Eye")))
              .addChild(new Transform().setScale(1.0,1.0,0.7).setTranslation(0.0,0.98,0.0)
                .addChild(new Shape().setUSE("Eye")))
              .addChild(new Transform("LeftPectoral").setTranslation(0.04,0.4,0.3)
                .addChild(new Shape()
                  .setAppearance(new Appearance().setUSE("FinSkin"))
                  .setGeometry(new IndexedFaceSet().setSolid(false).setCoordIndex(new int[] {0,1,2,-1})
                    .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {0.0,0.0,0.0,0.0,0.2,0.0,0.2,0.1,0.0}))))))
              .addChild(new Transform("RightPectoral").setTranslation(-0.04,0.4,0.3)
                .addChild(new Shape()
                  .setAppearance(new Appearance().setUSE("FinSkin"))
                  .setGeometry(new IndexedFaceSet().setSolid(false).setCoordIndex(new int[] {0,1,2,-1})
                    .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {0.0,0.0,0.0,0.0,0.2,0.0,-0.2,0.1,0.0}))))))))
          .addChild(new Group("AnimationGroup")
            .addChild(new TimeSensor("Timer").setCycleInterval(5).setLoop(true))
            .addChild(new CoordinateInterpolator("Waggler").setKey(new double[] {0.0,0.15,0.28,0.4,0.55,0.7,0.85,1.0}).setKeyValue(new MFVec3f(new double[] {0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.0,0.3,0.0,0.0,0.2,0.0,0.0,0.0,0.0,0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.05,0.3,0.0,0.1,0.2,0.0,0.2,0.0,0.0,0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.0,0.3,0.0,0.0,0.2,0.0,0.0,0.0,0.0,0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,-0.05,0.3,0.0,-0.1,0.2,0.0,-0.2,0.0,0.0,0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.0,0.3,0.0,0.0,0.2,0.0,0.0,0.0,0.0,0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.05,0.3,0.0,0.1,0.2,0.0,0.2,0.0,0.0,0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.0,0.3,0.0,0.0,0.2,0.0,0.0,0.0,0.0,0.0,1.0,0.0,0.0,0.8,0.0,0.0,0.6,0.0,0.0,0.5,0.0,0.0,0.3,0.0,0.0,0.2,0.0,0.0,0.0,0.0})))
            .addChild(new ROUTE().setFromNode("Timer").setFromField("fraction_changed").setToNode("Waggler").setToField("set_fraction"))
            .addChild(new ROUTE().setFromNode("Waggler").setFromField("value_changed").setToNode("FishBodyExtrusion").setToField("set_spine"))
            .addChild(new OrientationInterpolator("LeftPectoralRotation").setKey(new double[] {0.0,0.3,0.7,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,-.349,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,-.349})))
            .addChild(new ROUTE().setFromNode("Timer").setFromField("fraction_changed").setToNode("LeftPectoralRotation").setToField("set_fraction"))
            .addChild(new ROUTE().setFromNode("LeftPectoralRotation").setFromField("value_changed").setToNode("LeftPectoral").setToField("set_rotation"))
            .addChild(new OrientationInterpolator("RightPectoralRotation").setKey(new double[] {0.0,0.3,0.7,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,.349,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,.349})))
            .addChild(new ROUTE().setFromNode("Timer").setFromField("fraction_changed").setToNode("RightPectoralRotation").setToField("set_fraction"))
            .addChild(new ROUTE().setFromNode("RightPectoralRotation").setFromField("value_changed").setToNode("RightPectoral").setToField("set_rotation"))
            .addChild(new TimeSensor("OrbitClock").setLoop(true)
              .setIS(new IS()
                .addConnect(new connect().setNodeField("cycleInterval").setProtoField("orbitTime"))))
            .addChild(new PositionInterpolator("CirclefishPath")
              .setIS(new IS()
                .addConnect(new connect().setNodeField("key").setProtoField("positionKey"))
                .addConnect(new connect().setNodeField("keyValue").setProtoField("positionKeyValue"))))
            .addChild(new OrientationInterpolator("CircleFishAngle")
              .setIS(new IS()
                .addConnect(new connect().setNodeField("key").setProtoField("orientationKey"))
                .addConnect(new connect().setNodeField("keyValue").setProtoField("orientationKeyValue"))))
            .addChild(new ROUTE().setFromNode("OrbitClock").setFromField("fraction_changed").setToNode("CirclefishPath").setToField("set_fraction"))
            .addChild(new ROUTE().setFromNode("OrbitClock").setFromField("fraction_changed").setToNode("CircleFishAngle").setToField("set_fraction"))
            .addChild(new ROUTE().setFromNode("CirclefishPath").setFromField("value_changed").setToNode("Way").setToField("set_translation"))
            .addChild(new ROUTE().setFromNode("CircleFishAngle").setFromField("value_changed").setToNode("Way").setToField("set_rotation"))))))
    .addComments(" ==================== ")
    .addChild(new ProtoInstance("CircleFishPT").setContainerField("children")));
            }
            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 CircleFishPTPrototype 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 CircleFishPTPrototype().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.CircleFishPTPrototype\" 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.CircleFishPTPrototype self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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