package Savage.Tools.Animation;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
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.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.
/**
* This example shows how to use the ColorSequencer prototype in an animated scenario. ColorSequencer outputs an individual SFColor without interpolation, in response to selecting an array value or simply sequencing next/previous.
Related links: Catalog page ColorSequencerExample, source ColorSequencerExample.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 ColorSequencerExample
{
/** Default constructor to create this object. */
public ColorSequencerExample ()
{
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("ColorSequencerExample.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This example shows how to use the ColorSequencer prototype in an animated scenario. ColorSequencer outputs an individual SFColor without interpolation, in response to selecting an array value or simply sequencing next/previous."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("25 May 2003"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.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_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/Basic/development/BooleanSequencerExample.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ColorSequencerPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("color sequencer"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ColorSequencerExample.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("ColorSequencerExample.x3d"))
.addChild(new ExternProtoDeclare("ColorSequencer").setName("ColorSequencer").setAppinfo("ColorSequencer outputs a single color value by selecting an array index or simply sequencing next/previous").setUrl(new String[] {"../../../Savage/Tools/Animation/ColorSequencerPrototype.x3d#ColorSequencer","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ColorSequencerPrototype.x3d#ColorSequencer","../../../Savage/Tools/Animation/ColorSequencerPrototype.wrl#ColorSequencer","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/ColorSequencerPrototype.wrl#ColorSequencer"})
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Whether or not this sequencer is active"))
.addField(new field().setName("index").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Initial index is array element 0. Setting index past colors[max] uses final color value setting, while index less than 0 uses colors[0] value."))
.addField(new field().setName("colors").setType(field.TYPE_MFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Array of color values that are each the outputs of the sequencer. No interpolation occurs between values."))
.addField(new field().setName("color_changed").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("Current output color value of the sequencer corresponding to colors[index] value."))
.addField(new field().setName("previous").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Trigger previous color value. Wrap around from zeroth color to final color if necessary. Only respond to true inputs."))
.addField(new field().setName("next").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Trigger next color value. Wrap around from final color to zeroth color if necessary. Only respond to true inputs."))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Enable tracing of node operation on browser console"))
.addComments(" ")
.addComments(" "))
.addChild(new Viewpoint().setDescription("ColorSequencer demo"))
.addChild(new Background().setSkyAngle(new double[] {0.5,0.5,0.5}).setSkyColor(new MFColor(new double[] {0.5,0.5,0.5})))
.addChild(new ProtoInstance("ColorSequencer", "ColorSequencerInstance").setContainerField("children")
.addComments(" ROY G BIV = red orange yellow green blue indigo violet ")
.addFieldValue(new fieldValue().setName("colors").setValue(new MFColor(new MFColor(new double[] {1.0,0.0,0.0,1.0,0.5,0.0,1.0,1.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.2,0.2,0.2,0.4,0.0,0.4}))))
.addFieldValue(new fieldValue().setName("enabled").setValue(true))
.addFieldValue(new fieldValue().setName("index").setValue(2))
.addFieldValue(new fieldValue().setName("traceEnabled").setValue(true)))
.addChild(new Transform().setTranslation(0.0,1.5,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"ColorSequencer","Example"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(1.3)))
.setAppearance(new Appearance()
.setMaterial(new Material("MessageMaterial").setDiffuseColor(0.0,1.0,1.0))))
.addChild(new Transform().setTranslation(0.0,-0.25,0.0)
.addChild(new Shape()
.setGeometry(new Box().setSize(10.0,4.0,0.1))
.setAppearance(new Appearance()
.setMaterial(new Material("MessageBackgroundMaterial").setTransparency(0.8)))))
.addChild(new ROUTE().setFromNode("ColorSequencerInstance").setFromField("color_changed").setToNode("MessageMaterial").setToField("diffuseColor"))
.addChild(new ROUTE().setFromNode("ColorSequencerInstance").setFromField("color_changed").setToNode("MessageBackgroundMaterial").setToField("diffuseColor")))
.addChild(new Transform().setTranslation(-2.4,-2.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,0.0,0.0)))
.setGeometry(new Text().setString(new String[] {"previous"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setCssStyle("BOLD"))))
.addChild(new TouchSensor("TouchPrevious").setDescription("Select this text to see previous color"))
.addChild(new ROUTE().setFromNode("TouchPrevious").setFromField("isActive").setToNode("ColorSequencerInstance").setToField("previous"))
.addChild(new Shape()
.setGeometry(new Box().setSize(3.4,0.8,0.1))
.setAppearance(new Appearance("AppearanceTransparent")
.setMaterial(new Material().setTransparency(1)))))
.addChild(new Transform().setTranslation(0.8,-2.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,0.0)))
.setGeometry(new Text().setString(new String[] {"cycle"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE))))
.addChild(new Shape()
.setGeometry(new Box().setSize(2.0,0.8,0.1))
.setAppearance(new Appearance().setUSE("AppearanceTransparent")))
.addChild(new TouchSensor("TouchCycle").setDescription("Select this text to cycle through all colors")))
.addChild(new Transform().setTranslation(3.2,-2.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,1.0,0.0)))
.setGeometry(new Text().setString(new String[] {"next"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE))))
.addChild(new Shape()
.setGeometry(new Box().setSize(1.8,0.8,0.1))
.setAppearance(new Appearance().setUSE("AppearanceTransparent")))
.addChild(new TouchSensor("TouchNext").setDescription("Select this text to see next color"))
.addChild(new ROUTE().setFromNode("TouchNext").setFromField("isActive").setToNode("ColorSequencerInstance").setToField("next")))
.addComments(" cycle toggler logic ")
.addChild(new IntegerSequencer("Ticker").setKey(new double[] {0.0,0.125,0.25,0.375,0.5,0.625,0.75}).setKeyValue(new int[] {0,1,2,3,4,5,6}))
.addChild(new TimeSensor("Clock").setCycleInterval(8).setEnabled(false).setLoop(true))
.addChild(new BooleanToggle("Toggler"))
.addChild(new ROUTE().setFromNode("Ticker").setFromField("value_changed").setToNode("ColorSequencerInstance").setToField("index"))
.addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("Ticker").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("Toggler").setFromField("toggle_changed").setToNode("Clock").setToField("enabled"))
.addChild(new ROUTE().setFromNode("TouchCycle").setFromField("isActive").setToNode("Toggler").setToField("set_boolean"))
.addComments(" Ensure that next, previous selection events also turn off the color cycle ")
.addChild(new BooleanFilter("TogglerStop"))
.addChild(new ROUTE().setFromNode("TogglerStop").setFromField("inputFalse").setToNode("Toggler").setToField("toggle"))
.addChild(new ROUTE().setFromNode("TouchPrevious").setFromField("isActive").setToNode("TogglerStop").setToField("set_boolean"))
.addChild(new ROUTE().setFromNode("TouchNext").setFromField("isActive").setToNode("TogglerStop").setToField("set_boolean")));
}
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 ColorSequencerExample 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 ColorSequencerExample().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.ColorSequencerExample\" 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.ColorSequencerExample self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/ColorSequencerExample_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/ColorSequencerExample_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/ColorSequencerExample_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/ColorSequencerExample_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}