package X3dForWebAuthors.Chapter14Prototypes;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Provide example for expansion of a MaterialModulator as regular X3D nodes, rather than a ProtoDeclare/ProtoInstance combination. MaterialModulator mimics a Material node and modulates diffuseColor field as an animation effect.
Related links: Catalog page MaterialModulatorPrototypeExpanded, source MaterialModulatorPrototypeExpanded.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, John Carlson, Roy Walmsley
*/
public class MaterialModulatorPrototypeExpanded
{
/** Default constructor to create this object. */
public MaterialModulatorPrototypeExpanded ()
{
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("MaterialModulatorPrototypeExpanded.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Provide example for expansion of a MaterialModulator as regular X3D nodes, rather than a ProtoDeclare/ProtoInstance combination. MaterialModulator mimics a Material node and modulates diffuseColor field as an animation effect."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman, John Carlson, Roy Walmsley"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("2 July 2016"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("X3D prototype expander, IS/connect, Script inputOutput field"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("MaterialModulator.png"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("MaterialModulator.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("JSON prototype expander https://github.com/coderextreme/X3DJSONLD"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("Create corresponding web page describing Prototype Expander design."))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("Create stylesheet converter matching this Prototype Expander design pattern."))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("Add external ROUTEs to original example as a further test case for Prototype Expander design."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://github.com/coderextreme/X3DJSONLD/blob/master/PrototypeExpander.js"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://github.com/coderextreme/X3DJSONLD/blob/master/ServerPrototypeExpander.js"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("X3D Tooltips: ProtoBody https://www.web3d.org/x3d/content/X3dTooltips.html#ProtoBody"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("4.4.4.3 PROTO definition semantics https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("[x3d-public] Prototype Expander, Question on design of instance expansions: http://web3d.org/pipermail/x3d-public_web3d.org/2016-July/004982.html"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulatorPrototypeExpanded.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("MaterialModulatorPrototypeExpanded.x3d"))
.addChild(new Shape()
.setGeometry(new Sphere())
.setAppearance(new Appearance()
.addComments(" Prototype Expander design note: only first node (the node type) of the prototype is substituted here. ")
.setMaterial(new Material("MaterialModulatorNodeExpanded1").setDiffuseColor(0.5,0.1,0.1)
.addComments(" Prototype Expander design note: no children nodes found in originally defined initial ProtoBody node, so no contained child nodes appear here "))))
.addComments(" Prototype Expander design note: only first node (the node type) of the prototype is renderable above. when Switch is first allowed ")
.addChild(new Switch("HideAdditionalPrototypeBodyNodesExpanded1").setWhichChoice(-1)
.addComments(" Prototype Expander design note: all children inside a Switch continue to receive/send events. ")
.addChild(new Group()
.addComments(" Prototype Expander design note: additional follow-on nodes from the original ProtoBody are placed here. ")
.addChild(new Script("MaterialModulatorScriptExpanded1").setSourceCode("""
ecmascript:
function initialize ()
{
newColor = diffuseColor; // start with correct 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);
Browser.println ('diffuseColor=(' + red +',' + green + ',' + blue + ') newColor=' + newColor.toString());
}
""")
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true))
.addField(new field().setName("diffuseColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.5,0.1,0.1)))
.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)))
.addComments(" Clock tickles Script to wake up and compute a new value ")
.addChild(new ROUTE().setFromNode("MaterialModulatorScriptExpanded1").setFromField("newColor").setToNode("MaterialModulatorNodeExpanded1").setToField("diffuseColor"))
.addChild(new TimeSensor("ModulationClockExpanded1").setCycleInterval(0.1).setLoop(true))
.addChild(new ROUTE().setFromNode("ModulationClockExpanded1").setFromField("cycleTime").setToNode("MaterialModulatorScriptExpanded1").setToField("clockTrigger")))));
}
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 MaterialModulatorPrototypeExpanded 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 MaterialModulatorPrototypeExpanded().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.MaterialModulatorPrototypeExpanded\" 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.MaterialModulatorPrototypeExpanded self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter14Prototypes/MaterialModulatorPrototypeExpanded_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter14Prototypes/MaterialModulatorPrototypeExpanded_JavaExport.x3d";
String filenameX3DV = "Chapter14Prototypes/MaterialModulatorPrototypeExpanded_JavaExport.x3dv";
String filenameJSON = "Chapter14Prototypes/MaterialModulatorPrototypeExpanded_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}
