package Savage.Tools.HeadsUpDisplays;

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.Lighting.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Rendering.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Texturing.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> Example use of CompassRose prototype, a heads-up display (HUD) showing heading for current viewpoint direction. </p>
 <p> Related links: Catalog page <a href="../../../../Tools/HeadsUpDisplays/CompassRoseExampleIndex.html" target="_blank">CompassRoseExample</a>,  source <a href="../../../../Tools/HeadsUpDisplays/CompassRoseExample.java">CompassRoseExample.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="../../../../Tools/HeadsUpDisplays/CompassRoseExample.x3d">CompassRoseExample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Example use of CompassRose prototype, a heads-up display (HUD) showing heading for current viewpoint direction. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Christian Greuel, Director of Art &amp; Production, Planet 9 Studios, Inc. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> translator </i> </td>
			<td> Xeena VRML importer, X3D-Edit 3.1, <a href="https://www.web3d.org/x3d/content/README.X3D-Edit.html" target="_blank">https://www.web3d.org/x3d/content/README.X3D-Edit.html</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 1 August 2006 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> translated </i> </td>
			<td> 14 October 2006 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 28 November 2019 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> Image </i> </td>
			<td> <a href="../../../../Tools/HeadsUpDisplays/Textures/CompassHeadings.png">Textures/CompassHeadings.png</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> originals/CompassRoseExample.wrl </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> subject </i> </td>
			<td> compass rose heads-up display HUD </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/Savage/Tools/HeadsUpDisplays/CompassRoseExample.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CompassRoseExample.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> X3D-Edit, <a href="https://www.web3d.org/x3d/content/README.X3D-Edit.html" target="_blank">https://www.web3d.org/x3d/content/README.X3D-Edit.html</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> Vrml97ToX3dNist, <a href="http://ovrt.nist.gov/v2_x3d.html" target="_blank">http://ovrt.nist.gov/v2_x3d.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 Christian Greuel, Director of Art &amp; Production, Planet 9 Studios, Inc.
 */

public class CompassRoseExample
{
	/** Default constructor to create this object. */
	public CompassRoseExample ()
	{
	  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_0)
  .setHead(new head()
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("CompassRoseExample.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Example use of CompassRose prototype, a heads-up display (HUD) showing heading for current viewpoint direction."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Christian Greuel, Director of Art & Production, Planet 9 Studios, Inc."))
    .addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Xeena VRML importer, X3D-Edit 3.1, https://www.web3d.org/x3d/content/README.X3D-Edit.html"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("1 August 2006"))
    .addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("14 October 2006"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("28 November 2019"))
    .addMeta(new meta().setName(meta.NAME_IMAGE      ).setContent("Textures/CompassHeadings.png"))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("originals/CompassRoseExample.wrl"))
    .addMeta(new meta().setName(meta.NAME_SUBJECT    ).setContent("compass rose heads-up display HUD"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CompassRoseExample.x3d"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit, https://www.web3d.org/x3d/content/README.X3D-Edit.html"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("Vrml97ToX3dNist, http://ovrt.nist.gov/v2_x3d.html")))
  .setScene(new Scene()
    .addChild(new WorldInfo().setInfo(new String[] {"Christian Greuel, Director of Art & Production"}).setTitle("Compass Rose Example"))
    .addChild(new ExternProtoDeclare("CompassRose").setName("CompassRose").setUrl(new String[] {"CompassRosePrototype.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CompassRosePrototype.x3d","CompassRosePrototype.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CompassRosePrototype.wrl"})
      .addField(new field().setName("size").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
      .addField(new field().setName("locationOffset").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)))
    .addChild(new NavigationInfo().setType(new String[] {"WALK","ANY"}))
    .addChild(new Viewpoint("GroundCamera").setDescription("Ground Camera").setFieldOfView(0.6024).setOrientation(1.0,0.0,0.0,0.0).setPosition(0.0,1.75,0.0))
    .addChild(new PointLight().setLocation(0.0,10.0,0.0).setRadius(20.0))
    .addChild(new ProtoInstance("CompassRose").setContainerField("children")
      .addFieldValue(new fieldValue().setName("size").setValue(new SFVec3f(1.0,1.0,1.0)))
      .addFieldValue(new fieldValue().setName("locationOffset").setValue(new SFVec3f(-0.075,-0.045,0.0))))
    .addChild(new Transform("Ground").setTranslation(0.0,4.5E-5,0.0)
      .addChild(new Transform("GridBlue")
        .addChild(new Shape()
          .setAppearance(new Appearance()
            .setMaterial(new Material().setDiffuseColor(0.6039,0.7255,0.898)))
          .setGeometry(new IndexedFaceSet().setCoordIndex(new int[] {5,0,6,-1,1,6,0,-1,7,2,8,-1,3,8,2,-1,10,4,11,-1,5,11,4,-1,12,6,13,-1,7,13,6,-1,14,8,15,-1,9,15,8,-1,17,11,18,-1,12,18,11,-1,19,13,20,-1,14,20,13,-1,22,16,23,-1,17,23,16,-1,24,18,25,-1,19,25,18,-1,26,20,27,-1,21,27,20,-1,28,23,29,-1,24,29,23,-1,30,25,31,-1,26,31,25,-1})
            .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-3.0,0.0,5.0,-1.0,0.0,5.0,1.0,0.0,5.0,3.0,0.0,5.0,-5.0,0.0,3.0,-3.0,0.0,3.0,-1.0,0.0,3.0,1.0,0.0,3.0,3.0,0.0,3.0,5.0,0.0,3.0,-5.0,0.0,1.0,-3.0,0.0,1.0,-1.0,0.0,1.0,1.0,0.0,1.0,3.0,0.0,1.0,5.0,0.0,1.0,-5.0,0.0,-1.0,-3.0,0.0,-1.0,-1.0,0.0,-1.0,1.0,0.0,-1.0,3.0,0.0,-1.0,5.0,0.0,-1.0,-5.0,0.0,-3.0,-3.0,0.0,-3.0,-1.0,0.0,-3.0,1.0,0.0,-3.0,3.0,0.0,-3.0,5.0,0.0,-3.0,-3.0,0.0,-5.0,-1.0,0.0,-5.0,1.0,0.0,-5.0,3.0,0.0,-5.0}))))))
      .addChild(new Transform("GridRed")
        .addChild(new Shape()
          .setAppearance(new Appearance()
            .setMaterial(new Material().setDiffuseColor(0.8902,0.5961,0.5961)))
          .setGeometry(new IndexedFaceSet().setCoordIndex(new int[] {6,0,7,-1,1,7,0,-1,8,2,9,-1,3,9,2,-1,10,4,11,-1,5,11,4,-1,13,7,14,-1,8,14,7,-1,15,9,16,-1,10,16,9,-1,18,12,19,-1,13,19,12,-1,20,14,21,-1,15,21,14,-1,22,16,23,-1,17,23,16,-1,25,19,26,-1,20,26,19,-1,27,21,28,-1,22,28,21,-1,30,24,31,-1,25,31,24,-1,32,26,33,-1,27,33,26,-1,34,28,35,-1,29,35,28,-1})
            .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-5.0,0.0,5.0,-3.0,0.0,5.0,-1.0,0.0,5.0,1.0,0.0,5.0,3.0,0.0,5.0,5.0,0.0,5.0,-5.0,0.0,3.0,-3.0,0.0,3.0,-1.0,0.0,3.0,1.0,0.0,3.0,3.0,0.0,3.0,5.0,0.0,3.0,-5.0,0.0,1.0,-3.0,0.0,1.0,-1.0,0.0,1.0,1.0,0.0,1.0,3.0,0.0,1.0,5.0,0.0,1.0,-5.0,0.0,-1.0,-3.0,0.0,-1.0,-1.0,0.0,-1.0,1.0,0.0,-1.0,3.0,0.0,-1.0,5.0,0.0,-1.0,-5.0,0.0,-3.0,-3.0,0.0,-3.0,-1.0,0.0,-3.0,1.0,0.0,-3.0,3.0,0.0,-3.0,5.0,0.0,-3.0,-5.0,0.0,-5.0,-3.0,0.0,-5.0,-1.0,0.0,-5.0,1.0,0.0,-5.0,3.0,0.0,-5.0,5.0,0.0,-5.0}))))))
      .addChild(new Collision().setEnabled(false)
        .addChild(new Transform("HeadingE").setRotation(0.5774,-0.5774,0.5774,-4.189).setTranslation(6.0,1.0,0.0)
          .addChild(new Shape()
            .setAppearance(new Appearance()
              .setMaterial(new Material().setAmbientIntensity(1.0).setDiffuseColor(0.588,0.588,0.588).setShininess(0.145))
              .setTexture(new ImageTexture().setUrl(new String[] {"Textures/HeadingE.png","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/Textures/HeadingE.png"})))
            .setGeometry(new IndexedFaceSet().setCoordIndex(new int[] {2,0,3,-1,1,3,0,-1}).setTexCoordIndex(new int[] {6,4,7,-1,5,7,4,-1})
              .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-0.5,0.0,0.5,0.5,0.0,0.5,-0.5,0.0,-0.5,0.5,0.0,-0.5})))
              .setTexCoord(new TextureCoordinate().setPoint(new MFVec2f(new double[] {0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,1.0,1.0,1.0}))))))
        .addChild(new Transform("HeadingN").setRotation(-1.0,0.0,0.0,-1.571).setTranslation(0.0,1.0,-6.0)
          .addChild(new Shape()
            .setAppearance(new Appearance()
              .setMaterial(new Material().setAmbientIntensity(1.0).setDiffuseColor(0.588,0.588,0.588).setShininess(0.145))
              .setTexture(new ImageTexture().setUrl(new String[] {"Textures/HeadingN.png","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/Textures/HeadingN.png"})))
            .setGeometry(new IndexedFaceSet().setCoordIndex(new int[] {2,0,3,-1,1,3,0,-1}).setTexCoordIndex(new int[] {6,4,7,-1,5,7,4,-1})
              .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-0.5,0.0,0.5,0.5,0.0,0.5,-0.5,0.0,-0.5,0.5,0.0,-0.5})))
              .setTexCoord(new TextureCoordinate().setPoint(new MFVec2f(new double[] {0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,1.0,1.0,1.0}))))))
        .addChild(new Transform("HeadingS").setRotation(0.0,-0.7071,0.7071,-3.142).setTranslation(0.0,1.0,6.0)
          .addChild(new Shape()
            .setAppearance(new Appearance()
              .setMaterial(new Material().setAmbientIntensity(1.0).setDiffuseColor(0.588,0.588,0.588).setShininess(0.145))
              .setTexture(new ImageTexture().setUrl(new String[] {"Textures/HeadingS.png","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/Textures/HeadingS.png"})))
            .setGeometry(new IndexedFaceSet().setCoordIndex(new int[] {2,0,3,-1,1,3,0,-1}).setTexCoordIndex(new int[] {6,4,7,-1,5,7,4,-1})
              .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-0.5,0.0,0.5,0.5,0.0,0.5,-0.5,0.0,-0.5,0.5,0.0,-0.5})))
              .setTexCoord(new TextureCoordinate().setPoint(new MFVec2f(new double[] {0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,1.0,1.0,1.0}))))))
        .addChild(new Transform("HeadingW").setRotation(-0.5774,-0.5774,0.5774,-2.094).setTranslation(-6.0,1.0,0.0)
          .addChild(new Shape()
            .setAppearance(new Appearance()
              .setMaterial(new Material().setAmbientIntensity(1.0).setDiffuseColor(0.588,0.588,0.588).setShininess(0.145))
              .setTexture(new ImageTexture().setUrl(new String[] {"Textures/HeadingW.png","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/Textures/HeadingW.png"})))
            .setGeometry(new IndexedFaceSet().setCoordIndex(new int[] {2,0,3,-1,1,3,0,-1}).setTexCoordIndex(new int[] {6,4,7,-1,5,7,4,-1})
              .setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-0.5,0.0,0.5,0.5,0.0,0.5,-0.5,0.0,-0.5,0.5,0.0,-0.5})))
              .setTexCoord(new TextureCoordinate().setPoint(new MFVec2f(new double[] {0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,1.0,1.0,1.0})))))))));
            }
            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 CompassRoseExample 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 CompassRoseExample().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: \"Savage.Tools.HeadsUpDisplays.CompassRoseExample\" 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("Savage.Tools.HeadsUpDisplays.CompassRoseExample self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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