package X3dForWebAuthors.Chapter14Prototypes;
/*
Copyright (c) 1995-2022 held by the author(s). All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of the Web3D Consortium (https://www.web3d.org)
nor the names of its contributors may be used to endorse or
promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
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.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc annotations follow, see below for Java source code.
/**
* Demonstrate multiple instances of an external prototype.
Related links: MaterialModulatorExamples.java source, MaterialModulatorExamples catalog page, 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 to create Java source code from an .x3d model.
* @author Don Brutzman
*/
public class MaterialModulatorExamples
{
/** Default constructor to create this object. */
public MaterialModulatorExamples ()
{
initialize();
}
/** Create and initialize the X3D model for this object. */
public final void initialize()
{
x3dModel = new X3D().setProfile(X3D.PROFILE_IMMERSIVE).setVersion(X3D.VERSION_3_3)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("MaterialModulatorExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Demonstrate multiple instances of an external prototype."))
.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("7 September 2017"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("X3D prototype instances DEF USE"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("MaterialModulator.png"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("MaterialModulatorExamples.png"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://X3dGraphics.com/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulatorExamples.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("MaterialModulatorExamples.x3d"))
.addChild(new ExternProtoDeclare("MaterialModulator").setName("MaterialModulator").setAppinfo("mimic a Material node and modulate the diffuseColor field as an animation effect").setDocumentation("https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulatorIndex.html").setUrl(new String[] {"MaterialModulator.x3d#MaterialModulator","https://X3dGraphics.com/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulator.x3d#MaterialModulator"})
.addField(new field().setName("enabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("default value true"))
.addField(new field().setName("diffuseColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("default value 0.8 0.8 0.8"))
.addField(new field().setName("emissiveColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("default value 0 0 0"))
.addField(new field().setName("specularColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("default value 0 0 0"))
.addField(new field().setName("transparency").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("default value 0.0"))
.addField(new field().setName("shininess").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("default value 0.2"))
.addField(new field().setName("ambientIntensity").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("default value 0.2")))
.addComments(" Rendered geometry for the ProtoInstance now follows external prototype declaration ")
.addChild(new Transform().setRotation(-0.8,0.93923,0.18785,5.759586).setTranslation(-2.0,1.0,0.0)
.addChild(new Shape("ModulatingBoxShape")
.setGeometry(new Box())
.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 ")))))
.addChild(new Transform().setRotation(1.0,0.0,0.0,0.523599).setTranslation(2.0,1.0,0.0)
.addChild(new Shape()
.setGeometry(new Cylinder())
.setAppearance(new Appearance()
.addComments(" note that ProtoInstance USE does not require name='MaterialModulator' ")
.setMaterial(new ProtoInstance().setUSE("MaterialModulatorInstance").setContainerField("material")))))
.addChild(new Transform().setTranslation(-2.0,3.5,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"DEF original"})
.setFontStyle(new FontStyle().setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.5).setCssStyle("BOLD")))
.setAppearance(new Appearance("TextAppearance")
.setMaterial(new Material().setDiffuseColor(0.9,0.9,0.9)))))
.addChild(new Transform().setTranslation(2.0,3.5,0.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"USE copy"})
.setFontStyle(new FontStyle().setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.5).setCssStyle("BOLD")))
.setAppearance(new Appearance().setUSE("TextAppearance"))))
.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().setUSE("TextAppearance")))
.addComments(" Selectable Text design pattern has transparent Box and TouchSensor description as a tooltip ")
.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 text 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"))));
}
// 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 MaterialModulatorExamples 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[])
{
X3D thisExampleX3dModel = new MaterialModulatorExamples().getX3dModel();
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.MaterialModulatorExamples\" 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.print("Java program \"X3dForWebAuthors.Chapter14Prototypes.MaterialModulatorExamples\" self-validation test results: ");
String validationResults = thisExampleX3dModel.validationReport();
if (validationResults.startsWith("\n"))
System.out.println();
System.out.println(validationResults.trim());
}
}
}
