package Savage.Tools.HeadsUpDisplays;
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.Lighting.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Rendering.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Texturing.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Prototype for a "heads-up" control panel. This node defines an object that maintains its orientation to the current viewpoint. Also present is a border that allows the panel to be dragged anywhere on the screen. All of the touchSensor events relating to texture maps are available as output events from this node.
Related links: Catalog page HudControlPanelPrototype, source HudControlPanelPrototype.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 Leonard Daly
*/
public class HudControlPanelPrototype
{
/** Default constructor to create this object. */
public HudControlPanelPrototype ()
{
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("HudControlPanelPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Prototype for a \"heads-up\" control panel. This node defines an object that maintains its orientation to the current viewpoint. Also present is a border that allows the panel to be dragged anywhere on the screen. All of the touchSensor events relating to texture maps are available as output events from this node."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Leonard Daly"))
.addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Dan Kucik"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("1999"))
.addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("8 June 2003"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_ERROR ).setContent("HUD does not sit still when navigating"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.realism.com/Web3D/Examples/examples.cgi?ID=5"))
.addMeta(new meta().setName(meta.NAME_RIGHTS ).setContent("This code may be reused in part or total. Please include this paragraph when it is used. Copyright 1999, Leonard Daly #****************"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("Heads-up display example"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("Original VRML File: http://www.realism.com/vrml/Example/HUD/HUD_proto.wrl"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/HudControlPanelPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("Vrml97ToX3dNist, http://ovrt.nist.gov/v2_x3d.html"))
.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("HudControlPanelPrototype.x3d"))
.addChild(new ProtoDeclare("HudControlPanel").setName("HudControlPanel").setAppinfo("Heads Up Display (HUD) Control Panel")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,-10.0)).setAppinfo("SFVec3f Position of the panel relative to the viewpoint. The X and Y components can be changed by dragging the window around."))
.addField(new field().setName("orientation").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFRotation(0.0,1.0,0.0,0.0)).setAppinfo("SFRotation This field should be the object of a ROUTE statement from the orientation_changed event from a ProximitySensor. For some reason the ProximitySensor does not correctly report the current viewpoint when the sensor is located inside of the PROTO."))
.addField(new field().setName("isOver").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Out - SFBool event is generated when the cursor is over the texture mapped region of the control panel. Set to false when the cursor leaves the texture mapped region."))
.addField(new field().setName("hitTexCoord_changed").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Out - SFVec2f The X/Y normalized coordinates (S and T) of the cursor location when isOver is true."))
.addField(new field().setName("borderColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.6,0.6,0.6)).setAppinfo("SFColor The color of the panel border. This is the region that can be used to drag the panel around the screen."))
.addField(new field().setName("scale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(2.5,1.5,0.05)).setAppinfo("SFVec3f Size of the panel. The texture mapped area (see textureMap) is 95% in X and 90% in Y of this size."))
.addField(new field().setName("position").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(0.0,0.0,0.0)).setAppinfo("SFVec3f This field should be the object of a ROUTE statement from the position_changed event from a ProximitySensor. See orientation for more details."))
.addField(new field().setName("textureMap").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("MFString The texture map URLs. This is specified in the same manner as the URL field in ImageTexture. The first one that can be loaded is the that is displayed. If this field is not specified then this region of the object is painted white."))
.addField(new field().setName("touchTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Out - SFTime The time when a mouse button is released provided that the just prior to release isOver and isActive are true."))
.addField(new field().setName("isActive").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Out - SFBool A true event is generated when the mouse button is depressed and the cursor is over the texture mapped region. A false event is generated when the button is released or when isOver becomes false.")))
.setProtoBody(new ProtoBody()
.addChild(new Transform("Main")
.setIS(new IS()
.addConnect(new connect().setNodeField("translation").setProtoField("position"))
.addConnect(new connect().setNodeField("rotation").setProtoField("orientation")))
.addChild(new Transform("CtlPnlOffset")
.setIS(new IS()
.addConnect(new connect().setNodeField("translation").setProtoField("translation"))
.addConnect(new connect().setNodeField("scale").setProtoField("scale")))
.addChild(new DirectionalLight())
.addChild(new PlaneSensor("MovePanel").setDescription("Select item"))
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material("_IS_0")
.setIS(new IS()
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("borderColor")))))
.setGeometry(new IndexedFaceSet("Panel").setDEF("Panel").setCoordIndex(new int[] {0,1,2,3,-1})
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {1.0,1.0,0.0,-1.0,1.0,0.0,-1.0,-1.0,0.0,1.0,-1.0,0.0})))))
.addChild(new Transform().setScale(0.95,0.9,1.0).setTranslation(0.0,0.0,0.01)
.addChild(new TouchSensor().setDescription("Select item")
.setIS(new IS()
.addConnect(new connect().setNodeField("isOver").setProtoField("isOver"))
.addConnect(new connect().setNodeField("isActive").setProtoField("isActive"))
.addConnect(new connect().setNodeField("hitTexCoord_changed").setProtoField("hitTexCoord_changed"))
.addConnect(new connect().setNodeField("touchTime").setProtoField("touchTime"))))
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,1.0))
.setTexture(new ImageTexture("_IS_1")
.setIS(new IS()
.addConnect(new connect().setNodeField("url").setProtoField("textureMap")))))
.setGeometry(new IndexedFaceSet().setUSE("Panel"))))))
.addChild(new Script("MoveScript").setSourceCode("""
ecmascript:
function move (value)
{
position = new SFVec3f (Iscale[0] * value[0] + Ioffset[0],
Iscale[1] * value[1] + Ioffset[1],
Ioffset[2]);
}
""")
.addField(new field().setName("position").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("move").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("Iscale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("Ioffset").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("Iscale").setProtoField("scale"))
.addConnect(new connect().setNodeField("Ioffset").setProtoField("translation"))))
.addChild(new ROUTE().setFromNode("MovePanel").setFromField("translation_changed").setToNode("MoveScript").setToField("move"))
.addChild(new ROUTE().setFromNode("MoveScript").setFromField("position").setToNode("CtlPnlOffset").setToField("translation"))))
.addComments(" ==================== ")
.addChild(new Anchor().setDescription("HudControlPanel Example").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"HudControlPanelExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/HudControlPanelExample.x3d","HudControlPanelExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/HudControlPanelExample.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[] {"HudControlPanelPrototype","is a Prototype definition file.","","To see an example scene","using this new node","click this text and view","HudControlPanelExample"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.8))))));
}
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 HudControlPanelPrototype 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 HudControlPanelPrototype().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.HudControlPanelPrototype\" 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.HudControlPanelPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/HeadsUpDisplays/HudControlPanelPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/HeadsUpDisplays/HudControlPanelPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/HeadsUpDisplays/HudControlPanelPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/HeadsUpDisplays/HudControlPanelPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}