package Vrml2Sourcebook.Chapter27SensingVisibilityProximityCollision;
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.Lighting.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Rendering.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Sound.*;
import org.web3d.x3d.jsail.Texturing.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* An orb that animates (for a single revolution) when the viewer collides with its box proxy shape. Walk towards the orb by using the up-arrow key.
Related links: Catalog page Figure27_3CollisionDetectionSpinningOrb, source Figure27_3CollisionDetectionSpinningOrb.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 Figure 27.3, The VRML 2.0 Sourcebook, Copyright [1997] By Andrea L. Ames, David R. Nadeau, and John L. Moreland
*/
public class Figure27_3CollisionDetectionSpinningOrb
{
/** Default constructor to create this object. */
public Figure27_3CollisionDetectionSpinningOrb ()
{
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("Figure27_3CollisionDetectionSpinningOrb.x3d"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("fix NavigationInfo WALK mode inconsistencies"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("Castle Game Engine view3dscene Issue: tovrmlx3d.exe ROUTE validation confused by similar DEF names OrbSpin, OrbSpinner"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Figure 27.3, The VRML 2.0 Sourcebook, Copyright [1997] By Andrea L. Ames, David R. Nadeau, and John L. Moreland"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.wiley.com/legacy/compbooks/vrml2sbk/ch27/27fig03.htm"))
.addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("26 October 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("7 April 2024"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("An orb that animates (for a single revolution) when the viewer collides with its box proxy shape. Walk towards the orb by using the up-arrow key."))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter27SensingVisibilityProximityCollision/Figure27_3CollisionDetectionSpinningOrb.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()
.addChild(new WorldInfo().setTitle("Figure27_3CollisionDetectionSpinningOrb.x3d"))
.addChild(new Viewpoint().setDescription("Zoom in on the orb to trigger the Collision node").setPosition(0.0,2.0,10.0))
.addChild(new Viewpoint().setDescription("Close-up viewpoint by the orb that triggers the Collision node").setPosition(0.0,0.8,2.5))
.addComments(" Note NavigationInfo avatarSize affects collision range ")
.addChild(new NavigationInfo().setAvatarSize(new double[] {2.0,1.0,0.5}).setHeadlight(false).setSpeed(2).setType(new String[] {"WALK","EXAMINE","ANY"}))
.addChild(new Group()
.addChild(new Transform().setTranslation(0.0,0.0,2.5)
.addChild(new Inline("Floor").setUrl(new String[] {"../Chapter25LevelOfDetail/Figure25_06DungeonRoomFloor.x3d","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter25LevelOfDetail/Figure25_06DungeonRoomFloor.x3d","../Chapter25LevelOfDetail/Figure25_06DungeonRoomFloor.wrl","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter25LevelOfDetail/Figure25_06DungeonRoomFloor.wrl"})))
.addChild(new Transform().setTranslation(0.0,0.0,-2.5)
.addChild(new Inline().setUSE("Floor")))
.addChild(new Collision("OrbCollide")
.addComments(" Note that proxy geometry is not rendered ")
.setProxy(new Transform("ProxyGeometryTransform").setTranslation(0.0,0.6,0.0)
.addChild(new Shape()
.setGeometry(new Box().setSize(0.4,1.2,0.4))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(0.8)))))
.addComments(" If you want to also see the simplifying proxy geometry, DEF/USE it outside of the proxy containerField subtree. ")
.addChild(new Transform().setUSE("ProxyGeometryTransform"))
.addComments(" Rest of collidable scene follows. ")
.addChild(new Transform("OrbSpin").setTranslation(0.0,1.0,0.0)
.addChild(new PointLight().setAmbientIntensity(0.2).setColor(0.7,0.5,0.0).setLocation(0.3,0.0,0.0).setRadius(10))
.addChild(new Shape()
.setAppearance(new Appearance()
.setTexture(new ImageTexture().setUrl(new String[] {"fire.jpg","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter27SensingVisibilityProximityCollision/fire.jpg"}))
.addComments(" alternate emissive material as backup, comparable to fire.jpg texturing ")
.setMaterial(new Material().setEmissiveColor(0.8,0.4,0.1)))
.setGeometry(new Sphere().setRadius(0.2)))))
.addChild(new Shape()
.setAppearance(new Appearance("PedestalColor")
.setMaterial(new Material().setDiffuseColor(0.7,0.6,0.5)))
.setGeometry(new IndexedFaceSet().setCoordIndex(new int[] {0,1,4,-1,1,2,4,-1,2,3,4,-1,3,0,4,-1})
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-0.12,0.03,0.12,0.12,0.03,0.12,0.12,0.03,-0.12,-0.12,0.03,-0.12,0.0,0.63,0.0})))))
.addChild(new Transform().setTranslation(0.0,0.015,0.0)
.addChild(new Shape()
.setAppearance(new Appearance().setUSE("PedestalColor"))
.setGeometry(new Box().setSize(0.4,0.03,0.4)))))
.addChild(new Sound("WispyAmp").setIntensity(0.5)
.setSource(new AudioClip("Wispy").setDescription("drone").setLoop(true).setUrl(new String[] {"drone1.wav","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter27SensingVisibilityProximityCollision/drone1.wav"})))
.addComments(" Animation clock ")
.addChild(new TimeSensor("Clock").setCycleInterval(8))
.addChild(new ROUTE().setFromNode("OrbCollide").setFromField("collideTime").setToNode("Clock").setToField("set_startTime"))
.addChild(new ROUTE().setFromNode("OrbCollide").setFromField("collideTime").setToNode("Wispy").setToField("set_startTime"))
.addComments(" Orb rotation animation and scalar-driven volume control ")
.addChild(new OrientationInterpolator("OrbSpinner").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,0.0,0.0,1.0,0.0,3.14,0.0,1.0,0.0,6.28})))
.addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("OrbSpinner").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("OrbSpinner").setFromField("value_changed").setToNode("OrbSpin").setToField("set_rotation"))
.addChild(new ScalarInterpolator("WispyVolume").setKey(new double[] {0.0,0.1,0.9,1.0}).setKeyValue(new double[] {0.0,0.6,0.6,0.0}))
.addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("WispyVolume").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("WispyVolume").setFromField("value_changed").setToNode("WispyAmp").setToField("set_intensity")));
}
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 Figure27_3CollisionDetectionSpinningOrb 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 Figure27_3CollisionDetectionSpinningOrb().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: \"Vrml2Sourcebook.Chapter27SensingVisibilityProximityCollision.Figure27_3CollisionDetectionSpinningOrb\" 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("Vrml2Sourcebook.Chapter27SensingVisibilityProximityCollision.Figure27_3CollisionDetectionSpinningOrb self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter27SensingVisibilityProximityCollision/Figure27_3CollisionDetectionSpinningOrb_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter27SensingVisibilityProximityCollision/Figure27_3CollisionDetectionSpinningOrb_JavaExport.x3d";
String filenameX3DV = "Chapter27SensingVisibilityProximityCollision/Figure27_3CollisionDetectionSpinningOrb_JavaExport.x3dv";
String filenameJSON = "Chapter27SensingVisibilityProximityCollision/Figure27_3CollisionDetectionSpinningOrb_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}