package Savage.Tools.HeadsUpDisplays;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.EnvironmentalSensor.*;
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.Networking.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* A circular set of 36 compass bearings that follows the active viewpoint. Coordinate axis viewpoint shows that North = +X axis, East = +Z axis, up = +Y axis.
Related links: Catalog page CameraCompass36Example, source CameraCompass36Example.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 CameraCompass36Example
{
/** Default constructor to create this object. */
public CameraCompass36Example ()
{
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("CameraCompass36Example.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("A circular set of 36 compass bearings that follows the active viewpoint. Coordinate axis viewpoint shows that North = +X axis, East = +Z axis, up = +Y axis."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("17 June 2001"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CameraCompass36Example.x3d"))
.addMeta(new meta().setName("inspiration").setContent("David Colleen"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.planet9.com/earth/pearlharbor/vrml/tour.wrl"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.planet9.com/earth/pearlharbor/vrml/compass.wrl"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("compass display"))
.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("CameraCompass36Example.x3d"))
.addChild(new ExternProtoDeclare("CameraCompass36").setName("CameraCompass36").setAppinfo("Circular set of compass bearings that follow the active viewpoint set at 360/36 = 10 degree intervals. North = +X axis East = +Z axis up = +Y axis.").setUrl(new String[] {"CameraCompassPrototypes.x3d#CameraCompass36","../../../Savage/Tools/HeadsUpDisplays/CameraCompassPrototypes.x3d#CameraCompass36","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CameraCompassPrototypes.x3d#CameraCompass36","CameraCompassPrototypes.wrl#CameraCompass36","../../../Savage/Tools/HeadsUpDisplays/CameraCompassPrototypes.wrl#CameraCompass36","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/CameraCompassPrototypes.wrl#CameraCompass36"})
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("positionOffsetFromCamera").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("markerColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("labelColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)))
.addChild(new ExternProtoDeclare("ViewPositionOrientation").setName("ViewPositionOrientation").setAppinfo("ViewPositionOrientation prototype provides local position and orientation as user navigates with optional console output").setUrl(new String[] {"../../../Savage/Tools/Authoring/ViewPositionOrientationPrototype.x3d#ViewPositionOrientation","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/ViewPositionOrientationPrototype.x3d#ViewPositionOrientation","../../../Savage/Tools/Authoring/ViewPositionOrientationPrototype.wrl#ViewPositionOrientation","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/ViewPositionOrientationPrototype.wrl#ViewPositionOrientation"})
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Whether or not ViewPositionOrientation sends output to console."))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Output internal trace messages for debugging this node - developer use only can be ignored."))
.addField(new field().setName("set_traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Ability to turn output tracing on/off at runtime."))
.addField(new field().setName("position_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Output local position."))
.addField(new field().setName("orientation_changed").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Output local orientation."))
.addField(new field().setName("outputViewpointString").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("MFString value of new Viewpoint for example: ")))
.addComments(" ======================== ")
.addChild(new Viewpoint().setDescription("walk and rotate to test heads-up display (HUD)").setPosition(0.0,0.0,25.0))
.addChild(new Viewpoint().setDescription("walk and rotate to test heads-up display (HUD)").setOrientation(0.0,1.0,0.0,-1.57).setPosition(-14.0,0.0,0.0))
.addChild(new NavigationInfo().setSpeed(10).setType(new String[] {"FLY","ANY"}))
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.7,0.7,0.9})))
.addChild(new PointLight().setLocation(0.0,20.0,0.0))
.addComments(" Test the compass prototype of interest. ")
.addChild(new ProtoInstance("CameraCompass36").setContainerField("children")
.addFieldValue(new fieldValue().setName("enabled").setValue(true))
.addFieldValue(new fieldValue().setName("positionOffsetFromCamera").setValue(new SFVec3f(0.0,5.0,0.0)))
.addFieldValue(new fieldValue().setName("markerColor").setValue(new SFColor(0.9,0.9,0.9)))
.addFieldValue(new fieldValue().setName("labelColor").setValue(new SFColor(0.9,0.9,0.9))))
.addComments(" Put a coordinate axis in to display orientation ")
.addChild(new Transform().setTranslation(0.0,-2.5,0.0)
.addChild(new Inline("CoordinateAxes").setUrl(new String[] {"../../../Savage/Tools/Authoring/CoordinateAxes.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/CoordinateAxes.x3d","../../../Savage/Tools/Authoring/CoordinateAxes.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/CoordinateAxes.wrl"}))
.addChild(new Viewpoint().setDescription("Coordinate axes: x=North, y=Up, z=East").setOrientation(0.0,1.0,0.0,-1.4).setPosition(-3.6,0.2,0.6))
.addChild(new ProximitySensor("AxisProximity").setSize(10.0,10.0,10.0))
.addChild(new NavigationInfo("AxisNavigation")))
.addChild(new Transform())
.addComments(" Open the VRML console to see ViewPositionOrientation output. This demonstrates that more than one ProximitySensor can be active in the scene at a single time. ")
.addChild(new ProtoInstance("ViewPositionOrientation", "ConsoleOutputViewPositionOrientation").setContainerField("children")
.addFieldValue(new fieldValue().setName("enabled").setValue(true)))
.addChild(new Transform("Floor").setTranslation(0.0,-5.0,0.0)
.addChild(new Shape()
.setGeometry(new Box().setSize(5.0,0.4,5.0))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.3,0.7,0.3))))
.addChild(new Shape()
.setGeometry(new Box().setSize(20.0,0.3,20.0))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.7,0.7,0.3))))
.addChild(new Shape()
.setGeometry(new Box().setSize(50.0,0.2,50.0))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.8,0.8,1.0))))
.addChild(new Shape()
.setGeometry(new Box().setSize(100.0,0.1,100.0))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.3,1.0,0.3)))))
.addChild(new Transform("CenterInstructions").setTranslation(0.0,0.75,0.0)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"Walk and rotate to move scene while","compass heads-up display (HUD)","CameraCompass36 stays overhead"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,0.0,0.0).setEmissiveColor(0.2,0.7,0.2))))))
.addChild(new ROUTE().setFromNode("AxisProximity").setFromField("isActive").setToNode("AxisNavigation").setToField("set_bind")));
}
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 CameraCompass36Example 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 CameraCompass36Example().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.CameraCompass36Example\" 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.CameraCompass36Example self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/HeadsUpDisplays/CameraCompass36Example_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/HeadsUpDisplays/CameraCompass36Example_JavaExport.x3d";
String filenameX3DV = "Tools/HeadsUpDisplays/CameraCompass36Example_JavaExport.x3dv";
String filenameJSON = "Tools/HeadsUpDisplays/CameraCompass36Example_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}