package Savage.Tools.Authoring;
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.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Example authoring use of AnimatedViewpointRecorder prototype. Each tour recording output goes to the console, where it must be cut/pasted for further use. See AnimatedViewpointRecorderSample for sample output.
Related links: Catalog page AnimatedViewpointRecorderExample, source AnimatedViewpointRecorderExample.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, Ken Curtin, Duane Davis, Christos Kalogrias
*/
public class AnimatedViewpointRecorderExample
{
/** Default constructor to create this object. */
public AnimatedViewpointRecorderExample ()
{
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("AnimatedViewpointRecorderExample.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Example authoring use of AnimatedViewpointRecorder prototype. Each tour recording output goes to the console, where it must be cut/pasted for further use. See AnimatedViewpointRecorderSample for sample output."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman, Ken Curtin, Duane Davis, Christos Kalogrias"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("9 November 2003"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("AnimatedViewpointRecorderPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("AnimatedViewpointRecorderSample.x3d"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("recording animated viewpoint tour"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/AnimatedViewpointRecorderExample.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("AnimatedViewpointRecorderExample.x3d"))
.addChild(new ExternProtoDeclare("AnimatedViewpointRecorder").setName("AnimatedViewpointRecorder").setAppinfo("AnimatedViewpointRecorder captures view position and orientation tour to create a guided tour animation. The recording output goes to the browser console where the .x3d (or .x3dv) output can be cut/pasted for further use.").setUrl(new String[] {"AnimatedViewpointRecorderPrototype.x3d#AnimatedViewpointRecorder","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/AnimatedViewpointRecorderPrototype.x3d#AnimatedViewpointRecorder","AnimatedViewpointRecorderPrototype.wrl#AnimatedViewpointRecorder","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/AnimatedViewpointRecorderPrototype.wrl#AnimatedViewpointRecorder"})
.addField(new field().setName("start").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Set start=true to commence recording viewpoint position/orientation."))
.addField(new field().setName("stop").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Set stop=true to finish recording viewpoint position/orientation. Resulting VRML is added to scene resulting X3D and VRML is output to console."))
.addField(new field().setName("samplingInterval").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default 0.1 seconds"))
.addField(new field().setName("outputX3D").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("whether to output .x3d syntax on browser console"))
.addField(new field().setName("outputClassicVRML").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("whether to output .x3d syntax on browser console"))
.addField(new field().setName("filterDeadTime").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("TODO not yet implemented")))
.addChild(new Viewpoint().setDescription("Entry view: start/stop recording"))
.addChild(new Inline("HelloWorld").setUrl(new String[] {"../../../HelloWorld.x3d","https://www.web3d.org/x3d/content/examples/Basic/HelloWorld.x3d","../../../HelloWorld.wrl","https://www.web3d.org/x3d/content/examples/Basic/HelloWorld.wrl"}))
.addChild(new ProtoInstance("AnimatedViewpointRecorder", "AnimatedViewpointRecorderTest").setContainerField("children"))
.addChild(new Group("RecordingControls")
.addChild(new Transform().setTranslation(-3.0,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"Touch text to start","recording new","view animation"})
.setFontStyle(new FontStyle("CenterJustify").setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.5)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.2,0.8,0.2).setTransparency(0.5))))
.addChild(new Shape("TransparentBox")
.setGeometry(new Box().setSize(3.0,1.75,0.01))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1))))
.addChild(new TouchSensor("StartTouch").setDescription("touch to start recording"))
.addChild(new ROUTE().setFromNode("StartTouch").setFromField("isActive").setToNode("AnimatedViewpointRecorderTest").setToField("start")))
.addChild(new Transform().setTranslation(3.0,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"Touch to stop","recording new","view animation"})
.setFontStyle(new FontStyle().setUSE("CenterJustify")))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.8,0.2,0.2).setTransparency(0.5))))
.addChild(new Shape().setUSE("TransparentBox"))
.addChild(new TouchSensor("StopTouch").setDescription("touch to stop recording"))
.addChild(new ROUTE().setFromNode("StopTouch").setFromField("isActive").setToNode("AnimatedViewpointRecorderTest").setToField("stop")))));
}
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 AnimatedViewpointRecorderExample 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 AnimatedViewpointRecorderExample().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.AnimatedViewpointRecorderExample\" 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.AnimatedViewpointRecorderExample self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Authoring/AnimatedViewpointRecorderExample_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Authoring/AnimatedViewpointRecorderExample_JavaExport.x3d";
String filenameX3DV = "Tools/Authoring/AnimatedViewpointRecorderExample_JavaExport.x3dv";
String filenameJSON = "Tools/Authoring/AnimatedViewpointRecorderExample_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}