package X3dForWebAuthors.Chapter04ViewingNavigation;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* This example provides three Viewpoint nodes bound to corresponding selectable NavigationInfo nodes that override navigation modes in the Hello World example, superseding default NavigationInfo type provided in that contained Inline model. To test this model, change viewpoints and then try to navigate each time, noting the new navigation mode.
Related links: Catalog page NavigationInfoExample, source NavigationInfoExample.java, X3D Resources, X3D Scene Authoring Hints, and X3D Tooltips.
Scene Meta Information
| meta tags |
Document Metadata |
| title |
NavigationInfoExample.x3d |
| description |
This example provides three Viewpoint nodes bound to corresponding selectable NavigationInfo nodes that override navigation modes in the Hello World example, superseding default NavigationInfo type provided in that contained Inline model. To test this model, change viewpoints and then try to navigate each time, noting the new navigation mode. |
| info |
NavigationInfo nodes have their own binding stack, similar to Viewpoint nodes, meaning that they can be activated (bound) in any order, but only one can be active at a given time. Cross-connecting a custom NavigationInfo to some Viewpoints can improve user experience in larger scenes. |
| creator |
Don Brutzman |
| creator |
Leonard Daly |
| created |
14 November 2005 |
| modified |
12 August 2025 |
| Image |
NavigationInfoExampleDashboard.png |
| Image |
NavigationInfoExampleIndexPage.png |
| reference |
X3D Scene Authoring Hints: Viewing and Navigation https://web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints |
| reference |
https://www.web3d.org/x3d/content/examples/X3dResources.html |
| rights |
Copyright (c) 2005, Daly Realism and Don Brutzman |
| subject |
X3D book, X3D graphics, X3D-Edit, http://www.x3dGraphics.com |
| identifier |
https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter04ViewingNavigation/NavigationInfoExample.x3d |
| generator |
X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit |
| license |
../license.html |
| |
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
* @author Leonard Daly
*/
public class NavigationInfoExample
{
/** Default constructor to create this object. */
public NavigationInfoExample ()
{
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("NavigationInfoExample.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This example provides three Viewpoint nodes bound to corresponding selectable NavigationInfo nodes that override navigation modes in the Hello World example, superseding default NavigationInfo type provided in that contained Inline model. To test this model, change viewpoints and then try to navigate each time, noting the new navigation mode."))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("NavigationInfo nodes have their own binding stack, similar to Viewpoint nodes, meaning that they can be activated (bound) in any order, but only one can be active at a given time. Cross-connecting a custom NavigationInfo to some Viewpoints can improve user experience in larger scenes."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Leonard Daly"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("14 November 2005"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("12 August 2025"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("NavigationInfoExampleDashboard.png"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("NavigationInfoExampleIndexPage.png"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("X3D Scene Authoring Hints: Viewing and Navigation https://web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints"))
.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 (c) 2005, Daly Realism 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://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter04ViewingNavigation/NavigationInfoExample.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("NavigationInfoExample.x3d"))
.addComments(" Because these NavigationInfo nodes are here in the parent scene, the first one is bound at load time, and thus governs the active navigation modes ")
.addComments(" Note that an author can control what choices a user has available, and initial type selected, while the user can select among navigation choices from available options ")
.addComments(" Author option: experiment by swapping order of these NavigationInfo nodes, first one is bound at load time. ")
.addComments(" FLY_FIRST is initial choice so that it noticeably overrides EXAMINE ANY found in the Inline HelloWorld scene ")
.addChild(new NavigationInfo("FLY_FIRST").setType(new String[] {"FLY","ANY"}))
.addChild(new NavigationInfo("DEFAULT_EXAMINE_FIRST"))
.addChild(new NavigationInfo("SIT_TIGHT").setType(new String[] {"NONE"}))
.addComments(" For this scene, first Viewpoint bound also binds corresponding NavigationInfo ")
.addChild(new Viewpoint("view_navigation_FLY").setDescription("user navigation mode changed to FLY ANY"))
.addChild(new Viewpoint("view_navigation_EXAMINE").setDescription("user navigation mode changed to EXAMINE ANY").setOrientation(0.0,1.0,0.0,-0.380506).setPosition(-4.0,0.0,10.0))
.addChild(new Viewpoint("view_navigation_NONE").setDescription("disable user navigation mode to NONE").setOrientation(0.0,1.0,0.0,0.380506).setPosition(4.0,0.0,10.0))
.addChild(new ROUTE().setFromNode("view_navigation_FLY").setFromField("isBound").setToNode("FLY_FIRST").setToField("set_bind"))
.addChild(new ROUTE().setFromNode("view_navigation_EXAMINE").setFromField("isBound").setToNode("DEFAULT_EXAMINE_FIRST").setToField("set_bind"))
.addChild(new ROUTE().setFromNode("view_navigation_NONE").setFromField("isBound").setToNode("SIT_TIGHT").setToField("set_bind"))
.addComments(" Finally here is original scene which also has a Viewpoint and a default EXAMINE ANY for NavigationInfo.type ")
.addChild(new Inline().setUrl(new String[] {"../HelloWorld.x3d","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/HelloWorld.x3d","../HelloWorld.wrl","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/HelloWorld.wrl"})
.setMetadata(new MetadataString().setName("profile").setValue(new String[] {"Immersive"}))));
}
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 NavigationInfoExample 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 NavigationInfoExample().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.Chapter04ViewingNavigation.NavigationInfoExample\" 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("X3dForWebAuthors.Chapter04ViewingNavigation.NavigationInfoExample self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter04ViewingNavigation/NavigationInfoExample_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter04ViewingNavigation/NavigationInfoExample_JavaExport.x3d";
String filenameX3DV = "Chapter04ViewingNavigation/NavigationInfoExample_JavaExport.x3dv";
String filenameJSON = "Chapter04ViewingNavigation/NavigationInfoExample_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}
