package Savage.Tools.Authoring;
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.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Contains examples for the prototypes defined in the FilterPrototypes.x3d.
Related links: Catalog page FilterExamples, source FilterExamples.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, James Harney, Jane Wu
*/
public class FilterExamples
{
/** Default constructor to create this object. */
public FilterExamples ()
{
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("FilterExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Contains examples for the prototypes defined in the FilterPrototypes.x3d"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman, James Harney, Jane Wu"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("18 December 2001"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("15 October 2023"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/FilterPrototypes.x3d"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("filter"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/FilterExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0, 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("FilterExamples.x3d"))
.addChild(new ExternProtoDeclare("FilterBooleanPassTrueEvents").setName("FilterBooleanPassTrueEvents").setUrl(new String[] {"FilterPrototypes.x3d#FilterBooleanPassTrueEvents","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/FilterPrototypes.x3d#FilterBooleanPassTrueEvents","FilterPrototypes.wrl#FilterBooleanPassTrueEvents","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/FilterPrototypes.wrl#FilterBooleanPassTrueEvents"})
.addField(new field().setName("setBoolean").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("trueEventOut").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("trueEventTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ExternProtoDeclare("FilterBooleanPassFalseEvents").setName("FilterBooleanPassFalseEvents").setUrl(new String[] {"FilterPrototypes.x3d#FilterBooleanPassFalseEvents","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/FilterPrototypes.x3d#FilterBooleanPassFalseEvents","FilterPrototypes.wrl#FilterBooleanPassFalseEvents","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/FilterPrototypes.wrl#FilterBooleanPassFalseEvents"})
.addField(new field().setName("setBoolean").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("falseEventOut").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("falseEventTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ExternProtoDeclare("SingleTypeConversion").setName("SingleTypeConversion").setAppinfo("SingleTypeConversion converts from a single typed value to various other types of values").setUrl(new String[] {"SingleTypeConversionPrototype.x3d#SingleTypeConversion","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/SingleTypeConversionPrototype.x3d#SingleTypeConversion","SingleTypeConversionPrototype.wrl#SingleTypeConversion","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/SingleTypeConversionPrototype.wrl#SingleTypeConversion"})
.addField(new field().setName("decimalPlaces").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("decimalPlaces is the number of significant digits after the decimal point, use -1 to indicate no round off"))
.addField(new field().setName("setDecimalPlaces").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("BooleanValue").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("FloatValue").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("IntegerValue").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("TimeValue").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("BooleanResult").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("FloatResult").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("IntegerResult").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("TimeResult").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("StringResult").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("StringsResult").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ExternProtoDeclare("SliderFloat").setName("SliderFloat").setAppinfo("Slider user-interface widget that produces floating-point output values").setUrl(new String[] {"../../../Savage/Tools/Animation/SliderFloatPrototype.x3d#SliderFloat","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/SliderFloatPrototype.x3d#SliderFloat","../../../Savage/Tools/Animation/SliderFloatPrototype.wrl#SliderFloat","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/SliderFloatPrototype.wrl#SliderFloat"})
.addField(new field().setName("layoutDirection").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Allowed values: vertical, horizontal"))
.addField(new field().setName("height").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value 1.0"))
.addField(new field().setName("radius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value 0.1"))
.addField(new field().setName("barRadius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value 0.02"))
.addField(new field().setName("sliderBarColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value .8 .4 .8"))
.addField(new field().setName("sliderBallColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value .3 .4 .8"))
.addField(new field().setName("sliderEndColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value .2 .3 .9"))
.addField(new field().setName("min").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value 0.0"))
.addField(new field().setName("max").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value 10.0"))
.addField(new field().setName("value").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("default value 0.0"))
.addField(new field().setName("setMin").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("set minimum value for slider bar"))
.addField(new field().setName("setMax").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("set maximum value for slider bar"))
.addField(new field().setName("setValue").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("set value for slider bar"))
.addField(new field().setName("valueChanged").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("output value for slider bar"))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("enable/disable console output for troubleshooting")))
.addChild(new Viewpoint().setDescription("Filter Examples").setPosition(0.0,0.0,15.0))
.addChild(new Billboard().setAxisOfRotation(0.0,0.0,0.0)
.addChild(new Transform().setTranslation(0.0,4.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,1.0,1.0)))
.setGeometry(new Text().setString(new String[] {"FilterBooleanPassTrueEvents","FilterBooleanPassFalseEvents:","","drag slider to test examples"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.8)))))
.addChild(new Transform().setTranslation(0.0,1.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text().setString(new String[] {"BooleanSequencer:","key {0 0.25 0.5 0.75 1} keyValue {0 1 0 1 0}"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.6))))
.addChild(new BooleanSequencer("BooleanGenerator").setKey(new double[] {0.0,0.25,0.5,0.75,1.0}).setKeyValue(new boolean[] {false,true,false,true,false})))
.addChild(new Transform().setTranslation(-4.0,-1.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text().setString(new String[] {"Fraction:"})
.setFontStyle(new FontStyle().setSize(0.6))))
.addChild(new Transform().setTranslation(3.0,0.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text("BooleanFractionText").setString(new String[] {"N/A"})
.setFontStyle(new FontStyle().setSize(0.6)))))
.addChild(new Transform().setTranslation(6.0,0.15,0.0)
.addChild(new ProtoInstance("SliderFloat", "Slider").setContainerField("children")
.addFieldValue(new fieldValue().setName("layoutDirection").setValue("horizontal"))
.addFieldValue(new fieldValue().setName("min").setValue(0))
.addFieldValue(new fieldValue().setName("max").setValue(1))
.addFieldValue(new fieldValue().setName("height").setValue(4)))
.addChild(new ROUTE().setFromNode("Slider").setFromField("valueChanged").setToNode("BooleanGenerator").setToField("set_fraction")))
.addChild(new ProtoInstance("SingleTypeConversion", "BooleanFractionRoundOff").setContainerField("children")
.addFieldValue(new fieldValue().setName("decimalPlaces").setValue(2)))
.addChild(new ROUTE().setFromNode("Slider").setFromField("valueChanged").setToNode("BooleanFractionRoundOff").setToField("FloatValue"))
.addChild(new ROUTE().setFromNode("BooleanFractionRoundOff").setFromField("StringsResult").setToNode("BooleanFractionText").setToField("set_string")))
.addChild(new Transform().setTranslation(-5.0,-3.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text().setString(new String[] {"PassTrueEvents:"})
.setFontStyle(new FontStyle().setSize(0.6))))
.addChild(new Transform().setTranslation(3.85,0.15,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material("TrueLightMaterial").setDiffuseColor(0.45,0.45,0.45).setEmissiveColor(0.45,0.45,0.45)))
.setGeometry(new Sphere().setRadius(0.2)))
.addChild(new Script("TrueScript").setSourceCode("""
ecmascript:
var r, g, b;
function initialize()
{
r = 0;
g = 0;
b = 0;
}
function setTrue(value, timeStamp)
{
if ( r >= 0.5)
r = 0.25;
else
r = r + 0.25;
if ( b >= 0.5)
b = 0.25;
else
b = b + 0.25;
colorChanged = new SFColor(r, g, b);
}
""")
.addField(new field().setName("setTrue").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("colorChanged").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ProtoInstance("FilterBooleanPassTrueEvents", "TrueEventFilter").setContainerField("children"))
.addChild(new ROUTE().setFromNode("BooleanGenerator").setFromField("value_changed").setToNode("TrueEventFilter").setToField("setBoolean"))
.addChild(new ROUTE().setFromNode("TrueEventFilter").setFromField("trueEventOut").setToNode("TrueScript").setToField("setTrue"))
.addChild(new ROUTE().setFromNode("TrueScript").setFromField("colorChanged").setToNode("TrueLightMaterial").setToField("diffuseColor"))
.addChild(new ROUTE().setFromNode("TrueScript").setFromField("colorChanged").setToNode("TrueLightMaterial").setToField("emissiveColor"))))
.addChild(new Transform().setTranslation(0.0,-3.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text().setString(new String[] {"PassFalseEvents:"})
.setFontStyle(new FontStyle().setSize(0.6))))
.addChild(new Transform().setTranslation(4.0,0.15,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material("FalseLightMaterial").setDiffuseColor(0.45,0.45,0.45).setEmissiveColor(0.45,0.45,0.45)))
.setGeometry(new Sphere().setRadius(0.2)))
.addChild(new Script("FalseScript").setSourceCode("""
ecmascript:
var r, g, b;
function initialize()
{
r = 0;
g = 0;
b = 0;
}
function setFalse(value, timeStamp)
{
if ( g >= 0.5)
g = 0.25;
else
g = r + 0.25;
if ( b >= 0.5)
b = 0.25;
else
b = b + 0.25;
colorChanged = new SFColor(r, g, b);
}
""")
.addField(new field().setName("setFalse").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("colorChanged").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ProtoInstance("FilterBooleanPassFalseEvents", "FalseEventFilter").setContainerField("children"))
.addChild(new ROUTE().setFromNode("BooleanGenerator").setFromField("value_changed").setToNode("FalseEventFilter").setToField("setBoolean"))
.addChild(new ROUTE().setFromNode("FalseEventFilter").setFromField("falseEventOut").setToNode("FalseScript").setToField("setFalse"))
.addChild(new ROUTE().setFromNode("FalseScript").setFromField("colorChanged").setToNode("FalseLightMaterial").setToField("diffuseColor"))
.addChild(new ROUTE().setFromNode("FalseScript").setFromField("colorChanged").setToNode("FalseLightMaterial").setToField("emissiveColor"))))));
}
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 FilterExamples 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 FilterExamples().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.FilterExamples\" 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.FilterExamples self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Authoring/FilterExamples_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Authoring/FilterExamples_JavaExport.x3d";
String filenameX3DV = "Tools/Authoring/FilterExamples_JavaExport.x3dv";
String filenameJSON = "Tools/Authoring/FilterExamples_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}