package X3dForWebAuthors.Chapter14Prototypes;
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.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.
/**
* Mimic a Material node and modulate the diffuseColor field as an animation effect, provided as a prototype for reusability.
Related links: Catalog page MaterialModulator, source MaterialModulator.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 MaterialModulator
{
/** Default constructor to create this object. */
public MaterialModulator ()
{
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("MaterialModulator.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Mimic a Material node and modulate the diffuseColor field as an animation effect, provided as a prototype for reusability."))
.addMeta(new meta().setName(meta.NAME_HINT ).setContent("Learning suggestion for authors: try changing the modulation script so that it goes from [0 ... 1] and then [1 ... 0] alternating, rather than abruptly shifting from 1 immediately back to 0."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("10 March 2008"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("X3D prototype requiring Script inputOutput fields"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("MaterialModulator.png"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulator.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("MaterialModulator.x3d"))
.addChild(new ProtoDeclare("MaterialModulator").setName("MaterialModulator").setAppinfo("mimic a Material node and modulate the diffuseColor field as an animation effect").setDocumentation("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulatorIndex.html")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true).setAppinfo("default value true"))
.addField(new field().setName("diffuseColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.8,0.8,0.8)).setAppinfo("default value 0.8 0.8 0.8"))
.addField(new field().setName("emissiveColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.0,0.0,0.0)).setAppinfo("default value 0 0 0"))
.addField(new field().setName("specularColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.0,0.0,0.0)).setAppinfo("default value 0 0 0"))
.addField(new field().setName("transparency").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0.0).setAppinfo("default value 0.0"))
.addField(new field().setName("shininess").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0.2).setAppinfo("default value 0.2"))
.addField(new field().setName("ambientIntensity").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(0.2).setAppinfo("default value 0.2")))
.setProtoBody(new ProtoBody()
.addChild(new Material("MaterialNode")
.setIS(new IS()
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("diffuseColor"))
.addConnect(new connect().setNodeField("emissiveColor").setProtoField("emissiveColor"))
.addConnect(new connect().setNodeField("specularColor").setProtoField("specularColor"))
.addConnect(new connect().setNodeField("transparency").setProtoField("transparency"))
.addConnect(new connect().setNodeField("shininess").setProtoField("shininess"))
.addConnect(new connect().setNodeField("ambientIntensity").setProtoField("ambientIntensity"))))
.addComments(" Only first node (the node type) is renderable, others are along for the ride ")
.addChild(new Script("MaterialModulatorScript").setSourceCode("""
ecmascript:
function initialize ()
{
newColor = diffuseColor; // start with original color
}
function clockTrigger (timeValue)
{
if (!enabled) return;
red = newColor.r;
green = newColor.g;
blue = newColor.b;
// note different modulation rates for each color component, % is modulus operator
newColor = new SFColor ((red + 0.02) % 1, (green + 0.03) % 1, (blue + 0.04) % 1);
if (enabled)
{
Browser.println ('diffuseColor=(' + red +',' + green + ',' + blue + ') newColor=' + newColor.toString());
}
}
function set_enabled (newValue)
{
enabled = newValue;
}
""")
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("diffuseColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("newColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("clockTrigger").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("diffuseColor"))))
.addComments(" Clock tickles Script to wake up and compute a new value ")
.addChild(new ROUTE().setFromNode("MaterialModulatorScript").setFromField("newColor").setToNode("MaterialNode").setToField("diffuseColor"))
.addChild(new TimeSensor("ModulationClock").setCycleInterval(0.1).setLoop(true)
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("enabled"))))
.addChild(new ROUTE().setFromNode("ModulationClock").setFromField("cycleTime").setToNode("MaterialModulatorScript").setToField("clockTrigger"))))
.addComments(" Rendered geometry for the ProtoInstance now follows prototype declaration ")
.addChild(new Transform().setTranslation(0.0,1.0,0.0)
.addChild(new Shape()
.setGeometry(new Sphere())
.setAppearance(new Appearance()
.setMaterial(new ProtoInstance("MaterialModulator", "MaterialModulatorInstance").setContainerField("material")
.addFieldValue(new fieldValue().setName("enabled").setValue(true))
.addFieldValue(new fieldValue().setName("diffuseColor").setValue(new SFColor(0.5,0.1,0.1)))
.addComments(" fieldValue declarations for other Material attributes can appear here ")))))
.addComments(" Selectable Text design pattern has transparent Box and TouchSensor description as a tooltip ")
.addChild(new Transform().setTranslation(0.0,-2.0,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"enable/disable","MaterialModulator"})
.setFontStyle(new FontStyle().setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setCssStyle("BOLD")))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.9,0.9,0.9))))
.addChild(new Shape()
.setGeometry(new Box().setSize(8.0,2.0,.001))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1))))
.addComments(" Toggle text to enable/disable MaterialModulator ")
.addChild(new TouchSensor("TouchTextInterface").setDescription("Select to enable/disable MaterialModulator"))
.addChild(new BooleanToggle("EventToggler"))
.addChild(new ROUTE().setFromNode("TouchTextInterface").setFromField("isActive").setToNode("EventToggler").setToField("set_boolean"))
.addChild(new ROUTE().setFromNode("EventToggler").setFromField("toggle").setToNode("MaterialModulatorInstance").setToField("enabled"))));
}
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 MaterialModulator 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 MaterialModulator().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: \"X3dForWebAuthors.Chapter14Prototypes.MaterialModulator\" 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("X3dForWebAuthors.Chapter14Prototypes.MaterialModulator self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter14Prototypes/MaterialModulator_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter14Prototypes/MaterialModulator_JavaExport.x3d";
String filenameX3DV = "Chapter14Prototypes/MaterialModulator_JavaExport.x3dv";
String filenameJSON = "Chapter14Prototypes/MaterialModulator_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}
