package Savage.Tools.Authoring;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalSensor.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
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.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* ViewPositionOrientation prototype provides local position and orientation as user navigates, with optional console output.
Related links: Catalog page ViewPositionOrientationPrototype, source ViewPositionOrientationPrototype.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 and Don Brutzman
*/
public class ViewPositionOrientationPrototype
{
/** Default constructor to create this object. */
public ViewPositionOrientationPrototype ()
{
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("ViewPositionOrientationPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Leonard Daly and Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("1 November 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("ViewPositionOrientation prototype provides local position and orientation as user navigates, with optional console output"))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("Note fix: metadata is no longer an allowed ProtoDeclare field name, since ProtoInstance already includes a metadata field"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ViewPositionOrientationExample.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/WhereAmIExample.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/WhereAmIPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.realism.com/Web3D/Examples#WhereAmI"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.realism.com/vrml/Example/WhereAmI/WhereAmI_Proto.wrl"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/ViewPositionOrientationPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.3, https://www.web3d.org/x3d/tools/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../../license.html")))
.setScene(new Scene()
.addComments(" Thanks to Leonard Daly for the original design of this prototype ")
.addChild(new WorldInfo().setTitle("ViewPositionOrientationPrototype.x3d"))
.addChild(new ProtoDeclare("ViewPositionOrientation").setName("ViewPositionOrientation").setAppinfo("ViewPositionOrientation provides provides console output of local position and orientation as user navigates")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true).setAppinfo("Whether or not ViewPositionOrientation sends output to console"))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true).setAppinfo("Output internal trace messages for debugging this node, intended for developer use only"))
.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, suitable for use in string field of a Text node")))
.setProtoBody(new ProtoBody()
.addChild(new ProximitySensor("WhereSensor").setSize(1000000000.0,1000000000.0,1000000000.0)
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))))
.addComments(" it's a big old world out there! large box likely handles most use cases. ")
.addChild(new Script("OutputPositionOrientation").setSourceCode("""
ecmascript:
function roundoff (value, digits) // for local use only
{
var resolution = 1;
for (i = 1; i <= digits; i++ )
{
resolution *= 10;
}
return Math.round (value*resolution) / resolution; // round to resolution
}
function outputViewpoint ()
{
var holdString =
'' ;
tracePrint (holdString);
outputViewpointString = new MFString (holdString);
}
function set_position (value)
{
position = value; // save persistent value
position_changed = position; // output event
outputViewpoint ();
}
function set_orientation (value)
{
orientation = value; // save persistent value
orientation_changed = orientation; // output event
outputViewpoint ();
}
function set_traceEnabled (value)
{
traceEnabled = value;
alwaysPrint ('traceEnabled=' + traceEnabled);
}
function alwaysPrint (text)
{
Browser.println ('[ViewPositionOrientation] ' + text);
}
function tracePrint (text)
{
if (traceEnabled) alwaysPrint (text);
}
""")
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("set_position").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("set_orientation").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("position").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("orientation").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFRotation(0.0,1.0,0.0,0.0)))
.addField(new field().setName("position_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("orientation_changed").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("outputViewpointString").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("traceEnabled").setProtoField("traceEnabled"))
.addConnect(new connect().setNodeField("set_traceEnabled").setProtoField("set_traceEnabled"))
.addConnect(new connect().setNodeField("position_changed").setProtoField("position_changed"))
.addConnect(new connect().setNodeField("orientation_changed").setProtoField("orientation_changed"))
.addConnect(new connect().setNodeField("outputViewpointString").setProtoField("outputViewpointString"))))
.addChild(new ROUTE().setFromNode("WhereSensor").setFromField("position_changed").setToNode("OutputPositionOrientation").setToField("set_position"))
.addChild(new ROUTE().setFromNode("WhereSensor").setFromField("orientation_changed").setToNode("OutputPositionOrientation").setToField("set_orientation"))))
.addComments(" ==================== ")
.addChild(new Viewpoint().setDescription("ViewPositionOrientation prototype").setPosition(0.0,0.0,14.0))
.addChild(new Anchor().setDescription("ViewPositionOrientation Example").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"ViewPositionOrientationExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/ViewPositionOrientationExample.x3d","ViewPositionOrientationExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/ViewPositionOrientationExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"ViewPositionOrientationPrototype","is a prototype definition file","","Click this text to see","ViewPositionOrientationExample"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(1.2)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.6,0.8,0.4))))
.addComments(" Selectable Text design pattern has transparent Box and TouchSensor description as a tooltip ")
.addChild(new Shape()
.addComments(" Author TODO: to adjust transparent Box as text-selection assist, set width and height to match size, then set transparency='1' to make invisible. ")
.setGeometry(new Box().setSize(16.0,7.0,.001))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1))))));
}
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 ViewPositionOrientationPrototype 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 ViewPositionOrientationPrototype().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.Authoring.ViewPositionOrientationPrototype\" 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.Authoring.ViewPositionOrientationPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Authoring/ViewPositionOrientationPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Authoring/ViewPositionOrientationPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/Authoring/ViewPositionOrientationPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/Authoring/ViewPositionOrientationPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}