package Savage.Tools.Animation;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Networking.*;
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.
/**
* Prototype definition for toggle-able Material node that can switch between 2 sets of material values, selectable at run time. This prototype also demonstrates why it is important that only the first node in a ProtoBody can render: so that it can serve as a special node type (such as Material).
Related links: Catalog page MaterialTogglePrototype, source MaterialTogglePrototype.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 and MV4205 class
*/
public class MaterialTogglePrototype
{
/** Default constructor to create this object. */
public MaterialTogglePrototype ()
{
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("MaterialTogglePrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Prototype definition for toggle-able Material node that can switch between 2 sets of material values, selectable at run time. This prototype also demonstrates why it is important that only the first node in a ProtoBody can render: so that it can serve as a special node type (such as Material)."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman and MV4205 class"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("29 April 2004"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("MaterialToggleExample.x3d"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/MaterialTogglePrototype.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("MaterialTogglePrototype.x3d"))
.addChild(new ProtoDeclare("MaterialToggle").setName("MaterialToggle").setAppinfo("MaterialToggle selects one of two different Material values")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("set_toggle").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("toggle").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false).setAppinfo("whether to use DefaultMaterial or ToggleMaterial"))
.addField(new field().setName("toggle_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("defaultMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Material node that is enabled when toggle=false")
.addComments(" no default initialization node since it crashes Xj3D "))
.addField(new field().setName("toggleMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Material node that is enabled when toggle=true")
.addComments(" no default initialization node since it crashes Xj3D "))
.addField(new field().setName("set_defaultMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("provide replacement default Material node"))
.addField(new field().setName("set_toggleMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("provide replacement toggle Material node")))
.setProtoBody(new ProtoBody()
.addComments(" first node is node type for this prototype, other nodes are active but do not render ")
.addChild(new Material("ViewedMaterialNode"))
.addChild(new Script("MaterialAnimationScript").setDirectOutput(true).setSourceCode("""
ecmascript:
function initialize ()
{
tracePrint ('initialize() begin...');
if (defaultMaterial != null)
{
tracePrint ('defaultMaterial.diffuseColor=' + defaultMaterial.diffuseColor.toString());
viewedMaterial.diffuseColor = defaultMaterial.diffuseColor;
viewedMaterial.emissiveColor = defaultMaterial.emissiveColor;
viewedMaterial.specularColor = defaultMaterial.specularColor;
viewedMaterial.shininess = defaultMaterial.shininess;
viewedMaterial.ambientIntensity = defaultMaterial.ambientIntensity;
viewedMaterial.transparency = defaultMaterial.transparency;
tracePrint ('toggleMaterial.diffuseColor=' + toggleMaterial.diffuseColor.toString());
}
else alwaysPrint ('warning: no initialization Material node provided for defaultMaterial');
if (toggleMaterial == null)
alwaysPrint ('warning: no initialization Material node provided for toggleMaterial');
tracePrint ('initialize() complete');
}
function set_toggle (value, timestamp)
{
if ((value == true) && (toggleMaterial != null))
{
tracePrint ('set_toggle true, toggleMaterial.diffuseColor=' + toggleMaterial.diffuseColor.toString());
viewedMaterial.diffuseColor = toggleMaterial.diffuseColor;
viewedMaterial.emissiveColor = toggleMaterial.emissiveColor;
viewedMaterial.specularColor = toggleMaterial.specularColor;
viewedMaterial.shininess = toggleMaterial.shininess;
viewedMaterial.ambientIntensity = toggleMaterial.ambientIntensity;
viewedMaterial.transparency = toggleMaterial.transparency;
}
else if (defaultMaterial != null)
{
tracePrint ('set_toggle false, defaultMaterial.diffuseColor=' + defaultMaterial.diffuseColor.toString());
viewedMaterial.diffuseColor = defaultMaterial.diffuseColor;
viewedMaterial.emissiveColor = defaultMaterial.emissiveColor;
viewedMaterial.specularColor = defaultMaterial.specularColor;
viewedMaterial.shininess = defaultMaterial.shininess;
viewedMaterial.ambientIntensity = defaultMaterial.ambientIntensity;
viewedMaterial.transparency = defaultMaterial.transparency;
}
toggle = value; // remember state
toggle_changed = value; // chain input boolean event to output event
tracePrint ('set_toggle(' + value + ') complete');
}
function set_defaultMaterial(newMaterial)
{
defaultMaterial = newMaterial;
tracePrint('set_defaultMaterial = ' + newMaterial);
}
function set_toggleMaterial(newMaterial)
{
toggleMaterial = newMaterial;
tracePrint('set_toggleMaterial = ' + newMaterial);
}
function tracePrint(outputString)
{
if (traceEnabled) Browser.println ('[MaterialToggle] ' + outputString);
}
function alwaysPrint(outputString)
{
Browser.println ('[MaterialToggle] ' + outputString);
}
""")
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.addField(new field().setName("set_toggle").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("toggle").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("whether to use DefaultMaterial or ToggleMaterial"))
.addField(new field().setName("toggle_changed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("defaultMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("toggleMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("set_defaultMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("provide replacement Material node"))
.addField(new field().setName("set_toggleMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("provide replacement Material node"))
.addField(new field().setName("viewedMaterial").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new Material().setUSE("ViewedMaterialNode")))
.setIS(new IS()
.addConnect(new connect().setNodeField("set_toggle").setProtoField("set_toggle"))
.addConnect(new connect().setNodeField("toggle").setProtoField("toggle"))
.addConnect(new connect().setNodeField("toggle_changed").setProtoField("toggle_changed"))
.addConnect(new connect().setNodeField("defaultMaterial").setProtoField("defaultMaterial"))
.addConnect(new connect().setNodeField("toggleMaterial").setProtoField("toggleMaterial"))
.addConnect(new connect().setNodeField("set_defaultMaterial").setProtoField("set_defaultMaterial"))
.addConnect(new connect().setNodeField("set_toggleMaterial").setProtoField("set_toggleMaterial"))))))
.addComments(" ==================== ")
.addChild(new Anchor().setDescription("MaterialToggleExample").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"MaterialToggleExample.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/MaterialToggleExample.x3d","MaterialToggleExample.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Animation/MaterialToggleExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"MaterialTogglePrototype","defines a prototype","","Click text to see example scene","MaterialToggleExample"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.9)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,0.2))))));
}
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 MaterialTogglePrototype 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 MaterialTogglePrototype().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.MaterialTogglePrototype\" 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.MaterialTogglePrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/Animation/MaterialTogglePrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/Animation/MaterialTogglePrototype_JavaExport.x3d";
String filenameX3DV = "Tools/Animation/MaterialTogglePrototype_JavaExport.x3dv";
String filenameJSON = "Tools/Animation/MaterialTogglePrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}