package Basic.VolumeRendering;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Texturing3D.*;
import org.web3d.x3d.jsail.VolumeRendering.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> Volume rendering of a CT scan of a skull, rendered as an isosurface with cartoon render style. </p>
 <p> Related links: Catalog page <a href="../../../VolumeRendering/IsoSurfaceSkullIndex.html" target="_blank">IsoSurfaceSkull</a>,  source <a href="../../../VolumeRendering/IsoSurfaceSkull.java">IsoSurfaceSkull.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="../../../VolumeRendering/IsoSurfaceSkull.x3d">IsoSurfaceSkull.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Volume rendering of a CT scan of a skull, rendered as an isosurface with cartoon render style </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 24 March 2011 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 29 March 2020 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Andrew Wood, Nicholas Polys: Virginia Tech </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="../../../VolumeRendering/IsoSurfaceSkull.x3d">IsoSurfaceSkull.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> README.txt </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> Get prerequisite dataset, <a href="http://snoid.sv.vt.edu/medical/X3DVolumes/examples/datasets/nrrd/skull.nrrd" target="_blank">http://snoid.sv.vt.edu/medical/X3DVolumes/examples/datasets/nrrd/skull.nrrd</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> All datasets, <a href="http://snoid.sv.vt.edu/medical/X3DVolumes/examples/datasets/datasets.zip" target="_blank">http://snoid.sv.vt.edu/medical/X3DVolumes/examples/datasets/datasets.zip</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> All datasets, <a href="https://savage.nps.edu/Savage/VolumeRendering/datasets/nrrd/datasets.zip" target="_blank">https://savage.nps.edu/Savage/VolumeRendering/datasets/nrrd/datasets.zip</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> Run the download target in the Ant build.xml file to install reference nrrd files locally. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="../../../VolumeRendering/build.xml">build.xml</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/Basic/VolumeRendering/IsoSurfaceSkull.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Basic/VolumeRendering/IsoSurfaceSkull.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> Volume Data obtained from <a href="http://www.volvis.org" target="_blank">http://www.volvis.org</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> Nrrd conversion utility located at <a href="http://teem.sourceforge.net/unrrdu" target="_blank">http://teem.sourceforge.net/unrrdu</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="../../../VolumeRendering/../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 Andrew Wood, Nicholas Polys: Virginia Tech
 */

public class IsoSurfaceSkull
{
	/** Default constructor to create this object. */
	public IsoSurfaceSkull ()
	{
	  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()
    .addComponent(new component().setName("VolumeRendering").setLevel(2))
    .addComponent(new component().setName("Texturing3D").setLevel(2))
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("IsoSurfaceSkull.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Volume rendering of a CT scan of a skull, rendered as an isosurface with cartoon render style"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("24 March 2011"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("29 March 2020"))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Andrew Wood, Nicholas Polys: Virginia Tech"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("IsoSurfaceSkull.x3d"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("README.txt"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("Get prerequisite dataset, http://snoid.sv.vt.edu/medical/X3DVolumes/examples/datasets/nrrd/skull.nrrd"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("All datasets, http://snoid.sv.vt.edu/medical/X3DVolumes/examples/datasets/datasets.zip"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("All datasets, https://savage.nps.edu/Savage/VolumeRendering/datasets/nrrd/datasets.zip"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("Run the download target in the Ant build.xml file to install reference nrrd files locally."))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("build.xml"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Basic/VolumeRendering/IsoSurfaceSkull.x3d"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("Volume Data obtained from http://www.volvis.org"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("Nrrd conversion utility located at http://teem.sourceforge.net/unrrdu"))
    .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("IsoSurfaceSkull.x3d"))
    .addChild(new Group()
      .addChild(new Viewpoint("VP").setDescription("IsoSurface Skull").setOrientation(-0.675123,0.549845,0.491812,4.56937).setPosition(-0.294435,-0.11334,0.0508642))
      .addChild(new Background("BG"))
      .addChild(new Transform().setScale(0.117188,0.117188,0.117188)
        .addChild(new IsoSurfaceVolumeData().setDimensions(1.28,1.28,1.28).setSurfaceValues(new double[] {.15})
          .addRenderStyle(new CartoonVolumeStyle().setColorSteps(32))
          .setVoxels(new ImageTexture3D().setUrl(new String[] {"datasets/nrrd/skull.nrrd","http://snoid.sv.vt.edu/medical/X3DVolumes/examples/datasets/nrrd/skull.nrd","https://savage.nps.edu/Savage/VolumeRendering/datasets/nrrd/skull.nrd"}))))));
            }
            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 IsoSurfaceSkull 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 IsoSurfaceSkull().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: \"Basic.VolumeRendering.IsoSurfaceSkull\" 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("Basic.VolumeRendering.IsoSurfaceSkull self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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