package Savage.Tools.Animation;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EventUtilities.*;
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.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Animate through a set of Viewpoint or GeoViewpoint nodes and repeat.
Related links: Catalog page ViewpointSequencerPrototype, source ViewpointSequencerPrototype.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 ViewpointSequencerPrototype
{
/** Default constructor to create this object. */
public ViewpointSequencerPrototype ()
{
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("ViewpointSequencerPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Animate through a set of Viewpoint or GeoViewpoint nodes and repeat"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("10 December 2002"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("Two versions of this scene are maintained in order to avoid Cross-Origin Resource Sharing (CORS) restrictions when referenced from X3D models embedded inside HTML."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/ViewpointSequencerPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#ScalarInterpolator"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("Viewpoint Tour"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("eliminate intermediate TraceHolder"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ViewpointSequencerPrototype.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("ViewpointSequencerPrototype.x3d"))
.addChild(new ProtoDeclare("ViewpointSequencer").setName("ViewpointSequencer").setAppinfo("Sequentially binds each Viewpoint in a set of Viewpoint USE nodes, creating an automatic tour for a scene")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("viewpoints").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Viewpoint USE nodes that are sequentially bound")
.addComments(" initialization nodes (if any) go here "))
.addField(new field().setName("interval").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(5).setAppinfo("number of seconds between viewpoint shifts"))
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true).setAppinfo("whether ViewpointSequencer is enabled or not"))
.addField(new field().setName("set_enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("whether ViewpointSequencer is enabled or not"))
.addField(new field().setName("previous").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("bind previous Viewpoint in list"))
.addField(new field().setName("next").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("bind next Viewpoint in list"))
.addField(new field().setName("toggleMessage").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new String[] {"Click text to toggle","ViewpointSequencer"}).setAppinfo("Select message to toggle ViewpointSequencer"))
.addField(new field().setName("toggleMessageFontSize").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(1).setAppinfo("Font size for toggleMessage text"))
.addField(new field().setName("toggleMessageColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.6,0.4,0.13)).setAppinfo("Color for toggleMessage text"))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(false).setAppinfo("enable console output")))
.setProtoBody(new ProtoBody()
.addChild(new Group("ProtoBodyGroup")
.addChild(new TimeSensor("Trigger").setLoop(true)
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))
.addConnect(new connect().setNodeField("cycleInterval").setProtoField("interval"))))
.addChild(new TimeSensor("TraceHolder")
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("traceEnabled"))))
.addChild(new Script("SequencerScript").setDirectOutput(true).setSourceCode("""
ecmascript:
function initialize ()
{
index = 0;
viewpointCount = viewpoints.length;
traceEnabled = TraceHolderNode.loop;
tracePrint ('initialize: viewpoints.length=' + viewpointCount);
tracePrint ('initialize: Viewpoint [' + index + '] ' + viewpoints[index].description);
if (TriggerNode.enabled=='false') return;
if (viewpointCount > 0) viewpoints[index].set_bind = true;
}
function set_enabled (newValue, timeStamp)
{
enabled = newValue;
tracePrint ('enabled=' + newValue);
if ((newValue == true) && (viewpoints.length >= 1))
viewpoints[0].bind = true;
}
function triggerNext(triggerTime, timeStamp)
{
if ((TriggerNode.enabled=='false') || (viewpointCount==0)) return;
if (index < viewpointCount - 1)
index++;
else index = 0;
if (viewpointCount > 1) viewpoints[index].set_bind = true;
tracePrint ('triggerNext: Viewpoint [' + index + '] ' + viewpoints[index].description);
}
function previous (value, timeStamp)
{
if ((TriggerNode.enabled=='false') || (viewpointCount==0)) return;
if (value==true) // trigger on true events only
{
if (index > 0)
index--;
else index = viewpointCount - 1;
if (viewpointCount > 1) viewpoints[index].set_bind = true;
tracePrint ('previous: Viewpoint [' + index + '] ' + viewpoints[index].description);
}
}
function next (value, timeStamp)
{
if ((TriggerNode.enabled=='false') || (viewpointCount==0)) return;
if (value==true) // trigger on true events only
{
if (index < viewpointCount - 1)
index++;
else index = 0;
if (viewpointCount > 1) viewpoints[index].set_bind = true;
tracePrint ('next: Viewpoint [' + index + '] ' + viewpoints[index].description);
}
}
function tracePrint(outputString)
{
if (traceEnabled) Browser.println ('[ViewpointSequencer] ' + outputString);
}
function alwaysPrint(outputString)
{
Browser.println ('[ViewpointSequencer] ' + outputString);
}
""")
.addField(new field().setName("viewpoints").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("whether ViewpointSequencer is enabled or not"))
.addField(new field().setName("TriggerNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new TimeSensor().setUSE("Trigger")))
.addField(new field().setName("TraceHolderNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new TimeSensor().setUSE("TraceHolder")))
.addField(new field().setName("triggerNext").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("previous").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("next").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addComments(" local Script variables needing persistent values ")
.addField(new field().setName("index").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
.addField(new field().setName("viewpointCount").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.setIS(new IS()
.addConnect(new connect().setNodeField("viewpoints").setProtoField("viewpoints"))
.addConnect(new connect().setNodeField("previous").setProtoField("previous"))
.addConnect(new connect().setNodeField("next").setProtoField("next"))
.addConnect(new connect().setNodeField("set_enabled").setProtoField("set_enabled"))))
.addChild(new ROUTE().setFromNode("Trigger").setFromField("cycleTime").setToNode("SequencerScript").setToField("triggerNext"))
.addChild(new Group("TouchTextGroup")
.addChild(new TouchSensor("TouchTextSensor").setDescription("Click text to toggle ViewpointSequencer"))
.addChild(new Billboard().setAxisOfRotation(0.0,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Text()
.setIS(new IS()
.addConnect(new connect().setNodeField("string").setProtoField("toggleMessage")))
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE)
.setIS(new IS()
.addConnect(new connect().setNodeField("size").setProtoField("toggleMessageFontSize")))))
.setAppearance(new Appearance()
.setMaterial(new Material()
.setIS(new IS()
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("toggleMessageColor"))))))
.addComments(" An invisible box behind the string helps to toggle the ViewpointSequencer ")
.addChild(new Shape()
.setGeometry(new Box().setSize(7.8,2.0,0.1))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,1.0).setTransparency(1)))))
.addChild(new BooleanToggle("TouchToggle"))
.addChild(new ROUTE().setFromNode("TouchTextSensor").setFromField("isActive").setToNode("TouchToggle").setToField("set_boolean"))
.addComments(" TouchToggle toggle_changed should likely revert to TouchToggle toggle when inputOutput fields supported in Script, or native implementation provided. ")
.addChild(new ROUTE().setFromNode("TouchToggle").setFromField("toggle").setToNode("SequencerScript").setToField("set_enabled"))
.addChild(new ROUTE().setFromNode("TouchToggle").setFromField("toggle").setToNode("Trigger").setToField("enabled"))))))
.addComments(" ===============Example============== ")
.addChild(new Anchor().setDescription("select to view ViewpointSequencer example").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"ViewpointSequencerExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ViewpointSequencerExample.x3d","ViewpointSequencerExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ViewpointSequencerExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"ViewpointSequencerPrototype","defines a prototype","","Click text to see example scene","ViewpointTourExample"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.9)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,0.2))))
.addChild(new Shape()
.addComments(" transparent Box to make text more selectable ")
.setGeometry(new Box().setSize(11.0,5.0,0.1))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,1.0).setTransparency(1))))));
}
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 ViewpointSequencerPrototype 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 ViewpointSequencerPrototype().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.ViewpointSequencerPrototype\" 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.ViewpointSequencerPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/ViewpointSequencerPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/ViewpointSequencerPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/ViewpointSequencerPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/ViewpointSequencerPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}