package X3dForAdvancedModeling.Visualization;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Texturing.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* TextureBackground containing ImageTexture nodes, with labeled side images and wide field-of-view (FOV) Viewpoints, suitable for scene-orientation testing. Includes transparency interpolator test and also LoadSensor Script console to log events of interest.
Related links: Catalog page TextureBackgroundCube, source TextureBackgroundCube.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 TextureBackgroundCube
{
/** Default constructor to create this object. */
public TextureBackgroundCube ()
{
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()
.addComponent(new component().setName("EnvironmentalEffects").setLevel(3))
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("TextureBackgroundCube.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("TextureBackground containing ImageTexture nodes, with labeled side images and wide field-of-view (FOV) Viewpoints, suitable for scene-orientation testing. Includes transparency interpolator test and also LoadSensor Script console to log events of interest."))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("1 May 2017"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("18 December 2023"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("BackgroundCube.x3d."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("../GeometricShapes/CubeWithLabeledSides.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("../Animation/CubeWithLabeledSidesViewpointSequencer.x3d"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("../Animation/CubeWithLabeledSidesViewpointSequencer.png"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Visualization/TextureBackgroundCube.x3d"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("https://www.web3d.org/x3d/content/examples/license.html"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("TextureBackgroundCube.x3d"))
.addChild(new TextureBackground("TransparentBackground")
.setBackTexture(new ImageTexture("backTexture").setUrl(new String[] {"../GeometricShapes/images/back.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/GeometricShapes/images/back.png"}))
.setBottomTexture(new ImageTexture("bottomTexture").setUrl(new String[] {"../GeometricShapes/images/bottom.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/GeometricShapes/images/bottom.png"}))
.setFrontTexture(new ImageTexture("frontTexture").setUrl(new String[] {"../GeometricShapes/images/front.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/GeometricShapes/images/front.png"}))
.setLeftTexture(new ImageTexture("leftTexture").setUrl(new String[] {"../GeometricShapes/images/left.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/GeometricShapes/images/left.png"}))
.setRightTexture(new ImageTexture("rightTexture").setUrl(new String[] {"../GeometricShapes/images/right.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/GeometricShapes/images/right.png"}))
.setTopTexture(new ImageTexture("topTexture").setUrl(new String[] {"../GeometricShapes/images/top.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/GeometricShapes/images/top.png"})))
.addChild(new ScalarInterpolator("TransparencyAnimator").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new double[] {0.0,1.0,0.0}))
.addChild(new ROUTE().setFromNode("TransparencyAnimator").setFromField("value_changed").setToNode("TransparentBackground").setToField("transparency"))
.addChild(new TimeSensor("Clock").setCycleInterval(6).setLoop(true))
.addChild(new ROUTE().setFromNode("Clock").setFromField("fraction_changed").setToNode("TransparencyAnimator").setToField("set_fraction"))
.addChild(new LoadSensor("ImageLoadSensor")
.addChild(new ImageTexture().setUSE("backTexture"))
.addChild(new ImageTexture().setUSE("bottomTexture"))
.addChild(new ImageTexture().setUSE("frontTexture"))
.addChild(new ImageTexture().setUSE("leftTexture"))
.addChild(new ImageTexture().setUSE("rightTexture"))
.addChild(new ImageTexture().setUSE("topTexture")))
.addChild(new Script("LoadSensorReportScript").setSourceCode("""
ecmascript:
function isActiveUpdate (eventValue)
{
Browser.println('TextureBackgroundCube LoadSensorReportScript: isActiveUpdate=' + eventValue);
}
function isLoadedUpdate (eventValue)
{
Browser.println('TextureBackgroundCube LoadSensorReportScript: isLoadedUpdate=' + eventValue);
}
function loadTimeUpdate (eventValue)
{
Browser.println('TextureBackgroundCube LoadSensorReportScript: loadTimeUpdate=' + eventValue);
}
function progressUpdate (eventValue)
{
Browser.println('TextureBackgroundCube LoadSensorReportScript: progressUpdate=' + eventValue);
}
function transparencyUpdate (eventValue)
{
// pretty busy interpolator
// Browser.println('TextureBackgroundCube LoadSensorReportScript: transparencyUpdate=' + eventValue);
}
""")
.addField(new field().setName("isActiveUpdate").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("isLoadedUpdate").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("progressUpdate").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("loadTimeUpdate").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("transparencyUpdate").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY)))
.addChild(new ROUTE().setFromNode("ImageLoadSensor").setFromField("isActive").setToNode("LoadSensorReportScript").setToField("isActiveUpdate"))
.addChild(new ROUTE().setFromNode("ImageLoadSensor").setFromField("isLoaded").setToNode("LoadSensorReportScript").setToField("isLoadedUpdate"))
.addChild(new ROUTE().setFromNode("ImageLoadSensor").setFromField("loadTime").setToNode("LoadSensorReportScript").setToField("loadTimeUpdate"))
.addChild(new ROUTE().setFromNode("ImageLoadSensor").setFromField("progress").setToNode("LoadSensorReportScript").setToField("progressUpdate"))
.addChild(new ROUTE().setFromNode("TransparencyAnimator").setFromField("value_changed").setToNode("LoadSensorReportScript").setToField("transparencyUpdate"))
.addChild(new Viewpoint().setDescription("Front image of TextureBackground seen from origin").setFieldOfView(1.570796).setPosition(0.0,0.0,0.0))
.addChild(new Viewpoint().setDescription("Left image of TextureBackground seen from origin").setFieldOfView(1.570796).setOrientation(0.0,1.0,0.0,-1.570796).setPosition(0.0,0.0,0.0))
.addChild(new Viewpoint().setDescription("Top image of TextureBackground seen from origin").setFieldOfView(1.570796).setOrientation(1.0,0.0,0.0,1.570796).setPosition(0.0,0.0,0.0))
.addChild(new Viewpoint().setDescription("Back image of TextureBackground seen from origin").setFieldOfView(1.570796).setOrientation(0.0,1.0,0.0,3.141593).setPosition(0.0,0.0,0.0))
.addChild(new Viewpoint().setDescription("Right image of TextureBackground seen from origin").setFieldOfView(1.570796).setOrientation(0.0,1.0,0.0,1.570796).setPosition(0.0,0.0,0.0))
.addChild(new Viewpoint().setDescription("Bottom image of TextureBackground seen from origin").setFieldOfView(1.570796).setOrientation(1.0,0.0,0.0,-1.570796).setPosition(0.0,0.0,0.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
* shallow copy
* of the X3D model.
* @see X3D
* @return TextureBackgroundCube 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 TextureBackgroundCube().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.Visualization.TextureBackgroundCube\" 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.Visualization.TextureBackgroundCube self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Visualization/TextureBackgroundCube_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Visualization/TextureBackgroundCube_JavaExport.x3d";
String filenameX3DV = "Visualization/TextureBackgroundCube_JavaExport.x3dv";
String filenameJSON = "Visualization/TextureBackgroundCube_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}
