package Savage.Tools.HeadsUpDisplays;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalSensor.*;
import org.web3d.x3d.jsail.fields.*;
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.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Prototype for a heads-up display (HUD) crosshair showing center of screen, useful for assessing lookAt point.
Related links: Catalog page CrossHairPrototype, source CrossHairPrototype.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 Don Brutzman
*/
public class CrossHairPrototype
{
/** Default constructor to create this object. */
public CrossHairPrototype ()
{
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("CrossHairPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Prototype for a heads-up display (HUD) crosshair showing center of screen, useful for assessing lookAt point."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("1 February 2003"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("crosshair display"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CrossHairPrototype.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 WorldInfo().setTitle("CrossHairPrototype.x3d"))
.addChild(new ProtoDeclare("CrossHair").setName("CrossHair").setAppinfo("CrossHair prototype provides a heads-up display (HUD) crosshair at the view center, which is useful for assessing NavigationInfo lookAt point")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true).setAppinfo("whether CrossHair prototype is enabled or not"))
.addField(new field().setName("set_enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("control whether enabled/disabled"))
.addField(new field().setName("markerColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.3,0.3,0.8)).setAppinfo("color of CrossHair marker"))
.addField(new field().setName("scale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(1.0,1.0,1.0)).setAppinfo("size of CrossHair in meters"))
.addField(new field().setName("positionOffsetFromCamera").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(0.0,0.0,-3.0)).setAppinfo("distance in front of HUD viewpoint")))
.setProtoBody(new ProtoBody()
.addChild(new Switch("ShowSwitch").setWhichChoice(-1)
.addChild(new Group()
.addChild(new ProximitySensor("WhereSensor").setSize(1000000000.0,1000000000.0,1000000000.0)
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))))
.addChild(new Transform("CameraLocation")
.addChild(new Transform("CameraOffset")
.setIS(new IS()
.addConnect(new connect().setNodeField("translation").setProtoField("positionOffsetFromCamera"))
.addConnect(new connect().setNodeField("scale").setProtoField("scale")))
.addChild(new Shape()
.setGeometry(new IndexedLineSet().setCoordIndex(new int[] {0,1,-1,2,3,-1})
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {0.0,1.0,0.0,0.0,-1.0,0.0,1.0,0.0,0.0,-1.0,0.0,0.0}))))
.setAppearance(new Appearance()
.setMaterial(new Material("CircleMaterial").setDiffuseColor(0.0,0.0,0.0)
.setIS(new IS()
.addConnect(new connect().setNodeField("emissiveColor").setProtoField("markerColor")))))))
.addChild(new Group()
.addChild(new Script("EnabledScript").setSourceCode("""
ecmascript:
function initialize ()
{
if (enabled) whichChoice = 0;
else whichChoice = -1;
// Browser.println ('enabled=' + enabled + ', whichChoice=' + whichChoice);
}
function set_enabled (value, timestamp)
{
if (value) whichChoice = 0;
else whichChoice = -1;
// Browser.println ('set_enabled=' + value + ', whichChoice=' + whichChoice);
}
""")
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("whichChoice").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))
.addConnect(new connect().setNodeField("set_enabled").setProtoField("set_enabled"))))
.addChild(new ROUTE().setFromNode("WhereSensor").setFromField("isActive").setToNode("EnabledScript").setToField("set_enabled"))
.addChild(new ROUTE().setFromNode("EnabledScript").setFromField("whichChoice").setToNode("ShowSwitch").setToField("whichChoice"))))))
.addChild(new ROUTE().setFromNode("WhereSensor").setFromField("position_changed").setToNode("CameraLocation").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("WhereSensor").setFromField("orientation_changed").setToNode("CameraLocation").setToField("set_rotation"))))
.addComments(" ======================== ")
.addChild(new NavigationInfo().setSpeed(10).setType(new String[] {"FLY","ANY"}))
.addChild(new ProtoInstance("CrossHair").setContainerField("children")
.addFieldValue(new fieldValue().setName("enabled").setValue(true))
.addFieldValue(new fieldValue().setName("markerColor").setValue(new SFColor(1.0,0.5,0.0)))
.addFieldValue(new fieldValue().setName("scale").setValue(new SFVec3f(1.0,1.0,1.0)))
.addFieldValue(new fieldValue().setName("positionOffsetFromCamera").setValue(new SFVec3f(0.0,0.0,-3.0))))
.addChild(new Group("TextMenu")
.addChild(new Transform()
.addChild(new Anchor().setDescription("CrossHair Example").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"CrossHairExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CrossHairExample.x3d","CrossHairExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CrossHairExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"CrossHairPrototype is a","prototype definition file.","Click text to see","CrossHairExample"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.8)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.8,0.8,0.4))))))));
}
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 CrossHairPrototype 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 CrossHairPrototype().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.CrossHairPrototype\" 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.CrossHairPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/HeadsUpDisplays/CrossHairPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/HeadsUpDisplays/CrossHairPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/HeadsUpDisplays/CrossHairPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/HeadsUpDisplays/CrossHairPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}