package Vrml2Sourcebook.Siggraph98Course;
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.Networking.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Rendering.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
import org.web3d.x3d.jsail.Texturing.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Select and drag cross-section to see changes. Cutting plane parts: this file contains two prototype declarations used in creating a cutting plane. The example scene TexturePlane uses these for external prototype instances and creates a plane with one of a set of textures mapped to it. The texture choice is controlled by a fraction eventIn. SlidingPlane creates a texture plane that slides back and forth along the X axis, changing the texture based upon the X position.
Related links: Catalog page Cut, source Cut.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 David R. Nadeau
*/
public class Cut
{
/** Default constructor to create this object. */
public Cut ()
{
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("Cut.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Select and drag cross-section to see changes. Cutting plane parts: this file contains two prototype declarations used in creating a cutting plane. The example scene TexturePlane uses these for external prototype instances and creates a plane with one of a set of textures mapped to it. The texture choice is controlled by a fraction eventIn. SlidingPlane creates a texture plane that slides back and forth along the X axis, changing the texture based upon the X position."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("David R. Nadeau"))
.addMeta(new meta().setName(meta.NAME_TRANSLATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("1 July 1998"))
.addMeta(new meta().setName(meta.NAME_TRANSLATED ).setContent("2 February 2014"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("7 December 2024"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("CutPlane.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("TexturePlane.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("originals/cut.wrl"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.siggraph.org/s98"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.siggraph.org/s98/conference/courses/18.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.sdsc.edu/~moreland/courses/Siggraph98/vrml97/slides/mt0497.htm"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("http://www.sdsc.edu/~moreland/courses/Siggraph98/vrml97/vrml97.htm"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/X3dResources.html"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Siggraph98Course/Cut.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("Vrml97ToX3dNist, http://ovrt.nist.gov/v2_x3d.html"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit, https://www.web3d.org/x3d/tools/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setInfo(new String[] {"Copyright (c) 1997, David R. Nadeau"}).setTitle("Cutting Plane parts"))
.addChild(new ProtoDeclare("TexturePlane").setName("TexturePlane")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("textures").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addComments(" initialized with ImageTexture nodes upon use "))
.addField(new field().setName("set_fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY)))
.setProtoBody(new ProtoBody()
.addChild(new Group()
.addChild(new Shape()
.setAppearance(new Appearance("App"))
.setGeometry(new IndexedFaceSet().setSolid(false).setCoordIndex(new int[] {0,1,2,3}).setTexCoordIndex(new int[] {0,1,2,3})
.setTexCoord(new TextureCoordinate().setPoint(new MFVec2f(new double[] {0.0,0.0,1.0,0.0,1.0,1.0,0.0,1.0})))
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-1.0,-1.0,0.0,1.0,-1.0,0.0,1.0,1.0,0.0,-1.0,1.0,0.0})))))
.addChild(new Shape()
.setAppearance(new Appearance())
.setGeometry(new IndexedLineSet().setCoordIndex(new int[] {0,1,2,3,0})
.setCoord(new Coordinate().setPoint(new MFVec3f(new double[] {-1.0,-1.0,0.0,1.0,-1.0,0.0,1.0,1.0,0.0,-1.0,1.0,0.0}))))))
.addComments(" ProtoBody child following first child will not be rendered, since the first child determines node type of this prototype. ")
.addChild(new Script("Selector").setDirectOutput(true).setSourceCode("""
ecmascript:
function initialize( ) {
texture_changed = textures[0];
Browser.println ('[Cut Selector] initialize(): textures.length=' + textures.length); // debug
}
function set_fraction( f, tm ) {
i = Math.floor(f * 10);
if ( i == 10 ) { i = 9; }
Browser.println ('[Cut Selector] set_fraction(): i=' + i); // debug
texture_changed = textures[i];
}
""")
.addField(new field().setName("textures").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("texture_changed").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("set_fraction").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("textures").setProtoField("textures"))
.addConnect(new connect().setNodeField("set_fraction").setProtoField("set_fraction"))))
.addChild(new ROUTE().setFromNode("Selector").setFromField("texture_changed").setToNode("App").setToField("set_texture"))))
.addChild(new ProtoDeclare("SlidingPlane").setName("SlidingPlane")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("textures").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addComments(" initialized with ImageTexture nodes upon use "))
.addField(new field().setName("minMaxX").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(new SFVec2f(0.0,1.0)))
.addField(new field().setName("initialX").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(0.0)))
.setProtoBody(new ProtoBody()
.addChild(new Transform().setRotation(0.0,1.0,0.0,1.571)
.addChild(new PlaneSensor("Slider").setDescription("drag to see cross-section slices"))
.addChild(new Transform("PlanePosition").setRotation(0.0,1.0,0.0,-1.571)
.addChild(new ProtoInstance("TexturePlane", "Plane").setContainerField("children")
.setIS(new IS()
.addConnect(new connect().setNodeField("textures").setProtoField("textures"))))
.addChild(new Transform().setRotation(0.0,1.0,0.0,1.571).setTranslation(1.05,-1.2,0.0)
.addChild(new Shape()
.setAppearance(new Appearance())
.setGeometry(new Text("Label").setString(new String[] {""})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.3).setCssStyle("BOLD")))))))
.addChild(new Script("Translator").setSourceCode("""
ecmascript:
function translate( x ) {
// compute the fraction using the given X position
f = (x-minMaxX[0]) / (minMaxX[1] - minMaxX[0]);
// send a fraction event
fraction_changed = f;
// send a new label string with 1 digit after decimal
label_changed[0] = Math.floor(f*10.0)/10.0;
}
function initialize( ) {
// set the plane sensor bounds
minPosition_changed[0] = minMaxX[0];
minPosition_changed[1] = 0.0;
maxPosition_changed[0] = minMaxX[1];
maxPosition_changed[1] = 0.0;
// set the plane sensor initial position
offset_changed[0] = initialX;
offset_changed[1] = 0.0;
offset_changed[2] = 0.0;
// compute the initial values
translate( initialX );
}
function set_translation( t, tm ) {
// compute the new values
translate( t[0] );
}
""")
.addField(new field().setName("set_translation").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("minMaxX").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("minPosition_changed").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("fraction_changed").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("initialX").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("offset_changed").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("maxPosition_changed").setType(field.TYPE_SFVEC2F).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("label_changed").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.setIS(new IS()
.addConnect(new connect().setNodeField("minMaxX").setProtoField("minMaxX"))
.addConnect(new connect().setNodeField("initialX").setProtoField("initialX"))))
.addChild(new ROUTE().setFromNode("Slider").setFromField("translation_changed").setToNode("PlanePosition").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("Slider").setFromField("translation_changed").setToNode("Translator").setToField("set_translation"))
.addChild(new ROUTE().setFromNode("Translator").setFromField("fraction_changed").setToNode("Plane").setToField("set_fraction"))
.addChild(new ROUTE().setFromNode("Translator").setFromField("label_changed").setToNode("Label").setToField("set_string"))
.addChild(new ROUTE().setFromNode("Translator").setFromField("minPosition_changed").setToNode("Slider").setToField("set_minPosition"))
.addChild(new ROUTE().setFromNode("Translator").setFromField("maxPosition_changed").setToNode("Slider").setToField("set_maxPosition"))
.addChild(new ROUTE().setFromNode("Translator").setFromField("offset_changed").setToNode("Slider").setToField("set_offset"))
.addChild(new ROUTE().setFromNode("Translator").setFromField("offset_changed").setToNode("PlanePosition").setToField("set_translation"))))
.addComments(" Display scene instructions for viewing an example scene with a corresponding prototype instance ")
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.0,0.333333,0.66667})))
.addChild(new Transform().setTranslation(0.0,2.5,0.0)
.addChild(new Anchor().setDescription("select text to view parent scene").setUrl(new String[] {"CutPlane.x3d","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Siggraph98Course/CutPlane.x3d","CutPlane.wrl","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Siggraph98Course/CutPlane.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"The Cut.x3d scene holds prototype","declarations for model reuse.","","Select this text to view example usage","in CutPlane.x3d scene"})
.setFontStyle(new FontStyle("TextFont").setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.7).setCssStyle("BOLD")))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,0.9,0.4))))
.addComments(" Invisible box behind text makes selection easier ")
.addChild(new Shape()
.setGeometry(new Box().setSize(12.0,5.0,0.1))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1))))))
.addChild(new Transform().setTranslation(0.0,-2.5,0.0)
.addChild(new Anchor().setDescription("select text to view parent scene").setUrl(new String[] {"TexturePlane.x3d","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Siggraph98Course/TexturePlane.x3d","TexturePlane.wrl","https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Siggraph98Course/TexturePlane.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"Otherwise select this text to","view example usage in","TexturePlane.x3d scene"})
.setFontStyle(new FontStyle().setUSE("TextFont")))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,0.9,0.4))))
.addComments(" Invisible box behind text makes selection easier ")
.addChild(new Shape()
.setGeometry(new Box().setSize(12.0,5.0,0.1))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1)))))));
}
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 Cut 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 Cut().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: \"Vrml2Sourcebook.Siggraph98Course.Cut\" 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("Vrml2Sourcebook.Siggraph98Course.Cut self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Siggraph98Course/Cut_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Siggraph98Course/Cut_JavaExport.x3d";
String filenameX3DV = "Siggraph98Course/Cut_JavaExport.x3dv";
String filenameJSON = "Siggraph98Course/Cut_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}