package X3dForWebAuthors.Chapter08UserInteractivity;
/*
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.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.KeyDeviceSensor.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc annotations follow, see below for Java source code.
/**
*
A KeySensor is used to change relative Viewpoints looking at the shark Lefty, while a SphereSensor can also rotate Lefty in place.
Related links: KeySensorLefty.java source, KeySensorLefty 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 KeySensorLefty
{
/** Default constructor to create this object. */
public KeySensorLefty ()
{
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("KeySensorLefty.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("A KeySensor is used to change relative Viewpoints looking at the shark Lefty, while a SphereSensor can also rotate Lefty in place."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Leonard Daly and Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("10 June 2006"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.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, Leonard Daly 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/Chapter08UserInteractivity/KeySensorLefty.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("KeySensorLefty.x3d"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {1.0,1.0,1.0})))
.addChild(new Group("LeftyViewpointsUnrotated")
.addChild(new Viewpoint("View1").setDescription("Lefty from the Right"))
.addChild(new Viewpoint("View2").setDescription("Lefty from the Front").setOrientation(0.0,1.0,0.0,1.57).setPosition(10.0,0.0,0.0))
.addChild(new Viewpoint("View3").setDescription("Lefty from the Left").setOrientation(0.0,1.0,0.0,3.14).setPosition(0.0,0.0,-10.0))
.addChild(new Viewpoint("View4").setDescription("Lefty from Behind").setOrientation(0.0,1.0,0.0,-1.57).setPosition(-10.0,0.0,0.0))
.addChild(new Viewpoint("View5").setDescription("Lefty from the Top").setOrientation(1.0,0.0,0.0,-1.57).setPosition(0.0,10.0,0.0))
.addChild(new Viewpoint("View6").setDescription("Lefty from the Bottom").setOrientation(1.0,0.0,0.0,1.57).setPosition(0.0,-10.0,0.0)))
.addChild(new Transform().setTranslation(-2.0,2.0,0.0)
.addChild(new Billboard().setAxisOfRotation(0.0,0.0,0.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,0.0,0.0)))
.setGeometry(new Text().setString(new String[] {"Press 'n' key for next Viewpoint,","press 'p' key ppnnfor previous Viewpoint."})
.setFontStyle(new FontStyle().setFamily(new String[] {"SANS"}).setJustify(FontStyle.JUSTIFY_BEGIN_BEGIN).setSize(0.5))))))
.addChild(new Transform("OrientationControl").setTranslation(2.0,-2.0,3.0)
.addChild(new SphereSensor("Rotator").setDescription("Select and drag to rotate"))
.addChild(new Transform("OrientationDisplay")
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.0,0.0,1.0)))
.setGeometry(new Sphere().setRadius(.5)))))
.addChild(new Transform().setScale(3.0,3.0,3.0)
.addChild(new Transform("ReOrient")
.addChild(new Inline().setUrl(new String[] {"../KelpForestExhibit/SharkLefty.x3d","https://X3dGraphics.com/examples/X3dForWebAuthors/KelpForestExhibit/SharkLefty.x3d","../KelpForestExhibit/SharkLefty.wrl","https://X3dGraphics.com/examples/X3dForWebAuthors/KelpForestExhibit/SharkLefty.wrl"}))))
.addChild(new ROUTE().setFromNode("Rotator").setFromField("rotation_changed").setToNode("OrientationDisplay").setToField("rotation"))
.addChild(new ROUTE().setFromNode("Rotator").setFromField("rotation_changed").setToNode("ReOrient").setToField("rotation"))
.addChild(new KeySensor("KeyDetector"))
.addChild(new Script("KeyHandler").setUrl(new String[] {"KeySensorLeftyScript.js","https://X3dGraphics.com/examples/X3dForWebAuthors/Chapter08UserInteractivity/KeySensorLeftyScript.js"})
.addField(new field().setName("keyPress").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("viewpointIndex").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(1))
.addField(new field().setName("bind_View1").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("bind_View2").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("bind_View3").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("bind_View4").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("bind_View5").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("bind_View6").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ROUTE().setFromNode("KeyDetector").setFromField("keyPress").setToNode("KeyHandler").setToField("keyPress"))
.addChild(new ROUTE().setFromNode("KeyHandler").setFromField("bind_View1").setToNode("View1").setToField("set_bind"))
.addChild(new ROUTE().setFromNode("KeyHandler").setFromField("bind_View2").setToNode("View2").setToField("set_bind"))
.addChild(new ROUTE().setFromNode("KeyHandler").setFromField("bind_View3").setToNode("View3").setToField("set_bind"))
.addChild(new ROUTE().setFromNode("KeyHandler").setFromField("bind_View4").setToNode("View4").setToField("set_bind"))
.addChild(new ROUTE().setFromNode("KeyHandler").setFromField("bind_View5").setToNode("View5").setToField("set_bind"))
.addChild(new ROUTE().setFromNode("KeyHandler").setFromField("bind_View6").setToNode("View6").setToField("set_bind")));
}
// 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 KeySensorLefty 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 KeySensorLefty().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.Chapter08UserInteractivity.KeySensorLefty\" 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.Chapter08UserInteractivity.KeySensorLefty\" self-validation test results: ");
String validationResults = thisExampleX3dModel.validationReport();
if (validationResults.startsWith("\n"))
System.out.println();
System.out.println(validationResults.trim());
}
}
}