package Savage.Tools.Authoring;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
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.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Line grid authoring tool for precise measurement in 3D space: drag plane to move along Z axis, click numbers to hide grid. Oriented along XY plane, size 20m by 20m, default block size 1m by 1m.
Related links: Catalog page GridXY_20x20Movable, source GridXY_20x20Movable.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 GridXY_20x20Movable
{
/** Default constructor to create this object. */
public GridXY_20x20Movable ()
{
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("GridXY_20x20Movable.x3d"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("22 November 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Line grid authoring tool for precise measurement in 3D space: drag plane to move along Z axis, click numbers to hide grid. Oriented along XY plane, size 20m by 20m, default block size 1m by 1m."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/GridsExample.x3d"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/GridXY_20x20Movable.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("GridXY_20x20Movable.x3d"))
.addChild(new Viewpoint().setDescription("XY grid (0 0 30 relative)").setPosition(0.0,0.0,30.0))
.addChild(new Viewpoint().setDescription("XY grid (35 0 20 relative)").setOrientation(0.0,1.0,0.0,1.06).setPosition(35.0,0.0,20.0))
.addChild(new Transform("GridLocation")
.addChild(new Group()
.addChild(new TouchSensor("TextLabelTouchSensor").setDescription("select and hold to hide grid"))
.addChild(new Transform().setTranslation(0.0,-0.5,0.0)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text("CenterText").setString(new String[] {"origin"})
.setFontStyle(new FontStyle("LABEL_FONT").setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(.4)))
.setAppearance(new Appearance("DefaultAppearance")
.setMaterial(new Material())))))
.addChild(new Transform().setTranslation(10.0,10.5,0.0)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text("UpperRightText").setString(new String[] {"10 10 0"})
.setFontStyle(new FontStyle().setUSE("LABEL_FONT")))
.setAppearance(new Appearance().setUSE("DefaultAppearance")))))
.addChild(new Transform().setTranslation(-10.0,10.5,0.0)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text("UpperLeftText").setString(new String[] {"-10 10 0"})
.setFontStyle(new FontStyle().setUSE("LABEL_FONT")))
.setAppearance(new Appearance().setUSE("DefaultAppearance")))))
.addChild(new Transform().setTranslation(-10.0,-10.5,0.0)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text("LowerLeftText").setString(new String[] {"-10 -10 0"})
.setFontStyle(new FontStyle().setUSE("LABEL_FONT")))
.setAppearance(new Appearance().setUSE("DefaultAppearance")))))
.addChild(new Transform().setTranslation(10.0,-10.5,0.0)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text("LowerRightText").setString(new String[] {"10 -10 0"})
.setFontStyle(new FontStyle().setUSE("LABEL_FONT")))
.setAppearance(new Appearance().setUSE("DefaultAppearance"))))))
.addChild(new Switch("GridOnOffSwitch").setWhichChoice(0)
.addChild(new Transform().setRotation(1.0,0.0,0.0,1.57079)
.addChild(new PlaneSensor("GridSensor").setDescription("click and drag to move grid"))
.addChild(new Script("LineSensorAxisZ").setSourceCode("""
ecmascript:
// local-coordinates vertical Y is world-coordinates axis Z
function set_translation (location, timeStamp) {
translation_changed [0] = 0;
translation_changed [1] = 0;
translation_changed [2] = location.y;
// Browser.println ('location=' + location + ', translation_changed=' + translation_changed);
}
""")
.addField(new field().setName("set_translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("translation_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Shape("LinesAlignedAlongZ")
.setGeometry(new IndexedLineSet().setColorPerVertex(false).setColorIndex(new int[] {1,0,0,0,0,2,0,0,0,0,1,0,0,0,0,2,0,0,0,0,1}).setCoordIndex(new int[] {1,22,-1,2,23,-1,3,24,-1,4,25,-1,5,26,-1,6,27,-1,7,28,-1,8,29,-1,9,30,-1,10,31,-1,11,32,-1,12,33,-1,13,34,-1,14,35,-1,15,36,-1,16,37,-1,17,38,-1,18,39,-1,19,40,-1,20,41,-1,21,42,-1})
.setCoord(new Coordinate("EndPoints").setPoint(new MFVec3f(new double[] {0.0,0.0,0.0,-10.0,0.0,10.0,-9.0,0.0,10.0,-8.0,0.0,10.0,-7.0,0.0,10.0,-6.0,0.0,10.0,-5.0,0.0,10.0,-4.0,0.0,10.0,-3.0,0.0,10.0,-2.0,0.0,10.0,-1.0,0.0,10.0,0.0,0.0,10.0,1.0,0.0,10.0,2.0,0.0,10.0,3.0,0.0,10.0,4.0,0.0,10.0,5.0,0.0,10.0,6.0,0.0,10.0,7.0,0.0,10.0,8.0,0.0,10.0,9.0,0.0,10.0,10.0,0.0,10.0,-10.0,0.0,-10.0,-9.0,0.0,-10.0,-8.0,0.0,-10.0,-7.0,0.0,-10.0,-6.0,0.0,-10.0,-5.0,0.0,-10.0,-4.0,0.0,-10.0,-3.0,0.0,-10.0,-2.0,0.0,-10.0,-1.0,0.0,-10.0,0.0,0.0,-10.0,1.0,0.0,-10.0,2.0,0.0,-10.0,3.0,0.0,-10.0,4.0,0.0,-10.0,5.0,0.0,-10.0,6.0,0.0,-10.0,7.0,0.0,-10.0,8.0,0.0,-10.0,9.0,0.0,-10.0,10.0,0.0,-10.0})))
.setColor(new Color().setColor(new MFColor(new double[] {0.4,0.4,0.4,0.8,0.2,0.0,0.4,0.1,0.05})))))
.addChild(new Transform("LinesAlignedAlongX").setRotation(0.0,1.0,0.0,1.57079)
.addChild(new Shape().setUSE("LinesAlignedAlongZ")))
.addChild(new Transform().setRotation(1.0,0.0,0.0,-1.57079).setTranslation(10.5,0.0,0.0)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"X"})
.setFontStyle(new FontStyle().setUSE("LABEL_FONT")))
.setAppearance(new Appearance("LABEL_APPEARANCE")
.setMaterial(new Material().setDiffuseColor(1.0,1.0,.3).setEmissiveColor(.33,.33,.1))))))
.addChild(new Transform().setRotation(1.0,0.0,0.0,-1.57079).setTranslation(0.0,0.0,-10.5)
.addChild(new Billboard()
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"Y"})
.setFontStyle(new FontStyle().setUSE("LABEL_FONT")))
.setAppearance(new Appearance().setUSE("LABEL_APPEARANCE"))))))))
.addChild(new Script("CenterTextScript").setSourceCode("""
ecmascript:
// eventOut 'value' is an MFString array to match type of destination Text node string field
function initialize ( ) {
// Browser.println ('Grid script initialized, print function works');
// trace ('Grid script initialized, trace function works');
}
function set_translation (location, timeStamp) {
numberOfPlaces = 1000;
value[0] = (Math.round (location.x * numberOfPlaces) / numberOfPlaces) + ' '
+ (Math.round (location.y * numberOfPlaces) / numberOfPlaces) + ' '
+ (Math.round (location.z * numberOfPlaces) / numberOfPlaces);
// Browser.println ('location=' + location);
}
""")
.addField(new field().setName("set_translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("value").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Script("UpperRightTextScript").setSourceCode("""
ecmascript:
function set_translation (location, timeStamp) {
numberOfPlaces = 1000;
value[0] = 10 + ' ' + 10 + ' '
+ (Math.round (location.z * numberOfPlaces) / numberOfPlaces);
}
""")
.addField(new field().setName("set_translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("value").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Script("UpperLeftTextScript").setSourceCode("""
ecmascript:
function set_translation (location, timeStamp) {
numberOfPlaces = 1000;
value[0] = -10 + ' ' + 10 + ' '
+ (Math.round (location.z * numberOfPlaces) / numberOfPlaces);
}
""")
.addField(new field().setName("set_translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("value").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Script("LowerLeftTextScript").setSourceCode("""
ecmascript:
function set_translation (location, timeStamp) {
numberOfPlaces = 1000;
value[0] = -10 + ' ' + -10 + ' '
+ (Math.round (location.z * numberOfPlaces) / numberOfPlaces);
}
""")
.addField(new field().setName("set_translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("value").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Script("LowerRightTextScript").setSourceCode("""
ecmascript:
function set_translation (location, timeStamp) {
numberOfPlaces = 1000;
value[0] = 10 + ' ' + -10 + ' '
+ (Math.round (location.z * numberOfPlaces) / numberOfPlaces);
}
""")
.addField(new field().setName("set_translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("value").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new Script("SwitchTextOnOffScript").setSourceCode("""
ecmascript:
function isTouched (value, timeStamp) {
if (value == true)
touchChoice = -1;
else touchChoice = 0;
}
""")
.addField(new field().setName("isTouched").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("touchChoice").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ROUTE().setFromNode("GridSensor").setFromField("translation_changed").setToNode("LineSensorAxisZ").setToField("set_translation"))
.addComments(" Send changed position to text-construction scripts ")
.addChild(new ROUTE().setFromNode("LineSensorAxisZ").setFromField("translation_changed").setToNode("GridLocation").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("LineSensorAxisZ").setFromField("translation_changed").setToNode("CenterTextScript").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("LineSensorAxisZ").setFromField("translation_changed").setToNode("UpperRightTextScript").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("LineSensorAxisZ").setFromField("translation_changed").setToNode("UpperLeftTextScript").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("LineSensorAxisZ").setFromField("translation_changed").setToNode("LowerLeftTextScript").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("LineSensorAxisZ").setFromField("translation_changed").setToNode("LowerRightTextScript").setToField("set_translation"))
.addComments(" Send text showing changed position to output Text nodes ")
.addChild(new ROUTE().setFromNode("CenterTextScript").setFromField("value").setToNode("CenterText").setToField("string"))
.addChild(new ROUTE().setFromNode("UpperRightTextScript").setFromField("value").setToNode("UpperRightText").setToField("string"))
.addChild(new ROUTE().setFromNode("UpperLeftTextScript").setFromField("value").setToNode("UpperLeftText").setToField("string"))
.addChild(new ROUTE().setFromNode("LowerLeftTextScript").setFromField("value").setToNode("LowerLeftText").setToField("string"))
.addChild(new ROUTE().setFromNode("LowerRightTextScript").setFromField("value").setToNode("LowerRightText").setToField("string"))
.addComments(" Enable/disable grid visibility based on user touching coordinate labels ")
.addChild(new ROUTE().setFromNode("TextLabelTouchSensor").setFromField("isActive").setToNode("SwitchTextOnOffScript").setToField("isTouched"))
.addChild(new ROUTE().setFromNode("SwitchTextOnOffScript").setFromField("touchChoice").setToNode("GridOnOffSwitch").setToField("whichChoice")));
}
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 GridXY_20x20Movable 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 GridXY_20x20Movable().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.GridXY_20x20Movable\" 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.GridXY_20x20Movable self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Authoring/GridXY_20x20Movable_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Authoring/GridXY_20x20Movable_JavaExport.x3d";
String filenameX3DV = "Tools/Authoring/GridXY_20x20Movable_JavaExport.x3dv";
String filenameJSON = "Tools/Authoring/GridXY_20x20Movable_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}