package X3dForAdvancedModeling.Animation;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
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.
/**
* <p> Illustrate how USE nodes implement copy by reference, resulting in immediate changes when original DEF node is modified. A single MasterMaterial node is animated, and changes in the parent MasterAppearance are reflected throughout the scene graph. </p>
<p> Related links: Catalog page <a href="../../../Animation/DEF_USE_AnimationExampleIndex.html" target="_blank">DEF_USE_AnimationExample</a>, source <a href="../../../Animation/DEF_USE_AnimationExample.java">DEF_USE_AnimationExample.java</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dResources.html" target="_blank">X3D Resources</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html" target="_blank">X3D Scene Authoring Hints</a>, and <a href="https://www.web3d.org/x3d/content/X3dTooltips.html" target="_blank">X3D Tooltips</a>. </p>
<table style="color:black; border:0px solid; border-spacing:10px 0px;">
<caption>Scene Meta Information</caption>
<tr style="background-color:silver; border-color:silver;">
<td style="text-align:center; padding:10px 0px;"><i>meta tags</i></td>
<td style="text-align:left; padding:10px 0px;"> Document Metadata </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> title </i> </td>
<td> <a href="../../../Animation/DEF_USE_AnimationExample.x3d">DEF_USE_AnimationExample.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
<td> Illustrate how USE nodes implement copy by reference, resulting in immediate changes when original DEF node is modified. A single MasterMaterial node is animated, and changes in the parent MasterAppearance are reflected throughout the scene graph. </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
<td> Don Brutzman </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
<td> 1 September 2024 </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> Image </i> </td>
<td> <a href="../../../Animation/DEF_USE_AnimationExampleScreenshot.png">DEF_USE_AnimationExampleScreenshot.png</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> TODO </i> </td>
<td> X3D Specification Mantis Issue <a href="https://www.web3d.org/member-only/mantis/view.php?id=690" target="_blank">https://www.web3d.org/member-only/mantis/view.php?id=690</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
<td> Wikipedia: Evaluation strategy, pass by sharing <a href="https://en.wikipedia.org/wiki/Evaluation_strategy#Call_by_sharing" target="_blank">https://en.wikipedia.org/wiki/Evaluation_strategy#Call_by_sharing</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> specificationSection </i> </td>
<td> X3D 4.0 Architecture, ISO/IEC 19775-1:2023, clause 4 Concepts, 4.4.3 DEF/USE semantics </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> specificationUrl </i> </td>
<td> <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof/Part01/concepts.html#DEF_USE_Semantics" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof/Part01/concepts.html#DEF_USE_Semantics</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
<td> <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02GeometryPrimitives/GeometryPrimitiveNodes.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02GeometryPrimitives/GeometryPrimitiveNodes.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> identifier </i> </td>
<td> <a href="https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/DEF_USE_AnimationExample.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/DEF_USE_AnimationExample.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
<td> Altova XMLSpy <a href="https://www.altova.com/xmlspy-xml-editor" target="_blank">https://www.altova.com/xmlspy-xml-editor</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
<td> XMLSpyPrettyPrintSpacingTextViewSettings.png </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
<td> X3D-Edit 4.0 <a href="https://savage.nps.edu/X3D-Edit" target="_blank">https://savage.nps.edu/X3D-Edit</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
<td> <a href="../../../Animation/../license.html">../license.html</a> </td>
</tr>
<tr style="background-color:silver; border-color:silver;">
<td style="text-align:center;" colspan="2"> </td>
</tr>
</table>
<p>
This program uses the
<a href="https://www.web3d.org/specifications/java/X3DJSAIL.html" target="_blank">X3D Java Scene Access Interface Library (X3DJSAIL)</a>.
It has been produced using the
<a href="https://www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">X3dToJava.xslt</a>
stylesheet
(<a href="https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">version control</a>)
which is used to create Java source code from an original <code>.x3d</code> model.
</p>
* @author Don Brutzman
*/
public class DEF_USE_AnimationExample
{
/** Default constructor to create this object. */
public DEF_USE_AnimationExample ()
{
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("DEF_USE_AnimationExample.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Illustrate how USE nodes implement copy by reference, resulting in immediate changes when original DEF node is modified. A single MasterMaterial node is animated, and changes in the parent MasterAppearance are reflected throughout the scene graph."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("1 September 2024"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("DEF_USE_AnimationExampleScreenshot.png"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("X3D Specification Mantis Issue https://www.web3d.org/member-only/mantis/view.php?id=690"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("Wikipedia: Evaluation strategy, pass by sharing https://en.wikipedia.org/wiki/Evaluation_strategy#Call_by_sharing"))
.addMeta(new meta().setName(meta.NAME_SPECIFICATIONSECTION).setContent("X3D 4.0 Architecture, ISO/IEC 19775-1:2023, clause 4 Concepts, 4.4.3 DEF/USE semantics"))
.addMeta(new meta().setName(meta.NAME_SPECIFICATIONURL).setContent("https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof/Part01/concepts.html#DEF_USE_Semantics"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02GeometryPrimitives/GeometryPrimitiveNodes.x3d"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/DEF_USE_AnimationExample.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("Altova XMLSpy https://www.altova.com/xmlspy-xml-editor"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("XMLSpyPrettyPrintSpacingTextViewSettings.png"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0 https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("DEF_USE_AnimationExample.x3d"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.6,0.8,0.8})))
.addChild(new Viewpoint("EntryView").setDescription("DEF - USE Animation Example").setPosition(0.0,0.0,13.0))
.addComments(" Selectable Text design pattern has transparent Box and TouchSensor description as a tooltip ")
.addChild(new TouchSensor("TopLevelTouchSensor").setDescription("select and hold to run animation"))
.addChild(new Group()
.addChild(new Shape("TransparentSelectableBox")
.setGeometry(new Box().setSize(16.0,8.0,.001))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1))))
.addChild(new Transform("HighererRowTransform").setTranslation(0.0,1.5,0.0)
.addChild(new Transform().setTranslation(-5.0,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Box("DefaultBox"))
.setAppearance(new Appearance("MasterAppearance")
.setMaterial(new Material("MasterMaterial").setDiffuseColor(0.4,0.4,0.4))))
.addChild(new Transform().setTranslation(0.0,1.6,0.0)
.addChild(new Shape("SmallDEFText")
.setGeometry(new Text().setString(new String[] {"DEF"})
.setFontStyle(new FontStyle("SmallFontStyle").setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.5)))
.setAppearance(new Appearance("TextAppearance")
.setMaterial(new Material().setDiffuseColor(1.0,1.0,1.0))))))
.addChild(new Transform().setTranslation(-2.5,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Cone("DefaultCone"))
.setAppearance(new Appearance().setUSE("MasterAppearance")))
.addChild(new Transform().setTranslation(0.0,1.6,0.0)
.addChild(new Shape("SmallUSEText")
.setGeometry(new Text().setString(new String[] {"USE"})
.setFontStyle(new FontStyle().setUSE("SmallFontStyle")))
.setAppearance(new Appearance().setUSE("TextAppearance")))))
.addChild(new Transform()
.addChild(new Shape()
.setGeometry(new Cylinder("DefaultCylinder"))
.setAppearance(new Appearance().setUSE("MasterAppearance")))
.addChild(new Transform().setTranslation(0.0,1.6,0.0)
.addChild(new Shape().setUSE("SmallUSEText"))))
.addChild(new Transform().setTranslation(2.5,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Sphere("DefaultSphere"))
.setAppearance(new Appearance().setUSE("MasterAppearance")))
.addChild(new Transform().setTranslation(0.0,1.6,0.0)
.addChild(new Shape().setUSE("SmallUSEText"))))
.addChild(new Transform().setTranslation(4.0,0.0,0.0)
.addChild(new Shape()
.setGeometry(new Text("DefaultText").setString(new String[] {"hello","X3D!"})
.setFontStyle(new FontStyle("DefaultFontStyle")))
.setAppearance(new Appearance().setUSE("MasterAppearance")))
.addChild(new Transform().setTranslation(1.2,1.6,0.0)
.addChild(new Shape().setUSE("SmallUSEText")))))
.addChild(new TimeSensor("Clock").setCycleInterval(8).setEnabled(false).setLoop(true))
.addChild(new ColorInterpolator("ColorChanger").setKey(new double[] {0.0,0.5,0.5,0.75,1.0}).setKeyValue(new MFColor(new double[] {1.0,1.0,1.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,1.0,1.0,1.0})))
.addChild(new ROUTE().setFromNode("TopLevelTouchSensor").setFromField("isActive").setToNode("Clock").setToField("enabled"))
.addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("ColorChanger").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("ColorChanger").setFromField("value_changed").setToNode("MasterMaterial").setToField("diffuseColor"))
.addChild(new Transform("LowerRowTransform").setTranslation(0.0,-2.0,0.0)
.addChild(new Shape()
.setGeometry(new Text("UserMessage").setString(new String[] {"ColorInterpolator modifies one Material","in a single DEF=MasterAppearance node,","other USE nodes apply those values.","","To animate, select and hold","using your pointing device."})
.setFontStyle(new FontStyle("MessageFontStyle").setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.6).setCssStyle("BOLD")))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,1.0)))))));
}
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
* <a href="https://dzone.com/articles/java-copy-shallow-vs-deep-in-which-you-will-swim" target="_blank">shallow copy</a>
* of the X3D model.
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html">X3D</a>
* @return DEF_USE_AnimationExample 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 <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#handleArguments-java.lang.String:A-">X3D.handleArguments(args)</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#validationReport--">X3D.validationReport()</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html">CommandLine</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html#USAGE">CommandLine.USAGE</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/ConfigurationProperties.html">ConfigurationProperties</a>
*/
public static void main(String args[])
{
System.out.println("Build this X3D model, showing validation diagnostics...");
X3D thisExampleX3dModel = new DEF_USE_AnimationExample().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: \"X3dForAdvancedModeling.Animation.DEF_USE_AnimationExample\" 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("X3dForAdvancedModeling.Animation.DEF_USE_AnimationExample self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Animation/DEF_USE_AnimationExample_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Animation/DEF_USE_AnimationExample_JavaExport.x3d";
String filenameX3DV = "Animation/DEF_USE_AnimationExample_JavaExport.x3dv";
String filenameJSON = "Animation/DEF_USE_AnimationExample_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}