package X3dForWebAuthors.KelpForestExhibit;
/*
Copyright (c) 1995-2023 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.Geometry3D.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Interpolation.*;
import org.web3d.x3d.jsail.Rendering.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Texturing.*;
import org.web3d.x3d.jsail.Time.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* This is a reusable prototype of a generic fish, which can be configured upon instancing to create customized fish.
Related links: FishPrototype.java source, FishPrototype 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 Ildeniz Duman
*/
public class FishPrototype
{
/** Default constructor to create this object. */
public FishPrototype ()
{
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("FishPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This is a reusable prototype of a generic fish, which can be configured upon instancing to create customized fish."))
.addMeta(new meta().setName(meta.NAME_WARNING ).setContent("Circular fish behavior is embedded in prototype, instead the circular path needs to be used in external files or possibly parameterized."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Ildeniz Duman"))
.addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Scott Tufts"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("1 June 1998"))
.addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("9 December 2001"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/FishPrototype.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("FishPrototype.x3d"))
.addChild(new ProtoDeclare("Fish").setName("Fish")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("skinTextureUrl").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("fishScale").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(1.0,1.0,1.0)))
.addField(new field().setName("fishColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFColor(0.7,0.7,0.7))))
.setProtoBody(new ProtoBody()
.addChild(new Transform("FishTransform")
.setIS(new IS()
.addConnect(new connect().setNodeField("scale").setProtoField("fishScale")))
.addChild(new Transform("Way")
.addChild(new Transform().setTranslation(4.0,0.0,0.0)
.addChild(new Transform().setRotation(1.0,0.0,0.0,1.57)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material("FishColor")
.setIS(new IS()
.addConnect(new connect().setNodeField("diffuseColor").setProtoField("fishColor"))))
.setTexture(new ImageTexture("FishTexture")
.setIS(new IS()
.addConnect(new connect().setNodeField("url").setProtoField("skinTextureUrl")))))
.setGeometry(new Extrusion("FishShape").setCreaseAngle(1.57).setCrossSection(new MFVec2f(new double[] {1.00,0.00,0.92,-0.38,0.71,-0.71,0.38,-0.92,0.00,-1.00,-0.38,-0.92,-0.71,-0.71,-0.92,-0.38,-1.00,-0.00,-0.92,0.38,-0.71,0.71,-0.38,0.92,0.00,1.00,0.38,0.92,0.71,0.71,0.92,0.38,1.00,0.00})).setScale(new MFVec2f(new double[] {0.03,0.03,0.1,0.15,0.4,0.7,0.5,0.75,0.4,0.55,0.2,0.3,0.05,0.1,0.03,0.6})).setSpine(new MFVec3f(new double[] {0.0,3.51,0.0,0.0,3.50,0.0,0.0,2.80,0.0,0.0,2.3,0.0,0.0,1.5,0.0,0.0,0.5,0.0,0.0,0.0,0.0,0.0,-0.6,0.0}))))
.addChild(new Shape()
.setAppearance(new Appearance("FinSkin")
.setMaterial(new Material().setDiffuseColor(0.7,0.7,0.7).setTransparency(0.3)))
.setGeometry(new IndexedFaceSet().setSolid(false).setCoordIndex(new int[] {0,1,2,3,-1})
.setCoord(new Coordinate("Pelvic").setPoint(new MFVec3f(new double[] {0.0,2.2,0.6,0.0,2.2,-0.7,0.0,0.3,-0.3,0.0,0.7,0.5})))))
.addChild(new Transform().setTranslation(0.3,2.8,-0.4)
.addChild(new Shape("Eye")
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(0.5,0.5,0.5).setShininess(1).setSpecularColor(0.3,0.3,0.3)))
.setGeometry(new Sphere().setRadius(0.08))))
.addChild(new Transform().setTranslation(-0.3,2.8,-0.4)
.addChild(new Shape().setUSE("Eye")))
.addChild(new Transform().setScale(2.6,1.0,0.7).setTranslation(0.0,3.44,-0.1)
.addChild(new Shape().setUSE("Eye")))
.addChild(new Transform("LeftPectoral").setTranslation(-0.3,2.7,0.1)
.addChild(new Shape()
.setAppearance(new Appearance().setUSE("FinSkin"))
.setGeometry(new IndexedFaceSet().setSolid(false).setCoordIndex(new int[] {0,1,2,-1})
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {0.0,0.0,0.0,-0.5,-0.2,0.1,-0.25,0.2,0.25}))))))
.addChild(new Transform("RightPectoral").setTranslation(0.3,2.7,0.1)
.addChild(new Shape()
.setAppearance(new Appearance().setUSE("FinSkin"))
.setGeometry(new IndexedFaceSet().setSolid(false).setCoordIndex(new int[] {0,1,2,-1})
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {0.0,0.0,0.0,0.5,-0.2,0.1,0.25,0.2,0.25})))))))))
.addChild(new Group("AnimationGroup")
.addChild(new TimeSensor("RouteTImer").setCycleInterval(50).setLoop(true))
.addChild(new TimeSensor("Timer").setCycleInterval(1.5).setLoop(true))
.addChild(new CoordinateInterpolator("Waggler").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new MFVec3f(new double[] {0.0,3.55,0.0,0.0,3.50,0.0,0.0,2.80,0.0,0.0,2.3,0.0,-0.05,1.5,0.0,0.1,0.5,0.0,0.2,0.0,0.0,0.3,-0.6,0.0,0.0,3.55,0.0,0.0,3.50,0.0,0.0,2.80,0.0,0.0,2.3,0.0,0.05,1.5,0.0,-0.1,0.5,0.0,-0.2,0.0,0.0,-0.3,-0.6,0.0,0.0,3.55,0.0,0.0,3.50,0.0,0.0,2.80,0.0,0.0,2.3,0.0,-0.05,1.5,0.0,0.1,0.5,0.0,0.2,0.0,0.0,0.3,-0.6,0.0})))
.addChild(new ROUTE().setFromNode("Timer").setFromField("fraction_changed").setToNode("Waggler").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("Waggler").setFromField("value_changed").setToNode("FishShape").setToField("set_spine"))
.addChild(new CoordinateInterpolator("Points").setKey(new double[] {0.0,0.5,1.0}).setKeyValue(new MFVec3f(new double[] {0.0,2.2,0.6,0.0,2.2,-0.7,0.2,0.3,-0.3,0.2,0.7,0.5,0.0,2.2,0.6,0.0,2.2,-0.7,-0.2,0.3,-0.3,-0.2,0.7,0.5,0.0,2.2,0.6,0.0,2.2,-0.7,0.2,0.3,-0.3,0.2,0.7,0.5})))
.addChild(new ROUTE().setFromNode("Timer").setFromField("fraction_changed").setToNode("Points").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("Points").setFromField("value_changed").setToNode("Pelvic").setToField("set_point"))
.addChild(new OrientationInterpolator("LeftPectoralRotation").setKey(new double[] {0.0,0.3,0.7,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,0.523,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.523})))
.addChild(new ROUTE().setFromNode("Timer").setFromField("fraction_changed").setToNode("LeftPectoralRotation").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("LeftPectoralRotation").setFromField("value_changed").setToNode("LeftPectoral").setToField("set_rotation"))
.addChild(new OrientationInterpolator("RightPectoralRotation").setKey(new double[] {0.0,0.3,0.7,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,-0.523,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,-0.523})))
.addChild(new ROUTE().setFromNode("Timer").setFromField("fraction_changed").setToNode("RightPectoralRotation").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("RightPectoralRotation").setFromField("value_changed").setToNode("RightPectoral").setToField("set_rotation"))
.addChild(new OrientationInterpolator("Turn").setKey(new double[] {0.0,0.25,0.5,0.75,1.0}).setKeyValue(new MFRotation(new double[] {0.0,1.0,0.0,0.0,0.0,1.0,0.0,-1.57,0.0,1.0,0.0,-3.14,0.0,1.0,0.0,-4.71,0.0,1.0,0.0,0.0})))
.addChild(new ROUTE().setFromNode("RouteTImer").setFromField("fraction_changed").setToNode("Turn").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("Turn").setFromField("value_changed").setToNode("Way").setToField("set_rotation"))))))
.addComments(" ==================== ")
.addChild(new ProtoInstance("Fish").setContainerField("children")));
}
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 FishPrototype 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 FishPrototype().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: \"X3dForWebAuthors.KelpForestExhibit.FishPrototype\" 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.KelpForestExhibit.FishPrototype\" self-validation test results: ");
String validationResults = thisExampleX3dModel.validationReport();
if (validationResults.startsWith("\n") || (validationResults.length() > 10))
System.out.println();
System.out.println(validationResults.trim());
}
}
}