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.Interpolation.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* RelativeProximitySensor design pattern: example use for paired object-to-object collision detection.
Related links: Catalog page RelativeProximitySensorExample, source RelativeProximitySensorExample.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 and MV4204 class
*/
public class RelativeProximitySensorExample
{
/** Default constructor to create this object. */
public RelativeProximitySensorExample ()
{
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("RelativeProximitySensorExample.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("RelativeProximitySensor design pattern: example use for paired object-to-object collision detection."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman and MV4204 class"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("7 September 2004"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("RelativeProximitySensorPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("Object-to-object collision detection"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/RelativeProximitySensorExample.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("RelativeProximitySensorExample.x3d"))
.addChild(new ExternProtoDeclare("RelativeProximitySensor").setName("RelativeProximitySensor").setAppinfo("RelativeProximitySensor measures paired object-to-object collision detection").setUrl(new String[] {"RelativeProximitySensorPrototype.x3d#RelativeProximitySensor","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/RelativeProximitySensorPrototype.x3d#RelativeProximitySensor","RelativeProximitySensorPrototype.wrl#RelativeProximitySensor","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/RelativeProximitySensorPrototype.wrl#RelativeProximitySensor"})
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("describe the purpose of this sensor"))
.addField(new field().setName("locationPrimary").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("where is the primary object"))
.addField(new field().setName("set_locationPrimary").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("update location of the primary object"))
.addField(new field().setName("locationSecondary").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("where is the secondary object"))
.addField(new field().setName("set_locationSecondary").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("update location of the secondary object"))
.addField(new field().setName("proximityRangeThreshold").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("distance for detecting object-to-object collision"))
.addField(new field().setName("set_proximityRangeThreshold").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("change threshold distance for detecting collision"))
.addField(new field().setName("isInRange").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("is object-to-object distance less than proximityRangeThreshold?"))
.addField(new field().setName("isInRangeTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("when did object-to-object range meet detection criteria?"))
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("whether sensor is active"))
.addField(new field().setName("set_enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY)))
.addChild(new Viewpoint().setDescription("RelativeProximitySensor test").setPosition(0.0,2.0,25.0))
.addComments(" ==================== ")
.addChild(new Group("TextTouchGroup")
.addChild(new Transform().setTranslation(0.0,5.0,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"click text to watch object motion and","RelativeProximitySensor console alerts"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(1.8)))
.setAppearance(new Appearance()
.setMaterial(new Material("TextColor").setDiffuseColor(0.8,0.1,0.1))))
.addChild(new Shape()
.setGeometry(new Box().setSize(25.0,4.0,0.01))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1)))))
.addChild(new TouchSensor("TouchSensorActive").setDescription("click to initiate time delay and color change")))
.addComments(" ==================== ")
.addChild(new Group("ShapeAnimationGroup")
.addChild(new TimeSensor("AnimationClock").setCycleInterval(4))
.addChild(new ROUTE().setFromNode("TouchSensorActive").setFromField("touchTime").setToNode("AnimationClock").setToField("set_startTime"))
.addChild(new Transform("LeftHandBoxTransform").setTranslation(-10.0,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Box())
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.1,0.8,0.1))))
.addChild(new PositionInterpolator("BoxMover").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new MFVec3f(new double[] {-10.0,0.0,0.0,-3.0,0.0,0.0,-10.0,0.0,0.0})))
.addChild(new ROUTE().setFromNode("AnimationClock").setFromField("fraction_changed").setToNode("BoxMover").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("BoxMover").setFromField("value_changed").setToNode("LeftHandBoxTransform").setToField("set_translation")))
.addChild(new Transform("RightHandSphereTransform").setTranslation(10.0,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Sphere())
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.1,0.1,0.8))))
.addChild(new PositionInterpolator("SphereMover").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new MFVec3f(new double[] {10.0,0.0,0.0,2.0,0.0,0.0,10.0,0.0,0.0})))
.addChild(new ROUTE().setFromNode("AnimationClock").setFromField("fraction_changed").setToNode("SphereMover").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("SphereMover").setFromField("value_changed").setToNode("RightHandSphereTransform").setToField("set_translation"))))
.addChild(new ProtoInstance("RelativeProximitySensor", "RPS").setContainerField("children")
.addFieldValue(new fieldValue().setName("description").setValue("test case"))
.addFieldValue(new fieldValue().setName("enabled").setValue(true))
.addFieldValue(new fieldValue().setName("locationPrimary").setValue(new SFVec3f(-10.0,0.0,0.0)))
.addFieldValue(new fieldValue().setName("locationSecondary").setValue(new SFVec3f(10.0,0.0,0.0))))
.addComments(" Connect interpolator output to monitor movement of first object. ")
.addChild(new ROUTE().setFromNode("BoxMover").setFromField("value_changed").setToNode("RPS").setToField("set_locationPrimary"))
.addComments(" Test use of Transform output, which means that this sensor could be used to monitor other nodes that might have multiple movers. ")
.addChild(new ROUTE().setFromNode("RightHandSphereTransform").setFromField("translation_changed").setToNode("RPS").setToField("set_locationSecondary")));
}
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 RelativeProximitySensorExample 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 RelativeProximitySensorExample().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.RelativeProximitySensorExample\" 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.RelativeProximitySensorExample self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/RelativeProximitySensorExample_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/RelativeProximitySensorExample_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/RelativeProximitySensorExample_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/RelativeProximitySensorExample_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}