package Savage.CommunicationsAndSensors.SeaWeb;

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.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Scripting.*;
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> An acoustic transmission cylinder has a moving inner radius and a constant (maximum) outer radius, visualizing the pulse width of cylindrical propagation. </p>
 <p> Related links: Catalog page <a href="../../../../CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderPrototypeIndex.html" target="_blank">AcousticTransmissionCylinderPrototype</a>,  source <a href="../../../../CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderPrototype.java">AcousticTransmissionCylinderPrototype.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="../../../../CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderPrototype.x3d">AcousticTransmissionCylinderPrototype.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> An acoustic transmission cylinder has a moving inner radius and a constant (maximum) outer radius, visualizing the pulse width of cylindrical propagation. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Don Brutzman and Oliver Tan </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 11 May 2004 </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> subject </i> </td>
			<td> Acoustic transmission </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/CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderPrototype.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderPrototype.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> X3D-Edit 3.2, <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="../../../../CommunicationsAndSensors/SeaWeb/../../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 Oliver Tan
 */

public class AcousticTransmissionCylinderPrototype
{
	/** Default constructor to create this object. */
	public AcousticTransmissionCylinderPrototype ()
	{
	  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("AcousticTransmissionCylinderPrototype.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("An acoustic transmission cylinder has a moving inner radius and a constant (maximum) outer radius, visualizing the pulse width of cylindrical propagation."))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman and Oliver Tan"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("11 May 2004"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("20 October 2019"))
    .addMeta(new meta().setName(meta.NAME_SUBJECT    ).setContent("Acoustic transmission"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderPrototype.x3d"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit 3.2, https://www.web3d.org/x3d/tools/X3D-Edit"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("../../license.html")))
  .setScene(new Scene()
    .addChild(new ProtoDeclare("AcousticTransmissionCylinder").setName("AcousticTransmissionCylinder").setAppinfo("AcousticTransmissionCylinder visualizes the pulse width of cylindrical propagation with has a receding inner radius and a (maximum outer radius .")
      .setProtoInterface(new ProtoInterface()
        .addField(new field().setName("startTransmission").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Upon receipt of a boolean true event start a single (not continuous) transmission"))
        .addField(new field().setName("startContinuousTransmissions").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Upon receipt of a boolean true event start continuous transmissions"))
        .addField(new field().setName("set_range").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Propagation range in meters"))
        .addField(new field().setName("defaultRange").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(2).setAppinfo("Default propagation range in meters"))
        .addField(new field().setName("transmissionPropagationSpeed").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(1500).setAppinfo("Speed in meters / second"))
        .addField(new field().setName("set_transmissionDuration").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Duration in seconds"))
        .addField(new field().setName("transmissionDuration").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(5).setAppinfo("Duration in seconds"))
        .addField(new field().setName("set_beamCount").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Number of segmented sections in 360-degree cylindrical beam"))
        .addField(new field().setName("beamCount").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0).setAppinfo("number of segmented sections in 360-degree cylindrical beam"))
        .addField(new field().setName("height").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(2).setAppinfo("Height of cylinder in meters"))
        .addField(new field().setName("set_color").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Color of cylinder"))
        .addField(new field().setName("color").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFColor(1.0,1.0,0.2)).setAppinfo("Default color of cylinder"))
        .addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false)))
      .setProtoBody(new ProtoBody()
        .addChild(new Group()
          .addChild(new Shape()
            .setGeometry(new Extrusion("TransmissionProfile").setBeginCap(false).setConvex(false).setCreaseAngle(3.14).setEndCap(false))
            .setAppearance(new Appearance()
              .setMaterial(new Material("TransmissionProfileMaterial"))))
          .addChild(new TimeSensor("AnimationClock"))
          .addChild(new TimeSensor("RestartClock"))
          .addChild(new ROUTE().setFromNode("RestartClock").setFromField("cycleTime").setToNode("AnimationClock").setToField("set_startTime"))
          .addChild(new Script("TransmissionPropagationScript").setDirectOutput(true).setSourceCode("""
ecmascript:

function initialize()
{
	outerRadius = -1.0;
	innerRadius = -1.0;

	animationDuration = defaultRange / transmissionPropagationSpeed + transmissionDuration;

	tracePrint('beamCount = ' + beamCount);
	tracePrint('defaultRange = ' + defaultRange);
	tracePrint('animationDuration=' + animationDuration);
	tracePrint('transmissionPropagationSpeed=' + transmissionPropagationSpeed);

	computeSpine(beamCount);

    updateCrossSection(0);

	updateExtrusionShape(crossSection, spine, color);
}
function updateRadii(fraction)
{
	_transmissionPropagationDuration = defaultRange / transmissionPropagationSpeed;
	_animationDuration = _transmissionPropagationDuration + transmissionDuration;
	_spineRadius = 1;
	
	outerRadius = fraction * _animationDuration * transmissionPropagationSpeed - _spineRadius;

	if (outerRadius > (defaultRange - _spineRadius)) {
		outerRadius = defaultRange - _spineRadius;
	}

	if ((fraction * _animationDuration) > (_transmissionPropagationDuration + transmissionDuration * 7/8)) 
	{
		transparency_changed = ( (fraction * _animationDuration) - (_transmissionPropagationDuration + transmissionDuration * 7/8) ) / (transmissionDuration * 1/8);
	}

	if ((fraction * _animationDuration) <= transmissionDuration)
	{
		innerRadius = -_spineRadius;
	} else {
		innerRadius = ((fraction * _animationDuration) - transmissionDuration) * transmissionPropagationSpeed - _spineRadius;
		if (innerRadius > defaultRange) {
			innerRadius = defaultRange;
		}
	}

	tracePrint('fraction = ' + fraction);
	tracePrint('outerRadius = ' + outerRadius);
	tracePrint('innerRadius = ' + innerRadius);
}
function set_beamCount (beamCount)
{
    alwaysPrint('set_beamCount(' + beamCount + '), beam spacing=' + (360/beamCount) + ' degrees');
    computeSpine(beamCount);
}
function computeSpine (beamCount)
{
	if (beamCount < 3)
    {
        alwaysPrint('** insufficient beamCount=' + beamCount + ', ignored, spine not recomputed');
        return;
    }
    newSpine = new MFVec3f ();
    for (index = 0; index <= beamCount; index++)
	{
		angle = 2.0 * Math.PI * index / beamCount;
        newSpine[index] = new SFVec3f (Math.sin(angle), 0.0, Math.cos(angle));
	}
    newSpine[beamCount] = newSpine[0]; // ensure beginning point matches end point
    spine = newSpine;
	tracePrint('spine.length=' + spine.length + ', spine=' + spine);
}
function updateCrossSection(fraction)
{
	updateRadii(fraction);

	_spineRadius = 1;
	_outerHeight = Math.abs((outerRadius + _spineRadius) * Math.tan(Math.PI/6));

	if (_outerHeight > height)
	{
		_outerHeight = height;
	}

	_innerHeight = Math.abs((innerRadius + _spineRadius) * Math.tan(Math.PI/6));

	if (_innerHeight > height)
	{
		_innerHeight = height;
	}

	index = 0;
	position[index]     = new SFVec2f(outerRadius, _outerHeight/2);
	crossSection[index] = new SFVec2f(position[index].x, position[index].y);
	index++;
	
	position[index]     = new SFVec2f(innerRadius, _innerHeight/2);
	crossSection[index] = new SFVec2f(position[index].x, position[index].y);
	index++;

	position[index]     = new SFVec2f(innerRadius, -_innerHeight/2);
	crossSection[index] = new SFVec2f(position[index].x, position[index].y);
	index++;

	position[index]     = new SFVec2f(outerRadius, -_outerHeight/2);
	crossSection[index] = new SFVec2f(position[index].x, position[index].y);
	index++;

	position[index]     = new SFVec2f(outerRadius, _outerHeight/2);
	crossSection[index] = new SFVec2f(position[index].x, position[index].y);
	
	tracePrint('position     = ' + position);
	tracePrint('crossSection = ' + crossSection);
}
function startTransmission(value, timeStamp)
{
	if (value == true)
	{
		loopAnimation = false;
		loopStartTime = -1;
		animationStartTime = timeStamp;
		tracePrint('startTransmission ()');
	}
}
function startContinuousTransmissions(value, timeStamp)
{
	if (value == true)
	{
		loopAnimation = true;
		loopStartTime = timeStamp;
		animationStartTime = timeStamp;
		tracePrint('startContinuousTransmissions ()');
	}
}
function set_range(value, timeStamp)
{
	if (value >= 0)
	{
		defaultRange = value;
		tracePrint('defaultRange = ' + defaultRange);
	}
	else tracePrint('set_range (' + value + '); // no response, negative');
}
function set_color(value, timeStamp)
{
	color = value;
	tracePrint('color = ' + color);
}
function set_transmissionDuration(value, timeStamp)
{
	if (value >= 0) 
	{
		transmissionDuration = value;
		animationDuration = defaultRange / transmissionPropagationSpeed + transmissionDuration;
		restartClockDuration = 2 * animationDuration;
		tracePrint('transmissionDuration = ' + transmissionDuration);
		tracePrint('animationDuration    = ' + animationDuration);
		tracePrint('restartClockDuration = ' + restartClockDuration);
	}
	else tracePrint('set_transmissionDuration (' + value + '); // no response, negative');
}
function set_fraction(value, timeStamp)
{
	updateCrossSection(value);

	updateExtrusionShape(crossSection, spine, color);
}
function updateExtrusionShape(crossSection, spine, color)
{
	// emissiveColor appears unaffected by transparency, unfortunately
	signalProfileMaterial.diffuseColor = color;
	signalProfileMaterial.transparency = transparency;

	tracePrint('Updating crossSection:');
	tracePrint('  crossSection = ' + crossSection);
	tracePrint('  spine = ' + spine);
	tracePrint('  transparency = ' + transparency);

	crossSection_changed = crossSection;
	spine_changed = spine;
}
function tracePrint(value)
{
  if (traceEnabled) alwaysPrint (value);
}
function alwaysPrint(value)
{
	Browser.println ('[AcousticTransmissionCylinderPrototype] ' + value);
}
""")
            .addField(new field().setName("startTransmission").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
            .addField(new field().setName("startContinuousTransmissions").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
            .addField(new field().setName("set_range").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
            .addField(new field().setName("defaultRange").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
            .addField(new field().setName("transmissionPropagationSpeed").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
            .addField(new field().setName("set_transmissionDuration").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Duration in seconds"))
            .addField(new field().setName("transmissionDuration").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Duration in seconds"))
            .addField(new field().setName("outerRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
            .addField(new field().setName("innerRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
            .addField(new field().setName("height").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
            .addField(new field().setName("set_fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
            .addField(new field().setName("animationDuration").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("restartClockDuration").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("loopAnimation").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("position").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
              .addComments(" no initialization value, use default "))
            .addField(new field().setName("set_beamCount").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Number of segmented sections in 360-degree cylindrical beam"))
            .addField(new field().setName("beamCount").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("number of segmented sections in 360-degree cylindrical beam"))
            .addField(new field().setName("newSpine").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("holding variable for intermediate computations"))
            .addField(new field().setName("spine").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFVec3f(new MFVec3f(new double[] {1.00,0.00,0.00,0.92,0.00,-0.38,0.71,0.00,-0.71,0.38,0.00,-0.92,0.00,0.00,-1.00,-0.38,0.00,-0.92,-0.71,0.00,-0.71,-0.92,0.00,-0.38,-1.00,0.00,-0.00,-0.92,0.00,0.38,-0.71,0.00,0.71,-0.38,0.00,0.92,0.00,0.00,1.00,0.38,0.00,0.92,0.71,0.00,0.71,0.92,0.00,0.38,1.00,0.00,0.00}))).setAppinfo("horizontal circular spine along central perimeter of rectangular transmission boundaries for each beam"))
            .addField(new field().setName("crossSection").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("vertical rectangular outline from inner radius to outer radius")
              .addComments(" no initialization value, use default "))
            .addField(new field().setName("set_color").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTONLY))
            .addField(new field().setName("color").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
            .addField(new field().setName("transparency").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
            .addField(new field().setName("animationStartTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("loopStartTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("crossSection_changed").setType(field.TYPE_MFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("spine_changed").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("transparency_changed").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
            .addField(new field().setName("signalProfileMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
              .addChild(new Material().setUSE("TransmissionProfileMaterial")))
            .addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
            .setIS(new IS()
              .addConnect(new connect().setNodeField("startTransmission").setProtoField("startTransmission"))
              .addConnect(new connect().setNodeField("startContinuousTransmissions").setProtoField("startContinuousTransmissions"))
              .addConnect(new connect().setNodeField("set_range").setProtoField("set_range"))
              .addConnect(new connect().setNodeField("defaultRange").setProtoField("defaultRange"))
              .addConnect(new connect().setNodeField("transmissionPropagationSpeed").setProtoField("transmissionPropagationSpeed"))
              .addConnect(new connect().setNodeField("set_transmissionDuration").setProtoField("set_transmissionDuration"))
              .addConnect(new connect().setNodeField("transmissionDuration").setProtoField("transmissionDuration"))
              .addConnect(new connect().setNodeField("set_beamCount").setProtoField("set_beamCount"))
              .addConnect(new connect().setNodeField("beamCount").setProtoField("beamCount"))
              .addConnect(new connect().setNodeField("height").setProtoField("height"))
              .addConnect(new connect().setNodeField("set_color").setProtoField("set_color"))
              .addConnect(new connect().setNodeField("color").setProtoField("color"))
              .addConnect(new connect().setNodeField("traceEnabled").setProtoField("traceEnabled"))))
          .addChild(new ROUTE().setFromNode("AnimationClock").setFromField("fraction_changed").setToNode("TransmissionPropagationScript").setToField("set_fraction"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("crossSection_changed").setToNode("TransmissionProfile").setToField("set_crossSection"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("spine_changed").setToNode("TransmissionProfile").setToField("set_spine"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("transparency_changed").setToNode("TransmissionProfileMaterial").setToField("transparency"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("animationDuration").setToNode("AnimationClock").setToField("set_cycleInterval"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("restartClockDuration").setToNode("RestartClock").setToField("set_cycleInterval"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("loopAnimation").setToNode("RestartClock").setToField("loop"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("animationStartTime").setToNode("AnimationClock").setToField("set_startTime"))
          .addChild(new ROUTE().setFromNode("TransmissionPropagationScript").setFromField("loopStartTime").setToNode("RestartClock").setToField("set_startTime")))))
    .addComments(" Viewable geometry for this scene is anchored text that links to an example showing ExternProtoDeclare usage of AcousticTransmissionCylinder ")
    .addChild(new WorldInfo().setInfo(new String[] {"Produce acoustic transmission cylinders"}).setTitle("AcousticTransmissionCylinderPrototype"))
    .addChild(new Viewpoint().setDescription("Acoustic Transmission Cylinder").setPosition(0.0,0.0,15.0))
    .addChild(new Anchor().setDescription("Acoustic Transmission Cylinder Example").setUrl(new String[] {"AcousticTransmissionCylinderExample.x3d","../../CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderExample.x3d","AcousticTransmissionCylinderExample.wrl","../../CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/SeaWeb/AcousticTransmissionCylinderExample.wrl"})
      .addChild(new Shape()
        .setAppearance(new Appearance()
          .setMaterial(new Material().setDiffuseColor(0.0,1.0,1.0).setEmissiveColor(0.0,1.0,1.0)))
        .setGeometry(new Text().setString(new String[] {"AcousticTransmissionCylinderPrototype","is a Prototype definition file","","To see an example scene","click this text and view","AcousticTransmissionCylinderExample"})
          .setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE))))));
            }
            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 AcousticTransmissionCylinderPrototype 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 AcousticTransmissionCylinderPrototype().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.CommunicationsAndSensors.SeaWeb.AcousticTransmissionCylinderPrototype\" 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.CommunicationsAndSensors.SeaWeb.AcousticTransmissionCylinderPrototype self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

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