package X3dForAdvancedModeling.Animation;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EventUtilities.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Time.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> Test scene with BooleanSequencer animation of visible field on several X3DBoundedObject nodes, triggering a new feature in X3D4. </p>
 <p> Related links: Catalog page <a href="../../../Animation/VisibleShapesTestIndex.html" target="_blank">VisibleShapesTest</a>,  source <a href="../../../Animation/VisibleShapesTest.java">VisibleShapesTest.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="../../../Animation/VisibleShapesTest.x3d">VisibleShapesTest.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Test scene with BooleanSequencer animation of visible field on several X3DBoundedObject nodes, triggering a new feature in X3D4. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 18 January 2020 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 1 June 2024 </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> specificationSection </i> </td>
			<td> X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 10 Grouping component, 10.3.1 X3DBoundedObject </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> specificationUrl </i> </td>
			<td> <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> specificationSection </i> </td>
			<td> X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 12 Shape component, 12.3.5 X3DShapeNode </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> specificationUrl </i> </td>
			<td> <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html#X3DShapeNode" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html#X3DShapeNode</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/X3dForAdvancedModeling/Animation/VisibleShapesTest.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/VisibleShapesTest.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> X3D-Edit 4.0, <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="../../../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 VisibleShapesTest
{
	/** Default constructor to create this object. */
	public VisibleShapesTest ()
	{
	  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_4_0)
  .setHead(new head()
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("VisibleShapesTest.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Test scene with BooleanSequencer animation of visible field on several X3DBoundedObject nodes, triggering a new feature in X3D4."))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("18 January 2020"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("1 June 2024"))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONSECTION).setContent("X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 10 Grouping component, 10.3.1 X3DBoundedObject"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONURL).setContent("https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONSECTION).setContent("X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 12 Shape component, 12.3.5 X3DShapeNode"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONURL).setContent("https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html#X3DShapeNode"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/VisibleShapesTest.x3d"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("../license.html")))
  .setScene(new Scene()
    .addChild(new WorldInfo().setTitle("VisibleShapesTest.x3d"))
    .addChild(new Viewpoint("EntryView").setDescription("Visible Shapes Test").setPosition(0.0,0.0,12.0))
    .addChild(new Transform("BoxGroupingNode").setTranslation(-3.0,1.5,0.0)
      .addChild(new Shape("BoxShape")
        .setGeometry(new Box())
        .setAppearance(new Appearance()
          .setMaterial(new Material("Red").setDiffuseColor(1.0,0.0,0.0))))
      .addChild(new Transform().setTranslation(0.0,-2.0,0.0)
        .addChild(new Shape("BoxVisibleText")
          .setGeometry(new Text().setString(new String[] {"Box visible"})
            .setFontStyle(new FontStyle("TextStyle").setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setCssStyle("BOLD")))
          .setAppearance(new Appearance()
            .setMaterial(new Material().setUSE("Red")))))
      .addChild(new BooleanSequencer("Pulsar1").setKey(new double[] {0.0,0.25,0.5,0.75,1.0}).setKeyValue(new boolean[] {true,false,true,true,true}))
      .addChild(new ROUTE().setFromNode("Pulsar1").setFromField("value_changed").setToNode("BoxGroupingNode").setToField("visible")))
    .addChild(new Transform("SphereGroupingNode").setTranslation(0.0,1.5,0.0)
      .addChild(new Shape("SphereShape")
        .setGeometry(new Sphere())
        .setAppearance(new Appearance()
          .setMaterial(new Material("Green").setDiffuseColor(0.0,1.0,0.0))))
      .addChild(new Transform().setTranslation(0.0,-3.0,0.0)
        .addChild(new Shape("SphereVisibleText")
          .setGeometry(new Text().setString(new String[] {"Sphere visible"})
            .setFontStyle(new FontStyle().setUSE("TextStyle")))
          .setAppearance(new Appearance()
            .setMaterial(new Material().setUSE("Green")))))
      .addChild(new BooleanSequencer("Pulsar2").setKey(new double[] {0.0,0.25,0.5,0.75,1.0}).setKeyValue(new boolean[] {true,true,false,true,true}))
      .addChild(new ROUTE().setFromNode("Pulsar2").setFromField("value_changed").setToNode("SphereShape").setToField("visible"))
      .addChild(new ROUTE().setFromNode("Pulsar2").setFromField("value_changed").setToNode("SphereVisibleText").setToField("visible")))
    .addChild(new Transform("CylinderGroupingNode").setTranslation(3.0,1.5,0.0)
      .addChild(new Shape("CylinderShape")
        .setGeometry(new Cylinder())
        .setAppearance(new Appearance()
          .setMaterial(new Material("Blue").setDiffuseColor(0.4,0.4,1.0))))
      .addChild(new Transform().setTranslation(0.0,-4.0,0.0)
        .addChild(new Shape("CylinderVisibleText")
          .setGeometry(new Text().setString(new String[] {"Cylinder visible"})
            .setFontStyle(new FontStyle().setUSE("TextStyle")))
          .setAppearance(new Appearance()
            .setMaterial(new Material().setUSE("Blue")))))
      .addChild(new BooleanSequencer("Pulsar3").setKey(new double[] {0.0,0.25,0.5,0.75,1.0}).setKeyValue(new boolean[] {true,true,true,false,true}))
      .addChild(new ROUTE().setFromNode("Pulsar3").setFromField("value_changed").setToNode("CylinderShape").setToField("visible"))
      .addChild(new ROUTE().setFromNode("Pulsar3").setFromField("value_changed").setToNode("CylinderVisibleText").setToField("visible")))
    .addChild(new TimeSensor("SequencerClock").setCycleInterval(8).setLoop(true))
    .addChild(new ROUTE().setFromNode("SequencerClock").setFromField("fraction_changed").setToNode("Pulsar1").setToField("set_fraction"))
    .addChild(new ROUTE().setFromNode("SequencerClock").setFromField("fraction_changed").setToNode("Pulsar2").setToField("set_fraction"))
    .addChild(new ROUTE().setFromNode("SequencerClock").setFromField("fraction_changed").setToNode("Pulsar3").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 VisibleShapesTest 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 VisibleShapesTest().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: \"X3dForAdvancedModeling.Animation.VisibleShapesTest\" 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("X3dForAdvancedModeling.Animation.VisibleShapesTest self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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