package Savage.Tools.Animation;
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.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
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.
/**
* Modified CylinderSensor oriented about an arbitrary axis, relative to peer/child geometry that remains oriented to its original axis. Originally authored by Don Brutzman's MV4204 class, with modifications by Maj James Breitinger USMC to include min/max angles of rotation and object center. Motivation: Modify example shown by Chapter 9 Figure 7 to build a PROTO for a CylinderSensor oriented about an arbitrary axis.
Related links: Catalog page ArbitraryAxisCylinderSensorPrototype, source ArbitraryAxisCylinderSensorPrototype.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 ArbitraryAxisCylinderSensorPrototype
{
/** Default constructor to create this object. */
public ArbitraryAxisCylinderSensorPrototype ()
{
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("ArbitraryAxisCylinderSensorPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Modified CylinderSensor oriented about an arbitrary axis, relative to peer/child geometry that remains oriented to its original axis. Originally authored by Don Brutzman's MV4204 class, with modifications by Maj James Breitinger USMC to include min/max angles of rotation and object center. Motivation: Modify example shown by Chapter 9 Figure 7 to build a PROTO for a CylinderSensor oriented about an arbitrary axis."))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("ArbitraryAxisCylinderSensor operates on its children, NOT on its peers. This variation is necessary in order to accomplish the desired Transform rotation to a new orientation axis."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("1 October 1998"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ArbitraryAxisCylinderSensorExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ArbitraryAxisCylinderSensorPrototypeOriginal.wrl"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ArbitraryAxisCylinderSensorPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("The VRML 2.0 Sourcebook (Copyright 1997 By Andrea L. Ames, David R. Nadeau, and John L. Moreland)"))
.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("ArbitraryAxisCylinderSensorPrototype.x3d"))
.addChild(new ProtoDeclare("ArbitraryAxisCylinderSensor").setName("ArbitraryAxisCylinderSensor").setAppinfo("Modified CylinderSensor with children nodes oriented about an arbitrary axis. Warning: ArbitraryAxisCylinderSensor affects children, not peers.")
.setProtoInterface(new ProtoInterface()
.addComments(" All default fields and events of a regular CylinderSensor are exposed without modification. ")
.addComments(" Transparent viewing-assist geometry shows orientation and cylindrical mapping of mouse movements by sensor. Since viewCylinderSensorShape connects to a Script, it is a initialize-time field instead of a run-time exposedField. ")
.addField(new field().setName("shiftRotationAxis").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFRotation(1.0,0.0,0.0,0.0)).setAppinfo("shifted axis of rotation from local vertical, default 1 0 0 0"))
.addField(new field().setName("center").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)).setAppinfo("local center for axis of rotation, default 0 0 0"))
.addField(new field().setName("showCylinderSensorShape").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true).setAppinfo("whether to show visualization shape to show orientation and cylindrical mapping of mouse movements by sensor, default true"))
.addField(new field().setName("scaleCylinderSensorShape").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(1.0,1.0,1.0)).setAppinfo("scale for visualization shape, default 1 1 1"))
.addField(new field().setName("colorCylinderSensorShape").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.9,0.9,0.4)).setAppinfo("color for visualization shape, default 0.9 0.9 0.4"))
.addField(new field().setName("transparencyCylinderSensorShape").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0.8).setAppinfo("transparency for visualization shape"))
.addField(new field().setName("children").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("children nodes affected by ArbitraryAxisCylinderSensor")
.addComments(" initialization nodes (if any) go here "))
.addField(new field().setName("autoOffset").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true).setAppinfo("determines whether previous offset values are remembered/accumulated, default true"))
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue("Select and drag to rotate ArbitraryAxisCylinderSensor").setAppinfo("Text tooltip displayed for user interaction"))
.addField(new field().setName("diskAngle").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0.262).setAppinfo("diskAngle 0 forces disk-like behavior, diskAngle 1.57 (90 degrees) forces cylinder-like behavior, default 0.262, range [0,pi/2]"))
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true).setAppinfo("enables/disables node operation, default true"))
.addField(new field().setName("minAngle").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0).setAppinfo("clamps rotation_changed events, default 0, range [-2pi,2pi]"))
.addField(new field().setName("maxAngle").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(-1).setAppinfo("clamps rotation_changed events, default -1, range [-2pi,2pi]"))
.addField(new field().setName("offset").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0).setAppinfo("sends event and remembers last value sensed, default 0, range (-infinity,infinity)"))
.addField(new field().setName("isActive").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("output event isActive=true when primary mouse button is pressed, output event isActive=false when released."))
.addField(new field().setName("rotation_changed").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("rotation_changed events equal sum of relative bearing changes plus offset value about Y-axis in local coordinate system"))
.addField(new field().setName("trackPoint_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("trackPoint_changed events give intersection point of bearing with sensor's virtual geometry")))
.setProtoBody(new ProtoBody()
.addComments(" Prototype body follows. First rotate local frame about center to axis of interest, then perform the rotation about the desired center. ")
.addChild(new Transform("ArbitraryAxisTransform")
.setIS(new IS()
.addConnect(new connect().setNodeField("rotation").setProtoField("shiftRotationAxis"))
.addConnect(new connect().setNodeField("center").setProtoField("center")))
.addChild(new CylinderSensor("RotatedCylinderSensor")
.setIS(new IS()
.addConnect(new connect().setNodeField("autoOffset").setProtoField("autoOffset"))
.addConnect(new connect().setNodeField("description").setProtoField("description"))
.addConnect(new connect().setNodeField("diskAngle").setProtoField("diskAngle"))
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))
.addConnect(new connect().setNodeField("minAngle").setProtoField("minAngle"))
.addConnect(new connect().setNodeField("maxAngle").setProtoField("maxAngle"))
.addConnect(new connect().setNodeField("offset").setProtoField("offset"))
.addConnect(new connect().setNodeField("isActive").setProtoField("isActive"))
.addConnect(new connect().setNodeField("rotation_changed").setProtoField("rotation_changed"))
.addConnect(new connect().setNodeField("trackPoint_changed").setProtoField("trackPoint_changed"))))
.addComments(" CylinderSensorRotationTransform rotation value is overridden by RotatedCylinderSensor, so leave it alone! ")
.addChild(new Transform("CylinderSensorRotationTransform")
.addComments(" ROUTEd rotation to RestorationTransform negates (and offsets) arbitrary-axis rotation in RestorationTransform, so children geometry is returned to original orientation. ")
.addComments(" Perform the rotation about the same center. ")
.addChild(new Transform("RestorationTransform")
.setIS(new IS()
.addConnect(new connect().setNodeField("center").setProtoField("center"))
.addConnect(new connect().setNodeField("children").setProtoField("children"))))
.addComments(" Prototype children field finally appears above... ")
.addChild(new Switch("ScaleSensorSwitch").setWhichChoice(0)
.addChild(new Transform("ScaleSensorShape")
.setIS(new IS()
.addConnect(new connect().setNodeField("scale").setProtoField("scaleCylinderSensorShape")))
.addChild(new Shape()
.setGeometry(new Cylinder().setHeight(2.5).setRadius(0.1))
.setAppearance(new Appearance("SensorShapeAppearance")
.setMaterial(new Material("SensorShapeMaterial")
.setIS(new IS()
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("colorCylinderSensorShape"))
.addConnect(new connect().setNodeField("transparency").setProtoField("transparencyCylinderSensorShape"))))))
.addChild(new Shape()
.setGeometry(new Cylinder().setHeight(0.2).setRadius(1.5))
.setAppearance(new Appearance().setUSE("SensorShapeAppearance"))))))
.addChild(new Script("NegationScript").setDirectOutput(true).setSourceCode("""
ecmascript:
function initialize () {
rotationOffset = new SFRotation (0, 1, 0, offset); // establish initial angle
CylinderSensorRotationTransform.rotation =
CylinderSensorRotationTransform.rotation.multiply (rotationOffset);
rotationIntermediate = shiftRotationAxis;
rotationIntermediate = rotationIntermediate.inverse ();
rotationRestore = rotationIntermediate;
Browser.println (' rotationOffset=' + rotationOffset.toString());
Browser.println ('shiftRotationAxis=' + shiftRotationAxis.toString());
Browser.println (' rotationRestore=' + rotationRestore.toString());
}
""")
.addField(new field().setName("shiftRotationAxis").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("offset").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("rotationRestore").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("CylinderSensorRotationTransform").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new Transform().setUSE("CylinderSensorRotationTransform")))
.addComments(" local variables ")
.addField(new field().setName("rotationOffset").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFRotation(0.0,1.0,0.0,0.0)))
.addField(new field().setName("rotationIntermediate").setType(field.TYPE_SFROTATION).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFRotation(0.0,1.0,0.0,0.0)))
.setIS(new IS()
.addConnect(new connect().setNodeField("offset").setProtoField("offset"))
.addConnect(new connect().setNodeField("shiftRotationAxis").setProtoField("shiftRotationAxis"))))
.addChild(new Script("HideSensorShapeScript").setSourceCode("""
ecmascript:
function initialize () {
if (showCylinderSensorShape == true)
choiceScaleSensor = 0;
else choiceScaleSensor = -1;
}
""")
.addField(new field().setName("showCylinderSensorShape").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("choiceScaleSensor").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("showCylinderSensorShape").setProtoField("showCylinderSensorShape")))))
.addChild(new ROUTE().setFromNode("RotatedCylinderSensor").setFromField("rotation_changed").setToNode("CylinderSensorRotationTransform").setToField("set_rotation"))
.addChild(new ROUTE().setFromNode("NegationScript").setFromField("rotationRestore").setToNode("RestorationTransform").setToField("rotation"))
.addChild(new ROUTE().setFromNode("HideSensorShapeScript").setFromField("choiceScaleSensor").setToNode("ScaleSensorSwitch").setToField("whichChoice"))
.addComments(" Add any ROUTEs here, going from Script to other nodes in ProtoBody ")))
.addComments(" Example use of this prototype is in ArbitraryAxisCylinderSensorExample.x3d, .wrl ")
.addChild(new Viewpoint().setDescription("click message to view example").setPosition(0.0,0.0,8.0))
.addComments(" Redirection text in case a user examines this PROTO file via a 3D browser: ")
.addChild(new Anchor().setDescription("Touch text for example").setUrl(new String[] {"ArbitraryAxisCylinderSensorExamples.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ArbitraryAxisCylinderSensorExamples.x3d","ArbitraryAxisCylinderSensorExamples.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ArbitraryAxisCylinderSensorExamples.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[] {"ArbitraryAxisCylinderSensorPrototype","is a Prototype (PROTO) definition file.","","To see an example scene using this new node","click this text and view","ArbitraryAxisCylinderSensorExample"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.5))))
.addChild(new Shape("SelectionAssist")
.setGeometry(new Box().setSize(9.0,4.0,.001))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(0.9))))));
}
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 ArbitraryAxisCylinderSensorPrototype 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 ArbitraryAxisCylinderSensorPrototype().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.Animation.ArbitraryAxisCylinderSensorPrototype\" 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.Animation.ArbitraryAxisCylinderSensorPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/ArbitraryAxisCylinderSensorPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/ArbitraryAxisCylinderSensorPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/ArbitraryAxisCylinderSensorPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/ArbitraryAxisCylinderSensorPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}