package Savage.HarborEquipment.NavigationAids;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Navigation Aids Example, using two of each Prototype: Range Light, Lighted Buoy, Light.
Related links: Catalog page NavigationAidsExample, source NavigationAidsExample.java, X3D Resources, X3D Scene Authoring Hints, and X3D Tooltips.
This program uses the
X3D Java Scene Access Interface Library (X3DJSAIL).
It has been produced using the
X3dToJava.xslt
stylesheet
(version control)
which is used to create Java source code from an original .x3d model.
* @author Planet 9 Studios, Inc., San Francisco, CA
*/
public class NavigationAidsExample
{
/** Default constructor to create this object. */
public NavigationAidsExample ()
{
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("NavigationAidsExample.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Navigation Aids Example, using two of each Prototype: Range Light, Lighted Buoy, Light."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Planet 9 Studios, Inc., San Francisco, CA"))
.addMeta(new meta().setName("producer").setContent("Christian Greuel, Director of Art and Production"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.planet9.com"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("IHO S-57: http://www.caris.com/s-57"))
.addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Xj3D Format Converter"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("17 August 2006"))
.addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("18 August 2006"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../../license.html"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/HarborEquipment/NavigationAids/NavigationAidsExample.x3d")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("NavigationAidsExample.x3d"))
.addChild(new ExternProtoDeclare("RangeLight").setName("RangeLight").setUrl(new String[] {"RangeLightPrototype.x3d#RangeLight","https://www.web3d.org/x3d/content/examples/Savage/HarborEquipment/NavigationAids/RangeLightPrototype.x3d#RangeLight","RangeLightPrototype.wrl#RangeLight","https://www.web3d.org/x3d/content/examples/Savage/HarborEquipment/NavigationAids/RangeLightPrototype.wrl#RangeLight"})
.addComments(" NOTE: Beacon light points due North (+Z) and is only visible from that side. ")
.addField(new field().setName("LightType").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" 0=LightOff, 1=LightOn, 2=LightFlashing(NotImplemented) ")
.addField(new field().setName("LightGlow").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" XYZ Scale of Light Glow Effect (suggest Z=1.0) "))
.addChild(new ExternProtoDeclare("LightedBuoy").setName("LightedBuoy").setUrl(new String[] {"LightedBuoyPrototype.x3d#LightedBuoy","https://www.web3d.org/x3d/content/examples/Savage/HarborEquipment/NavigationAids/LightedBuoyPrototype.x3d#LightedBuoy","LightedBuoyPrototype.wrl#LightedBuoy","https://www.web3d.org/x3d/content/examples/Savage/HarborEquipment/NavigationAids/LightedBuoyPrototype.wrl#LightedBuoy"})
.addComments(" NOTE: CATLAM = Catagory of Lateral Marker (Reference: IHO S-57) ")
.addField(new field().setName("Catlam").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" 0=None(Unlikely), 1=Green(Port), 2=Red(Starboard) ")
.addField(new field().setName("LightType").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" 0=LightOff, 1=LightOn, 2=LightFlashing(NotImplemented) ")
.addField(new field().setName("LightGlow").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" XYZ Scale of Light Glow Effect (suggest Z=1.0) ")
.addField(new field().setName("Number").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" Not Implemented "))
.addChild(new ExternProtoDeclare("Light").setName("Light").setUrl(new String[] {"LightPrototype.x3d#Light","https://www.web3d.org/x3d/content/examples/Savage/HarborEquipment/NavigationAids/LightPrototype.x3d#Light","LightPrototype.wrl#Light","https://www.web3d.org/x3d/content/examples/Savage/HarborEquipment/NavigationAids/LightPrototype.wrl#Light"})
.addComments(" NOTE: CATLAM = Catagory of Lateral Marker (Reference: IHO S-57) ")
.addField(new field().setName("Catlam").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" 0=None(Unlikely), 1=Green(Port), 2=Red(Starboard) ")
.addField(new field().setName("LightType").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" 0=LightOff, 1=LightOn, 2=LightFlashing(NotImplemented) ")
.addField(new field().setName("LightGlow").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" XYZ Scale of Light Glow Effect (suggest Z=1.0) ")
.addField(new field().setName("PileType").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" 0=NoPile(Unlikely), 1=SinglePile, 2=MultiPile ")
.addField(new field().setName("Number").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" Not Implemented "))
.addChild(new NavigationInfo().setAvatarSize(new double[] {5.0,1.6,0.75}))
.addChild(new Viewpoint().setDescription("On Range Line").setFieldOfView(0.6024).setOrientation(1.0,0.0,0.0,0.0).setPosition(0.0,5.0,50.0))
.addChild(new Viewpoint().setDescription("Left of Range Line").setFieldOfView(0.6024).setOrientation(1.0,0.0,0.0,0.0).setPosition(-7.0,5.0,50.0))
.addChild(new Viewpoint().setDescription("Right of Range Line").setFieldOfView(0.6024).setOrientation(1.0,0.0,0.0,0.0).setPosition(7.0,5.0,50.0))
.addChild(new Viewpoint().setDescription("Bird's Eye").setFieldOfView(0.6024).setOrientation(0.668,0.7377,0.09804,-0.3928).setPosition(-30.0,30.0,100.0))
.addChild(new Transform("RangeLightFront").setRotation(0.0,-1.0,0.0,-3.14159).setTranslation(0.0,0.0,-25.0)
.addComments(" Rotate to face South ")
.addChild(new ProtoInstance("RangeLight").setContainerField("children")
.addFieldValue(new fieldValue().setName("LightType").setValue(1))
.addComments(" LightOn ")
.addFieldValue(new fieldValue().setName("LightGlow").setValue(new SFVec3f(4.0,4.0,1.0)))
.addComments(" Glow effect scaled four times wide (XY only) ")))
.addChild(new Transform("RangeLightRear").setRotation(0.0,-1.0,0.0,-3.14159).setTranslation(0.0,5.0,-50.0)
.addComments(" Rotate to face South ")
.addChild(new ProtoInstance("RangeLight").setContainerField("children")
.addFieldValue(new fieldValue().setName("LightType").setValue(1))
.addComments(" LightOn ")
.addFieldValue(new fieldValue().setName("LightGlow").setValue(new SFVec3f(4.0,4.0,1.0)))
.addComments(" Glow effect scaled four times wide (XY only) ")))
.addChild(new Transform("LightedBuoyPort").setTranslation(-10.0,0.0,0.0)
.addChild(new ProtoInstance("LightedBuoy").setContainerField("children")
.addFieldValue(new fieldValue().setName("Catlam").setValue(1))
.addComments(" Green (Port) ")
.addFieldValue(new fieldValue().setName("LightType").setValue(1))
.addComments(" LightOn ")
.addFieldValue(new fieldValue().setName("LightGlow").setValue(new SFVec3f(1.0,1.0,1.0)))
.addComments(" Glow effect scaled four times wide (XY only) ")
.addFieldValue(new fieldValue().setName("Number").setValue(0))))
.addChild(new Transform("LightedBuoyStarboard").setTranslation(10.0,0.0,0.0)
.addChild(new ProtoInstance("LightedBuoy").setContainerField("children")
.addFieldValue(new fieldValue().setName("Catlam").setValue(2))
.addComments(" Red (Starboard) ")
.addFieldValue(new fieldValue().setName("LightType").setValue(1))
.addComments(" LightOn ")
.addFieldValue(new fieldValue().setName("LightGlow").setValue(new SFVec3f(1.0,1.0,1.0)))
.addComments(" Glow effect scaled four times wide (XY only) ")
.addFieldValue(new fieldValue().setName("Number").setValue(0))))
.addChild(new Transform("LightPort").setTranslation(-10.0,0.0,25.0)
.addChild(new ProtoInstance("Light").setContainerField("children")
.addFieldValue(new fieldValue().setName("Catlam").setValue(1))
.addComments(" Green (Port) ")
.addFieldValue(new fieldValue().setName("LightType").setValue(1))
.addComments(" LightOn ")
.addFieldValue(new fieldValue().setName("LightGlow").setValue(new SFVec3f(2.0,2.0,2.0)))
.addComments(" Glow effect scaled four times wide (XY only) ")
.addFieldValue(new fieldValue().setName("PileType").setValue(1))
.addComments(" Single Pile ")
.addFieldValue(new fieldValue().setName("Number").setValue(0))))
.addChild(new Transform("LightStarboard").setTranslation(10.0,0.0,25.0)
.addChild(new ProtoInstance("Light").setContainerField("children")
.addFieldValue(new fieldValue().setName("Catlam").setValue(2))
.addComments(" Red (Starboard) ")
.addFieldValue(new fieldValue().setName("LightType").setValue(1))
.addComments(" LightOn ")
.addFieldValue(new fieldValue().setName("LightGlow").setValue(new SFVec3f(2.0,2.0,2.0)))
.addComments(" Glow effect scaled four times wide (XY only) ")
.addFieldValue(new fieldValue().setName("PileType").setValue(2))
.addComments(" Multi Pile ")
.addFieldValue(new fieldValue().setName("Number").setValue(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
* shallow copy
* of the X3D model.
* @see X3D
* @return NavigationAidsExample 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 X3D.handleArguments(args)
* @see X3D.validationReport()
* @see CommandLine
* @see CommandLine.USAGE
* @see ConfigurationProperties
*/
public static void main(String args[])
{
System.out.println("Build this X3D model, showing validation diagnostics...");
X3D thisExampleX3dModel = new NavigationAidsExample().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.HarborEquipment.NavigationAids.NavigationAidsExample\" 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.HarborEquipment.NavigationAids.NavigationAidsExample self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// HarborEquipment/NavigationAids/NavigationAidsExample_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "HarborEquipment/NavigationAids/NavigationAidsExample_JavaExport.x3d";
String filenameX3DV = "HarborEquipment/NavigationAids/NavigationAidsExample_JavaExport.x3dv";
String filenameJSON = "HarborEquipment/NavigationAids/NavigationAidsExample_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}