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.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
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.
/**
* Prototype definition for a flying text message. Waypoints, time intervals, cycleInterval and text message can be overridden.
Related links: Catalog page FlyingTextPrototype, source FlyingTextPrototype.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 Murat Onder and Don Brutzman
*/
public class FlyingTextPrototype
{
/** Default constructor to create this object. */
public FlyingTextPrototype ()
{
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_3)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("FlyingTextPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Prototype definition for a flying text message. Waypoints, time intervals, cycleInterval and text message can be overridden."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Murat Onder and Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("2 June 2004"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("FlyingTextExample.x3d"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/FlyingTextPrototype.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("FlyingTextPrototype.x3d"))
.addChild(new ProtoDeclare("FlyingText").setName("FlyingText").setAppinfo("Visualize message transfer between two points as flying text")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("waypoints").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new MFVec3f(new MFVec3f(new double[] {0.0,0.0,0.0,0.0,1.0,0.0}))))
.addField(new field().setName("set_waypoints").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("timeIntervals").setType(field.TYPE_MFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new double[] {1.0}))
.addField(new field().setName("set_timeIntervals").setType(field.TYPE_MFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("textMessage").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new String[] {"default"}))
.addField(new field().setName("set_textMessage").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("visible").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true))
.addField(new field().setName("set_visible").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("loop").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.addField(new field().setName("axisOfRotation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec3f(0.0,0.0,0.0)))
.addField(new field().setName("timeSensorEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true))
.addField(new field().setName("startTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0))
.addField(new field().setName("set_startTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("stopTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0))
.addField(new field().setName("set_stopTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.addField(new field().setName("textDiffuseColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(.2,.2,.4)))
.addField(new field().setName("fontStyle").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)
.addChild(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE))))
.setProtoBody(new ProtoBody()
.addChild(new Group()
.addChild(new Billboard()
.setIS(new IS()
.addConnect(new connect().setNodeField("axisOfRotation").setProtoField("axisOfRotation")))
.addChild(new Transform("TextMessageTransform")
.addChild(new Switch("TextVisibilitySwitch").setWhichChoice(-1)
.addChild(new Shape()
.setGeometry(new Text("TextMessage")
.setIS(new IS()
.addConnect(new connect().setNodeField("fontStyle").setProtoField("fontStyle"))))
.setAppearance(new Appearance()
.setMaterial(new Material()
.setIS(new IS()
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("textDiffuseColor"))))))
.addChild(new TouchSensor("Toucher").setDescription("Touch to fly the text"))))
.addChild(new Group("TextAnimationGroup")
.addChild(new TimeSensor("Clock")
.setIS(new IS()
.addConnect(new connect().setNodeField("loop").setProtoField("loop"))
.addConnect(new connect().setNodeField("enabled").setProtoField("timeSensorEnabled"))
.addConnect(new connect().setNodeField("startTime").setProtoField("startTime"))
.addConnect(new connect().setNodeField("set_startTime").setProtoField("set_startTime"))
.addConnect(new connect().setNodeField("stopTime").setProtoField("stopTime"))
.addConnect(new connect().setNodeField("set_stopTime").setProtoField("set_stopTime"))))
.addChild(new ROUTE().setFromNode("Toucher").setFromField("touchTime").setToNode("Clock").setToField("set_startTime"))
.addChild(new PositionInterpolator("TextAnimator"))
.addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("TextAnimator").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("TextAnimator").setFromField("value_changed").setToNode("TextMessageTransform").setToField("set_translation"))))
.addChild(new Script("AnimationScript").setDirectOutput(true).setSourceCode("""
ecmascript:
function initialize()
{
if ((waypoints.length - timeIntervals.length) == 1 )
{
set_textMessage(textMessage);
set_timeIntervals(timeIntervals);
set_waypoints(waypoints);
}
else
{
alwaysPrint('timeIntervals.length=' + timeIntervals.length + ' should be one less '
+ 'than waypoints.length=' + waypoints.length);
alwaysPrint ('timeIntervals=' + timeIntervals);
alwaysPrint ('waypoints =' + waypoints);
}
if (visible) revealText = true;
else hideText = true;
tracePrint ('visible = ' + visible);
}
function set_textMessage(text)
{
textNode.string = text;
tracePrint ('textNode.string = ' + textNode.string);
}
function set_waypoints(waypointsArray)
{
interpolatorNode.keyValue = waypointsArray;
tracePrint ('interpolatorNode.keyValue = ' + interpolatorNode.keyValue);
}
function set_timeIntervals(intervals)
{
tracePrint ('set_timeIntervals(' + timeIntervals + ')');
totalDuration = 0;
for(i = 0; i < timeIntervals.length; i++)
{
totalDuration = totalDuration + timeIntervals[i];
}
tracePrint ('totalDuration = ' + totalDuration);
timeSensorNode.cycleInterval = totalDuration;
interpolatorNode.key[0] = 0.0;
for (j = 0; j < timeIntervals.length; j++)
{
interpolatorNode.key[j+1] = interpolatorNode.key[j] + timeIntervals[j]/totalDuration;
tracePrint ('interpolatorNode.key[j] = ' + interpolatorNode.key[j]);
}
tracePrint ('interpolatorNode.key = ' + interpolatorNode.key);
}
function set_visible (value, timestamp)
{
visible = value;
if (visible) revealText = true;
else hideText = true;
tracePrint ('visible = ' + visible);
}
function set_startTime (value, timestamp)
{
tracePrint ('set_startTime = ' + value);
set_visible (true); // ensure visible when activated
initialize (); // ensure all computations up to date
}
function tracePrint(value)
{
if (traceEnabled) alwaysPrint(value);
}
function alwaysPrint(value)
{
if (textMessage.length > 1)
Browser.println ('[FlyingText ' + textMessage + '] ' + value);
else Browser.println ('[FlyingText] ' + value);
}
""")
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("interpolatorNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new PositionInterpolator().setUSE("TextAnimator")))
.addField(new field().setName("textNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new Text().setUSE("TextMessage")))
.addField(new field().setName("timeSensorNode").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new TimeSensor().setUSE("Clock")))
.addField(new field().setName("waypoints").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_waypoints").setType(field.TYPE_MFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("timeIntervals").setType(field.TYPE_MFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_timeIntervals").setType(field.TYPE_MFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("textMessage").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_textMessage").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("visible").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_visible").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("hideText").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("revealText").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("set_startTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("totalDuration").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0))
.setIS(new IS()
.addConnect(new connect().setNodeField("traceEnabled").setProtoField("traceEnabled"))
.addConnect(new connect().setNodeField("waypoints").setProtoField("waypoints"))
.addConnect(new connect().setNodeField("set_waypoints").setProtoField("set_waypoints"))
.addConnect(new connect().setNodeField("timeIntervals").setProtoField("timeIntervals"))
.addConnect(new connect().setNodeField("set_timeIntervals").setProtoField("set_timeIntervals"))
.addConnect(new connect().setNodeField("textMessage").setProtoField("textMessage"))
.addConnect(new connect().setNodeField("set_textMessage").setProtoField("set_textMessage"))
.addConnect(new connect().setNodeField("visible").setProtoField("visible"))
.addConnect(new connect().setNodeField("set_visible").setProtoField("set_visible"))
.addConnect(new connect().setNodeField("set_startTime").setProtoField("set_startTime"))))
.addChild(new Group("TextVisibilityGroup")
.addChild(new IntegerTrigger("HideTextTrigger"))
.addChild(new ROUTE().setFromNode("AnimationScript").setFromField("hideText").setToNode("HideTextTrigger").setToField("set_boolean"))
.addChild(new ROUTE().setFromNode("HideTextTrigger").setFromField("triggerValue").setToNode("TextVisibilitySwitch").setToField("whichChoice"))
.addChild(new IntegerTrigger("RevealTextTrigger").setIntegerKey(0))
.addChild(new ROUTE().setFromNode("AnimationScript").setFromField("revealText").setToNode("RevealTextTrigger").setToField("set_boolean"))
.addChild(new ROUTE().setFromNode("RevealTextTrigger").setFromField("triggerValue").setToNode("TextVisibilitySwitch").setToField("whichChoice"))))))
.addComments(" ============================ ")
.addChild(new Anchor().setDescription("FlyingText Example").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"../../../Savage/Tools/Animation/FlyingTextExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/FlyingTextExample.x3d","../../../Savage/Tools/Animation/FlyingTextExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/FlyingTextExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"FlyingTextPrototype","defines a prototype","","Click text to see example scene","","(Text has Billboard style)"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.7)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(.8,.7,0.2))))));
}
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 FlyingTextPrototype 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 FlyingTextPrototype().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.FlyingTextPrototype\" 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.FlyingTextPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/FlyingTextPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/FlyingTextPrototype_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/FlyingTextPrototype_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/FlyingTextPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}