package X3dForAdvancedModeling.GeometricShapes;

/*
Copyright (c) 1995-2022 held by the author(s).  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer
      in the documentation and/or other materials provided with the
      distribution.
    * Neither the name of the Web3D Consortium (https://www.web3d.org)
      nor the names of its contributors may be used to endorse or
      promote products derived from this software without specific
      prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/

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

// Javadoc annotations follow, see below for Java source code.
/**
 * <p> Semitransparent Sphere with circumference circles on x-y-z planes to facilitate user rotation of an object, suitable for use as rotation widget. Labeled box also inserted as Inline. </p>
 <p> Related links: <a href="../../../GeometricShapes/SphereWithThreeCircumferenceRings.java">SphereWithThreeCircumferenceRings.java</a> source, <a href="../../../GeometricShapes/SphereWithThreeCircumferenceRingsIndex.html" target="_top">SphereWithThreeCircumferenceRings catalog page</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="../../../GeometricShapes/SphereWithThreeCircumferenceRings.x3d">SphereWithThreeCircumferenceRings.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> Semitransparent Sphere with circumference circles on x-y-z planes to facilitate user rotation of an object, suitable for use as rotation widget. Labeled box also inserted as Inline. </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> created </i> </td>
			<td> 10 May 2013 </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> TODO </i> </td>
			<td> Consider using TwoSidedMaterial with external transparency on Sphere so that only reverse circles are greyed out (similar to MeshLab widget) </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> TODO </i> </td>
			<td> Add widget to X3D-Edit palette </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> hint </i> </td>
			<td> The labeled box CubeWithLabeledSides.x3d is inserted as an Inline in order to see orientations, authors can remove that and copy the rest if they want. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> Image </i> </td>
			<td> <a href="../../../GeometricShapes/SphereWithThreeCircumferenceRingsContainingBox.png">SphereWithThreeCircumferenceRingsContainingBox.png</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> subject </i> </td>
			<td> TouchSensor Interface </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> identifier </i> </td>
			<td> <a href="https://x3dgraphics.com/examples/X3dForAdvancedModeling/GeometricShapes/SphereWithThreeCircumferenceRings.x3d" target="_blank">https://x3dgraphics.com/examples/X3dForAdvancedModeling/GeometricShapes/SphereWithThreeCircumferenceRings.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="../../../GeometricShapes/../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 to create Java source code from an <code>.x3d</code> model.
	</p>

	* @author Don Brutzman
 */

public class SphereWithThreeCircumferenceRings
{
	/** Default constructor to create this object. */
	public SphereWithThreeCircumferenceRings ()
	{
	  initialize();
	}

	/** Create and initialize the X3D model for this object. */
	public final void initialize()
	{
  x3dModel = new X3D().setProfile(X3D.PROFILE_INTERACTIVE).setVersion(X3D.VERSION_3_3)
  .setHead(new head()
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("SphereWithThreeCircumferenceRings.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Semitransparent Sphere with circumference circles on x-y-z planes to facilitate user rotation of an object, suitable for use as rotation widget. Labeled box also inserted as Inline."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("10 May 2013"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("20 October 2019"))
    .addMeta(new meta().setName(meta.NAME_TODO       ).setContent("Consider using TwoSidedMaterial with external transparency on Sphere so that only reverse circles are greyed out (similar to MeshLab widget)"))
    .addMeta(new meta().setName(meta.NAME_TODO       ).setContent("Add widget to X3D-Edit palette"))
    .addMeta(new meta().setName(meta.NAME_HINT       ).setContent("The labeled box CubeWithLabeledSides.x3d is inserted as an Inline in order to see orientations, authors can remove that and copy the rest if they want."))
    .addMeta(new meta().setName(meta.NAME_IMAGE      ).setContent("SphereWithThreeCircumferenceRingsContainingBox.png"))
    .addMeta(new meta().setName(meta.NAME_SUBJECT    ).setContent("TouchSensor Interface"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://x3dgraphics.com/examples/X3dForAdvancedModeling/GeometricShapes/SphereWithThreeCircumferenceRings.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("SphereWithThreeCircumferenceRings.x3d"))
    .addChild(new Viewpoint().setDescription("Sphere with 3 circumferences around labeled cube").setPosition(0.0,0.0,4.0))
    .addChild(new Background().setSkyColor(new MFColor(new double[] {0.3,0.7,0.7})))
    .addChild(new Transform().setScale(0.5,0.5,0.5)
      .addComments(" CubeWithLabeledSides.x3d has profile='Interchange' ")
      .addChild(new Inline().setUrl(new String[] {"CubeWithLabeledSides.x3d","https://x3dgraphics.com/examples/X3dForAdvancedModeling/GeometricShapes/CubeWithLabeledSides.x3d","CubeWithLabeledSides.wrl","https://x3dgraphics.com/examples/X3dForAdvancedModeling/GeometricShapes/CubeWithLabeledSides.wrl"})))
    .addComments(" *Authors* the following scene subgraph is portable and can easily be copied for use in other scenes. ")
    .addChild(new Transform("SphereWithThreeCircumferenceRingsTransform")
      .addChild(new Shape()
        .setGeometry(new Sphere().setRadius(0.9999))
        .setAppearance(new Appearance("AppearanceGreyDiffuseTransparent")
          .setMaterial(new Material().setDiffuseColor(0.8,0.8,0.5).setTransparency(0.95))))
      .addChild(new Shape()
        .addComments(" X-Y plane, perpendicular to Z axis ")
        .setGeometry(new LineSet("Circle120LineSet").setVertexCount(new int[] {121})
          .setCoord(new Coordinate("CirclePoints60").setPoint(getCirclePoints60_6_24_point())))
        .setAppearance(new Appearance("BlueEmissive")
          .setMaterial(new Material().setEmissiveColor(0.0,0.0,1.0).setTransparency(0.8))))
      .addChild(new Transform().setRotation(1.0,0.0,0.0,1.570796)
        .addComments(" X-Z plane, perpendicular to Y axis ")
        .addChild(new Shape()
          .setGeometry(new LineSet().setUSE("Circle120LineSet"))
          .setAppearance(new Appearance("GreenEmissive")
            .setMaterial(new Material().setEmissiveColor(0.0,1.0,0.0).setTransparency(0.8)))))
      .addChild(new Transform().setRotation(0.0,1.0,0.0,1.570796)
        .addComments(" Y-Z plane, perpendicular to X axis ")
        .addChild(new Shape()
          .setGeometry(new LineSet().setUSE("Circle120LineSet"))
          .setAppearance(new Appearance("RedEmissive")
            .setMaterial(new Material().setEmissiveColor(1.0,0.0,0.0).setTransparency(0.8)))))));
    }
	// end of initialize() method

		/** Define subarrays using type double[] */
		private double[] getCirclePoints60_6_24_point_1()
		{
			double[] value = {0.0,1.0,0.0,0.052,0.999,0.0,0.105,0.995,0.0,0.156,0.988,0.0,0.208,0.978,0.0,0.259,0.966,0.0,0.309,0.951,0.0,0.358,0.934,0.0,0.407,0.914,0.0,0.454,0.891,0.0,0.5,0.866,0.0,0.545,0.839,0.0,0.588,0.809,0.0,0.629,0.777,0.0,0.669,0.743,0.0,0.707,0.707,0.0,0.743,0.669,0.0,0.777,0.629,0.0,0.809,0.588,0.0,0.839,0.545,0.0,0.866,0.5,0.0,0.891,0.454,0.0,0.914,0.407,0.0,0.934,0.358,0.0,0.951,0.309,0.0,0.966,0.259,0.0,0.978,0.208,0.0,0.988,0.156,0.0,0.995,0.105,0.0,0.999,0.052,0.0,1.0,0.0,0.0,0.999,-0.052,0.0,0.995,-0.105,0.0,0.988,-0.156,0.0,0.978,-0.208,0.0,0.966,-0.259,0.0,0.951,-0.309,0.0,0.934,-0.358,0.0,0.914,-0.407,0.0,0.891,-0.454,0.0,0.866,-0.5,0.0,0.839,-0.545,0.0,0.809,-0.588,0.0,0.777,-0.629,0.0,0.743,-0.669,0.0,0.707,-0.707,0.0,0.669,-0.743,0.0,0.629,-0.777,0.0,0.588,-0.809,0.0,0.545,-0.839,0.0,0.5,-0.866,0.0,0.454,-0.891,0.0,0.407,-0.914,0.0,0.358,-0.934,0.0,0.309,-0.951,0.0,0.259,-0.966,0.0,0.208,-0.978,0.0,0.156,-0.988,0.0,0.105,-0.995,0.0,0.052,-0.999,0.0,0.0,-1.0,0.0,-0.052,-0.999,0.0,-0.105,-0.995,0.0,-0.156,-0.988,0.0,-0.208,-0.978,0.0,-0.259,-0.966,0.0,-0.309,-0.951,0.0,-0.358,-0.934,0.0,-0.407,-0.914,0.0,-0.454,-0.891,0.0,-0.5,-0.866,0.0,-0.545,-0.839,0.0,-0.588,-0.809,0.0,-0.629,-0.777,0.0,-0.669,-0.743,0.0,-0.707,-0.707,0.0,-0.743,-0.669,0.0,-0.777,-0.629,0.0,-0.809,-0.588,0.0,-0.839,-0.545,0.0,-0.866,-0.5,0.0,-0.891,-0.454,0.0,-0.914,-0.407,0.0,-0.934,-0.358,0.0,-0.951,-0.309,0.0,-0.966,-0.259,0.0,-0.978,-0.208,0.0,-0.988,-0.156,0.0,-0.995,-0.105,0.0,-0.999,-0.052,0.0,-1.0,-0.0,0.0,-0.999,0.052,0.0,-0.995,0.105,0.0,-0.988,0.156,0.0,-0.978,0.208,0.0,-0.966,0.259,0.0,-0.951,0.309,0.0,-0.934,0.358,0.0,-0.914,0.407,0.0,-0.891,0.454,0.0};
			return value;
		}
		private double[] getCirclePoints60_6_24_point_2()
		{
			double[] value = {-0.866,0.5,0.0,-0.839,0.545,0.0,-0.809,0.588,0.0,-0.777,0.629,0.0,-0.743,0.669,0.0,-0.707,0.707,0.0,-0.669,0.743,0.0,-0.629,0.777,0.0,-0.588,0.809,0.0,-0.545,0.839,0.0,-0.5,0.866,0.0,-0.454,0.891,0.0,-0.407,0.914,0.0,-0.358,0.934,0.0,-0.309,0.951,0.0,-0.259,0.966,0.0,-0.208,0.978,0.0,-0.156,0.988,0.0,-0.105,0.995,0.0,-0.052,0.999,0.0,0.0,1.0,0.0};
			return value;
		}

		/** Large attribute array: Coordinate DEF='CirclePoints60' point field, scene-graph level=6, element #24, 363 total numbers made up of 121 3-tuple values.
		 * Reassemble split array as single method to improve readability and runnability.
		 * Provide large array values via separate methods, hoping to avoid 'code too large' Java compilation errors. 
		 * Individual Java methods (including aggregated initializations) are limited to 64KB.
		 * @see https://stackoverflow.com/questions/2407912/code-too-large-compilation-error-in-java
		 * @see https://stackoverflow.com/questions/11437905/java-too-many-constants-jvm-error
		 */
		private MFVec3f getCirclePoints60_6_24_point()
		{
			MFVec3f CirclePoints60_6_24_point = new MFVec3f()/*2.finalize*/
				.append(new MFVec3f(getCirclePoints60_6_24_point_1()))
				.append(new MFVec3f(getCirclePoints60_6_24_point_2()));
			return CirclePoints60_6_24_point;
		}

	/** 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 SphereWithThreeCircumferenceRings 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[])
    {
        X3D thisExampleX3dModel = new SphereWithThreeCircumferenceRings().getX3dModel();

		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.GeometricShapes.SphereWithThreeCircumferenceRings\" 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.print("Java program \"X3dForAdvancedModeling.GeometricShapes.SphereWithThreeCircumferenceRings\" self-validation test results: ");
			String validationResults = thisExampleX3dModel.validationReport();
            if (validationResults.startsWith("\n"))
                System.out.println();
			System.out.println(validationResults.trim());
		}
    }
}
