package Basic.development;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalSensor.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* ViewpointGroup contains Viewpoint and ViewpointGroup nodes, allowing nested lists and viewpoint scoping in viewpoint lists. This is a developmental example for potential specification improvement. It is needed because (a) currently specified rules for X3D/VRML node binding state that behavior of child Viewpoints beneath Switch/LOD/etc. is undefined, and (b) browser viewpoint list display behavior is undefined.
Related links: Catalog page ViewpointGroupPrototype, source ViewpointGroupPrototype.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 Don Brutzman
*/
public class ViewpointGroupPrototype
{
/** Default constructor to create this object. */
public ViewpointGroupPrototype ()
{
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("ViewpointGroupPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("ViewpointGroup contains Viewpoint and ViewpointGroup nodes, allowing nested lists and viewpoint scoping in viewpoint lists. This is a developmental example for potential specification improvement. It is needed because (a) currently specified rules for X3D/VRML node binding state that behavior of child Viewpoints beneath Switch/LOD/etc. is undefined, and (b) browser viewpoint list display behavior is undefined."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("29 October 2003"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_WARNING ).setContent("this prototype is for development purposes only, do not override native player support for ViewpointGroup"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ViewpointListViewpointGroupProse.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("ViewpointGroupExample.x3d"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/navigation.html#Viewpoint"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/technicalinfo/specifications/vrml97/part1/nodesRef.html#Viewpoint"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("ViewpointGroup Viewpoint"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Basic/development/ViewpointGroupPrototype.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.3, https://www.web3d.org/x3d/tools/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("ViewpointGroupPrototype.x3d"))
.addChild(new ProtoDeclare("ViewpointGroup").setName("ViewpointGroup").setAppinfo("warning: developmental prototype for X3D v3.2 node do not override native support!")
.setProtoInterface(new ProtoInterface()
.addField(new field().setName("children").setType(field.TYPE_MFNODE).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("[Viewpoint | ViewpointGroup] only")
.addComments(" initialized at runtime, default is empty array of Viewpoint/ViewpointGroup nodes. "))
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setAppinfo("Text description or navigation hint to be displayed for this ViewpointGroup."))
.addField(new field().setName("displayed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true).setAppinfo("Whether this ViewpointGroup description is displayed in current viewpoint list."))
.addField(new field().setName("center").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(new SFVec3f(0.0,0.0,0.0)).setAppinfo("Position offset from origin of local coordinate system."))
.addField(new field().setName("radius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(10).setAppinfo("[0..infinity) Radius in meters of Proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list."))
.addField(new field().setName("set_radius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("[0..infinity) Radius in meters of Proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list."))
.addField(new field().setName("retainUserOffsets").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTOUTPUT).setValue(true).setAppinfo("Whether viewpoint needs to retain (true) or rezero (false) any prior user navigation offsets from defined viewpoint position orientation.")))
.setProtoBody(new ProtoBody()
.addChild(new Group()
.addChild(new ProximitySensor("ProximityZone").setSize(20.0,20.0,20.0)
.setIS(new IS()
.addConnect(new connect().setNodeField("center").setProtoField("center"))))
.addChild(new Switch("ViewpointsSwitch").setWhichChoice(0)
.addChild(new Group()
.setIS(new IS()
.addConnect(new connect().setNodeField("children").setProtoField("children")))))
.addChild(new Switch("HoldExposedFields").setWhichChoice(-1)
.addComments(" WorldInfo not used because title field is accessType initializeOnly ")
.addChild(new Anchor("DescriptionHolder")
.setIS(new IS()
.addConnect(new connect().setNodeField("description").setProtoField("description"))))
.addChild(new ProximitySensor("DisplayedHolder")
.setIS(new IS()
.addConnect(new connect().setNodeField("enabled").setProtoField("displayed")))))
.addChild(new Script("UnbindingControlScript").setDirectOutput(true).setSourceCode("""
ecmascript:
function initialize ()
{
// since Viewpoints remain on binding stack as before,
// no initialization action is necessary when implemented natively.
description = descriptionHolder.description;
displayed = displayedHolder.enabled;
tracePrint ('displayed=' + displayed);
if (!displayed) viewpointsSwitch.whichChoice = -1;
set_radius (radius);
// typecheck valid children nodes:
tracePrint ('viewpointsSwitch.choice.length=' + viewpointsSwitch.choice.length);
if (viewpointsSwitch.choice.length >= 1)
for (i=0; i >= viewpointsSwitch.choice.length; i)
{
// how to check type?
// if (viewpointsSwitch.choice[i].____ etc.)
// once type checked, warn if Viewpoint position outside proximity box size
}
tracePrint ('... initialize() complete');
}
function isActive (activeValue)
{
// Most likely, viewpoint list actions will be controlled by browser.
// If viewpoint list is exposed via SAI, could do things here
// such as setting ViewpointGroup.description as browser label.
// Current action: switch child Viewpoints in/out of scope.
tracePrint ('activeValue=' + activeValue);
tracePrint ('displayed=' + displayed);
if (!displayed) return;
if (activeValue) viewpointsSwitch.whichChoice = 0;
else viewpointsSwitch.whichChoice = -1;
tracePrint ('viewpointsSwitch.whichChoice=' + viewpointsSwitch.whichChoice);
}
function set_radius (value, timestamp)
{
radius = value;
ProximityZone.size.x = 2 * radius;
ProximityZone.size.y = 2 * radius;
ProximityZone.size.z = 2 * radius;
tracePrint ('set_radius (' + value + '), radius=' + radius + ', ProximityZone.size=' + ProximityZone.size);
}
function tracePrint(outputString)
{
if (traceEnabled) Browser.println ('[ViewpointGroup' + description + ']' + outputString);
}
function alwaysPrint(outputString)
{
Browser.println ('[ViewpointGroup' + description + ']' + outputString);
}
""")
.addField(new field().setName("isActive").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("ProximityZone").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new ProximitySensor().setUSE("ProximityZone")))
.addField(new field().setName("radius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("[0..infinity) Radius in meters of Proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list."))
.addField(new field().setName("set_radius").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("[0..infinity) Radius in meters of Proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list."))
.addField(new field().setName("viewpointsSwitch").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new Switch().setUSE("ViewpointsSwitch")))
.addComments(" use node holders to work around VRML 97 Script exposedField restriction ")
.addField(new field().setName("descriptionHolder").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new Anchor().setUSE("DescriptionHolder")))
.addField(new field().setName("displayedHolder").setType(field.TYPE_SFNODE).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)
.addChild(new ProximitySensor().setUSE("DisplayedHolder")))
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("displayed").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(true))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(false))
.setIS(new IS()
.addConnect(new connect().setNodeField("radius").setProtoField("radius"))
.addConnect(new connect().setNodeField("set_radius").setProtoField("set_radius"))))
.addChild(new ROUTE().setFromNode("ProximityZone").setFromField("isActive").setToNode("UnbindingControlScript").setToField("isActive")))))
.addComments(" ===============Example============== ")
.addChild(new NavigationInfo().setType(new String[] {"FLY","ANY"}))
.addChild(new Anchor().setDescription("ViewpointGroupExample").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"ViewpointGroupExample.x3d","https://www.web3d.org/x3d/content/examples/Basic/development/ViewpointGroupExample.x3d","ViewpointGroupExample.wrl","https://www.web3d.org/x3d/content/examples/Basic/development/ViewpointGroupExample.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"ViewpointGroupPrototype","defines a prototype","","Click on this text to see","ViewpointGroupExample scene"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.5)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,1.0,0.2)))))
.addChild(new Viewpoint().setDescription("inside scope: ViewpointGroup").setPosition(0.0,0.0,5.0))
.addChild(new Viewpoint().setDescription("outside scope: ViewpointGroup").setPosition(0.0,0.0,12.0)));
}
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 ViewpointGroupPrototype 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 ViewpointGroupPrototype().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.ViewpointGroupPrototype\" 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("Basic.development.ViewpointGroupPrototype self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// development/ViewpointGroupPrototype_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "development/ViewpointGroupPrototype_JavaExport.x3d";
String filenameX3DV = "development/ViewpointGroupPrototype_JavaExport.x3dv";
String filenameJSON = "development/ViewpointGroupPrototype_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}