package X3dForAdvancedModeling.AdditiveManufacturing;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> The MetadataSet node is allowed as a root node in X3D4, following development and evaluation of examples considered in this demonstration scene. Original inquiry: is a Metadata node legal as the root node in a scene? X3D model metadata sets need to be portable since they might be saved and reused via multiple files. </p>
 <p> Related links: Catalog page <a href="../../../AdditiveManufacturing/MetadataRootNodeTestIndex.html" target="_blank">MetadataRootNodeTest</a>,  source <a href="../../../AdditiveManufacturing/MetadataRootNodeTest.java">MetadataRootNodeTest.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="../../../AdditiveManufacturing/MetadataRootNodeTest.x3d">MetadataRootNodeTest.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> The MetadataSet node is allowed as a root node in X3D4, following development and evaluation of examples considered in this demonstration scene. Original inquiry: is a Metadata node legal as the root node in a scene? X3D model metadata sets need to be portable since they might be saved and reused via multiple files. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Don Brutzman and X3D Working Group </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 8 December 2016 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 31 August 2024 </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, clause 4 Concepts, 4.3.2 Root nodes </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/concepts.html#Rootnodes" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Rootnodes</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="http://web3d.org/pipermail/x3d-public_web3d.org/2016-December/005680.html" target="_blank">http://web3d.org/pipermail/x3d-public_web3d.org/2016-December/005680.html</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> X3D Specification Mantis Issue (member access required) <a href="https://www.web3d.org/member-only/mantis/view.php?id=1092" target="_blank">https://www.web3d.org/member-only/mantis/view.php?id=1092</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/AdditiveManufacturing/MetadataRootNodeTest.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AdditiveManufacturing/MetadataRootNodeTest.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://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="../../../AdditiveManufacturing/../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 and X3D Working Group
 */

public class MetadataRootNodeTest
{
	/** Default constructor to create this object. */
	public MetadataRootNodeTest ()
	{
	  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("MetadataRootNodeTest.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("The MetadataSet node is allowed as a root node in X3D4, following development and evaluation of examples considered in this demonstration scene. Original inquiry: is a Metadata node legal as the root node in a scene? X3D model metadata sets need to be portable since they might be saved and reused via multiple files."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman and X3D Working Group"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("8 December 2016"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("31 August 2024"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONSECTION).setContent("X3D 4.0 Architecture, ISO/IEC 19775-1:2023, clause 4 Concepts, 4.3.2 Root nodes"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONURL).setContent("https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Rootnodes"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("http://web3d.org/pipermail/x3d-public_web3d.org/2016-December/005680.html"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("X3D Specification Mantis Issue (member access required) https://www.web3d.org/member-only/mantis/view.php?id=1092"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AdditiveManufacturing/MetadataRootNodeTest.x3d"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit 4.0, https://www.web3d.org/x3d/tools/X3D-Edit"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("../license.html")))
  .setScene(new Scene()
    .addComments(" ============================= ")
    .addComments(" Option 1: root node of scene ")
    .addMetadata(new MetadataSet("MetadataHolderOption1").setName("MetadataCollection1")
      .addComments(" can enter other Metadata nodes here "))
    .addChild(new Background().setSkyColor(new MFColor(new double[] {0.498039,1.0,0.831373})))
    .addComments(" ============================= ")
    .addComments(" Option 2: contained within WorldInfo, though direct translation to VRML97 is not valid ")
    .addChild(new WorldInfo("MetadataHolderOption2").setTitle("Test scene for containing X3D Metadata* nodes, with no other content")
      .setMetadata(new MetadataSet().setName("MetadataCollection2")
        .addComments(" can enter other Metadata nodes here ")))
    .addComments(" ============================= ")
    .addComments(" Option 3: contained within top-level Group, scope for all contained nodes is unambiguous ")
    .addChild(new Group("MetadataHolderOption3")
      .setMetadata(new MetadataSet().setName("MetadataCollection3")
        .addComments(" can enter other Metadata nodes here ")))
    .addComments(" ============================= ")
    .addComments(" Viewing a Mantis issue first requires Web3D Consortium member login ")
    .addChild(new Anchor().setDescription("Web3D Consortium members can select text to view Mantis issue 1092").setParameter(new String[] {"target=blank"}).setUrl(new String[] {"https://www.web3d.org/member-only/mantis/view.php?id=1092"})
      .addComments(" Selectable Text design pattern has transparent Box and TouchSensor description as a tooltip ")
      .addChild(new Group()
        .addChild(new Shape()
          .setGeometry(new Text().setString(new String[] {"Metadata nodes","tested as children","of scene root","(mantis issue 1092)"})
            .setFontStyle(new FontStyle().setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setCssStyle("BOLD")))
          .setAppearance(new Appearance()
            .setMaterial(new Material().setDiffuseColor(0.0,0.501961,0.109804))))
        .addChild(new Shape()
          .addComments(" Author adjustment: resize transparent Box as text-selection assist, set width and height to match size, then set transparency='1' to make invisible. ")
          .setGeometry(new Box().setSize(8.0,4.0,.001))
          .setAppearance(new Appearance()
            .setMaterial(new Material().setTransparency(1)))))));
            }
            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 MetadataRootNodeTest 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 MetadataRootNodeTest().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.AdditiveManufacturing.MetadataRootNodeTest\" 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.AdditiveManufacturing.MetadataRootNodeTest self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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