package X3dForWebAuthors.Chapter12EnvironmentSensorSound;
/*
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.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Sound.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc annotations follow, see below for Java source code.
/**
*
UsingLoadSensor to test when AudioClip loading is complete.
Related links: SoundLoadSensorTest.java source, SoundLoadSensorTest 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 Leonard Daly and Don Brutzman
*/
public class SoundLoadSensorTest
{
/** Default constructor to create this object. */
public SoundLoadSensorTest ()
{
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("SoundLoadSensorTest.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("UsingLoadSensor to test when AudioClip loading is complete"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("19 July 2008"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Leonard Daly and Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://X3dGraphics.com"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/X3dResources.html"))
.addMeta(new meta().setName(meta.NAME_RIGHTS ).setContent("Copyright 2006, Daly Realism and Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("X3D book, X3D graphics, X3D-Edit, http://www.x3dGraphics.com"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://X3dGraphics.com/examples/X3dForWebAuthors/Chapter12EnvironmentSensorSound/SoundLoadSensorTest.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()
.addComments(" Sound location y-value is 1.6 in order to match typical avatar height (in meters) ")
.addChild(new WorldInfo().setTitle("SoundLoadSensorTest.x3d"))
.addChild(new Sound("SomeSound").setLocation(0.0,1.6,0.0).setMaxBack(100).setMaxFront(100).setMinBack(10).setMinFront(10)
.setSource(new AudioClip("WaterSounds").setDescription("Running Water").setUrl(new String[] {"aqua.wav","https://X3dGraphics.com/examples/X3dForWebAuthors/Chapter12EnvironmentSensorSound/aqua.wav"})))
.addChild(new LoadSensor("ReportWhenLoaded")
.addChild(new AudioClip().setUSE("WaterSounds")))
.addChild(new ROUTE().setFromNode("ReportWhenLoaded").setFromField("loadTime").setToNode("WaterSounds").setToField("startTime"))
.addComments(" send completion report to console ")
.addChild(new Script("ConsoleReport").setSourceCode("""
ecmascript:
function initialize ()
{
Browser.println ('Script initialize() complete');
}
function loadComplete (value)
{
Browser.println ('LoadSensor AudioClip isLoaded=' + value);
}
function loadTime (value)
{
Browser.println ('LoadSensor AudioClip loadTime=' + value);
}
""")
.addField(new field().setName("loadComplete").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("loadTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY)))
.addChild(new ROUTE().setFromNode("ReportWhenLoaded").setFromField("isLoaded").setToNode("ConsoleReport").setToField("loadComplete"))
.addChild(new ROUTE().setFromNode("ReportWhenLoaded").setFromField("loadTime").setToNode("ConsoleReport").setToField("loadTime"))
.addComments(" show visible indication of load waiting, complete ")
.addChild(new Transform("PivotTextSigns")
.addComments(" First sign indicates waiting... ")
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"LoadSensor waiting for AudioClip..."})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.7).setCssStyle("ITALIC")))
.setAppearance(new Appearance()
.setMaterial(new Material().setEmissiveColor(0.878431,0.262745,0.0))))
.addComments(" Second sign indicates completed, initially rotated 90 degrees out of view ")
.addChild(new Transform().setRotation(0.0,1.0,0.0,1.57)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"LoadSensor reports AudioClip loading complete."})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.7).setCssStyle("ITALIC")))
.setAppearance(new Appearance()
.setMaterial(new Material().setEmissiveColor(0.0,0.278431,0.027451))))))
.addChild(new OrientationInterpolator("SignRotationInterpolator").setKey(new double[] {0.0,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,0.0,0.0,1.0,0.0,-1.57})))
.addChild(new TimeSensor("SignRotationClock").setCycleInterval(0.8))
.addChild(new ROUTE().setFromNode("ReportWhenLoaded").setFromField("loadTime").setToNode("SignRotationClock").setToField("startTime"))
.addChild(new ROUTE().setFromNode("SignRotationClock").setFromField("fraction_changed").setToNode("SignRotationInterpolator").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("SignRotationInterpolator").setFromField("value_changed").setToNode("PivotTextSigns").setToField("rotation")));
}
// 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 SoundLoadSensorTest 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 SoundLoadSensorTest().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.Chapter12EnvironmentSensorSound.SoundLoadSensorTest\" 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.Chapter12EnvironmentSensorSound.SoundLoadSensorTest\" self-validation test results: ");
String validationResults = thisExampleX3dModel.validationReport();
if (validationResults.startsWith("\n"))
System.out.println();
System.out.println(validationResults.trim());
}
}
}