package Basic.development;
/*
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.Navigation.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
*
Show four ways of solving the QuadTree problem using native XML tags, PROTOs, IDREF/USE and MFNode children compatibly - view XML source to see DTD internal-subset declarations.
Related links: QuadTreeExamples.java source, 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)
is used to create Java source code from an original .x3d
model.
* @author Don Brutzman
*/
public class QuadTreeExamples
{
/** Default constructor to create this object. */
public QuadTreeExamples ()
{
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_0)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("QuadTreeExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("26 June 2000"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 January 2020"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Show four ways of solving the QuadTree problem using native XML tags, PROTOs, IDREF/USE and MFNode children compatibly - view XML source to see DTD internal-subset declarations."))
.addMeta(new meta().setName(meta.NAME_ERROR ).setContent("Test to demonstrate DOCTYPE extensibility, this X3D scene not valid and does not render."))
.addMeta(new meta().setName(meta.NAME_WARNING ).setContent("You must view full source of the DTD declarations (QuadTreeExamples.x3d.txt) to fully understand validation techniques in this file."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("QuadTreeExamplesExplanation.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("QuadTreeExamples.x3d.txt"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("QuadTreeExamples.png"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/development/QuadTreeExamples.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.1, https://www.web3d.org/x3d/content/README.X3D-Edit.html"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addComments(" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ")
.addComments(" Example solution approach #1 ")
.addComments(" Note that PROTO declarations are also provided for compatible backwards translation to VRML 97 encoding. They are not necessary for independent X3D use of the QuadTree examples. ")
.addChild(new ProtoDeclare("QuadTree-USEchildren").setName("QuadTree-USEchildren")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("upperLeftDEFName").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("upperRightDEFName").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("lowerLeftDEFName").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("lowerRightDEFName").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addField(new field().setName("children").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT))
.addComments(" children field must be declared for any PROTOs or native-tag nodes with children "))
.setProtoBody(new ProtoBody()
.addComments(" VRML 97 specification paragraph 4.8.3, PROTO definition semantics: \"A prototype definition consists of one or more nodes.\" PROTO body follows. ")
.addChild(new Group()
.addChild(new Group("GroupA")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("upperLeftDEFName"))))
.addChild(new Group("GroupB")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("upperRightDEFName"))))
.addChild(new Group("GroupC")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("lowerLeftDEFName"))))
.addChild(new Group("GroupD")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("lowerRightDEFName")))))))
.addComments(" Example solution approach #3 ")
.addChild(new ProtoDeclare("QuadTree-TagChildren").setName("QuadTree-TagChildren")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("upperLeftNode").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)
.addComments(" no initialization node "))
.addField(new field().setName("upperRightNode").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)
.addComments(" no initialization node "))
.addField(new field().setName("lowerLeftNode").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)
.addComments(" no initialization node "))
.addField(new field().setName("lowerRightNode").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)
.addComments(" no initialization node "))
.addField(new field().setName("children").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT)))
.setProtoBody(new ProtoBody()
.addComments(" PROTO body follows. ")
.addChild(new Group()
.addChild(new Group("GroupE")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("upperLeftNode"))))
.addChild(new Group("GroupF")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("upperRightNode"))))
.addChild(new Group("GroupG")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("lowerLeftNode"))))
.addChild(new Group("GroupH")
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("lowerRightNode")))))))
.addComments(" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ")
.addChild(new Group()
.addChild(new Viewpoint().setDescription("View QuadTree examples").setPosition(0.0,0.0,30.0))
.addChild(new Transform("Example_1").setTranslation(0.0,6.0,0.0)
.addChild(new ProtoInstance("QuadTree-USEchildren").setContainerField("children")
.addFieldValue(new fieldValue().setName("children")
.addChild(new Group()
.addChild(new Transform("UPPER_LEFT").setTranslation(4.0,0.0,4.0)
.addChild(new Shape()
.setAppearance(new Appearance("RED")
.setMaterial(new Material().setDiffuseColor(1.0,0.0,0.0)))
.setGeometry(new Box())))
.addChild(new Transform("UPPER_RIGHT").setTranslation(3.0,0.0,-3.0)
.addChild(new Shape()
.setAppearance(new Appearance("GREEN")
.setMaterial(new Material().setDiffuseColor(0.0,1.0,0.0)))
.setGeometry(new Sphere())))
.addChild(new Transform("LOWER_LEFT").setTranslation(-3.0,0.0,-3.0)
.addChild(new Shape()
.setAppearance(new Appearance("BLUE")
.setMaterial(new Material().setDiffuseColor(.2,.2,1.0)))
.setGeometry(new Cylinder())))
.addChild(new Transform("LOWER_RIGHT").setTranslation(-6.0,0.0,4.0)
.addChild(new Shape()
.setAppearance(new Appearance("WHITE")
.setMaterial(new Material().setDiffuseColor(1.0,1.0,1.0)))
.setGeometry(new Text().setString(new String[] {"QuadTree-USEchildren","ProtoInstance"}))))))
.addFieldValue(new fieldValue().setName("upperLeftDEFName")
.addChild(new Transform().setUSE("UPPER_LEFT")))
.addFieldValue(new fieldValue().setName("upperRightDEFName")
.addChild(new Transform().setUSE("UPPER_RIGHT")))
.addFieldValue(new fieldValue().setName("lowerLeftDEFName")
.addChild(new Transform().setUSE("LOWER_LEFT")))
.addFieldValue(new fieldValue().setName("lowerRightDEFName")
.addChild(new Transform().setUSE("LOWER_RIGHT")))))
.addChild(new Transform("Example_2").setTranslation(0.0,2.0,0.0)
.setQuadTree-USEchildren(new QuadTree-USEchildren().setNodeType("Group"
// [*** X3dToJava.xslt error: encountered incorrect type (check incorrect capitalization), QuadTree-USEchildren nodeType: $isNumeric=false, $attributeType=, value='Group']
)
.addFieldValue(new fieldValue().setName("children")
.addComments(" children which follow are locally convenient and referenced via IDREF/USE ")
.addChild(new Transform("LOWER_RIGHT_EXAMPLE_2").setTranslation(-6.0,0.0,4.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"QuadTree-USEchildren","Native tags"}))
.setAppearance(new Appearance().setUSE("WHITE")))))
.addFieldValue(new fieldValue().setName("upperLeftDEFName")
.addChild(new Transform().setUSE("UPPER_LEFT")))
.addFieldValue(new fieldValue().setName("upperRightDEFName")
.addChild(new Transform().setUSE("UPPER_RIGHT")))
.addFieldValue(new fieldValue().setName("lowerLeftDEFName")
.addChild(new Transform().setUSE("LOWER_LEFT")))
.addFieldValue(new fieldValue().setName("lowerRightDEFName")
.addChild(new Transform().setUSE("LOWER_RIGHT_EXAMPLE_2")))))
.addChild(new Transform("Example_3").setTranslation(0.0,-2.0,0.0)
.addChild(new ProtoInstance("QuadTree-TagChildren").setContainerField("children")
.addFieldValue(new fieldValue().setName("upperLeftNode")
.addChild(new Transform().setUSE("UPPER_LEFT")))
.addFieldValue(new fieldValue().setName("upperRightNode")
.addChild(new Transform().setUSE("UPPER_RIGHT")))
.addFieldValue(new fieldValue().setName("lowerLeftNode")
.addChild(new Transform().setUSE("LOWER_LEFT")))
.addFieldValue(new fieldValue().setName("lowerRightNode")
.addChild(new Transform().setTranslation(-6.0,0.0,4.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"QuadTree-TagChildren","ProtoInstance"}))
.setAppearance(new Appearance().setUSE("WHITE")))))))
.addChild(new Transform("Example_4").setTranslation(0.0,-6.0,0.0)
.setQuadTree-TagChildren(new QuadTree-TagChildren().setNodeType("Group"
// [*** X3dToJava.xslt error: encountered incorrect type (check incorrect capitalization), QuadTree-TagChildren nodeType: $isNumeric=false, $attributeType=, value='Group']
)
.addFieldValue(new fieldValue().setName("upperLeftNode")
.addChild(new Transform().setUSE("UPPER_LEFT")))
.addFieldValue(new fieldValue().setName("upperRightNode")
.addChild(new Transform().setUSE("UPPER_RIGHT")))
.addFieldValue(new fieldValue().setName("lowerLeftNode")
.addChild(new Transform().setUSE("LOWER_LEFT")))
.addFieldValue(new fieldValue().setName("lowerRightNode")
.addChild(new Transform().setTranslation(-6.0,0.0,4.0)
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"QuadTree-TagChildren","Native tags"}))
.setAppearance(new Appearance().setUSE("WHITE"))))
.addChild(new WorldInfo().setInfo(new String[] {"this WorldInfo is here to demonstrate that the example is type MFNode"}))))))
.addComments(" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "));
}
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 QuadTreeExamples 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 QuadTreeExamples().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: \"Basic.development.QuadTreeExamples\" 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 \"Basic.development.QuadTreeExamples\" self-validation test results: ");
String validationResults = thisExampleX3dModel.validationReport();
if (validationResults.length() > 10)
System.out.println();
System.out.println(validationResults);
}
}
}