package X3dForWebAuthors.Chapter15Metadata;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Simple examples of meta statements, comments, WorldInfo node and typed metadata nodes.
Related links: Catalog page MetadataNodeExamplesX3D4, source MetadataNodeExamplesX3D4.java, X3D Resources, X3D Scene Authoring Hints, and X3D Tooltips.
Scene Meta Information
| meta tags |
Document Metadata |
| title |
MetadataNodeExamplesX3D4.x3d |
| description |
Simple examples of meta statements, comments, WorldInfo node and typed metadata nodes. |
| creator |
Don Brutzman |
| created |
30 September 2011 |
| modified |
30 September 2023 |
| reference |
Original name MetadataNodeExamples.x3d, split and renamed since handling of metadata containerField defaults changed in X3D4. |
| reference |
MetadataNodeExamplesX3D3.x3d |
| specificationSection |
X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 4 Concepts, 4.3.2 Root nodes |
| specificationUrl |
https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Rootnodes |
| info |
Information in head and meta elements is retained after a scene is parsed and loaded, and can be referenced via the Scene Access Interface (SAI) or Document Object Model (DOM) |
| info |
Authoring note: MetadataBoolean requires X3D version 4.0, as used in this example scene |
| reference |
The following referenced chapter is published online but was not included in the printed book. |
| reference |
Chapter15MetadataInformation.html |
| reference |
https://x3dgraphics.com/chapters/Chapter15MetadataInformation.html |
| reference |
https://X3dGraphics.com |
| reference |
https://www.web3d.org/x3d/content/examples/X3dResources.html |
| rights |
Copyright 2006, 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/Chapter15Metadata/MetadataNodeExamplesX3D4.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
*/
public class MetadataNodeExamplesX3D4
{
/** Default constructor to create this object. */
public MetadataNodeExamplesX3D4 ()
{
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_4_0)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("MetadataNodeExamplesX3D4.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Simple examples of meta statements, comments, WorldInfo node and typed metadata nodes."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("30 September 2011"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("30 September 2023"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("Original name MetadataNodeExamples.x3d, split and renamed since handling of metadata containerField defaults changed in X3D4."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("MetadataNodeExamplesX3D3.x3d"))
.addMeta(new meta().setName(meta.NAME_SPECIFICATIONSECTION).setContent("X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 4 Concepts, 4.3.2 Root nodes"))
.addMeta(new meta().setName(meta.NAME_SPECIFICATIONURL).setContent("https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Rootnodes"))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("Information in head and meta elements is retained after a scene is parsed and loaded, and can be referenced via the Scene Access Interface (SAI) or Document Object Model (DOM)"))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("Authoring note: MetadataBoolean requires X3D version 4.0, as used in this example scene"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("The following referenced chapter is published online but was not included in the printed book."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("Chapter15MetadataInformation.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://x3dgraphics.com/chapters/Chapter15MetadataInformation.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://X3dGraphics.com"))
.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 2006, 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/Chapter15Metadata/MetadataNodeExamplesX3D4.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()
.addComments(" May 2017: X3D4 Architecture Specification clarification allows Metadata nodes at top level of Scene graph. ")
.addMetadata(new MetadataString().setName("TestRootMetadataNode").setValue(new String[] {"Check whether scene root Metadata* node is satisfactory.","Note that all SFString values must be quoted."}))
.addComments(" Comments can appear between nodes (XML elements) but are not retained after a scene is parsed, loaded and playing ")
.addChild(new WorldInfo("MyWorldInfo").setInfo(new String[] {"Metadata strings","can go here","as string array values"}).setTitle("MetadataNodeExamplesX3D4.x3d Example Scene")
.addComments(" Structured information can go in Metadata nodes. Note that any X3D node can contain a single Metadata node with containerField='metadata' ")
.setMetadata(new MetadataSet("MyMetadataSetNode").setName("Metadata_name").setReference("SomeReferenceStandard 1.2.3c")
.setMetadata(new MetadataBoolean("MyMetadataBooleanNode").setName("Coin Flip").setReference("MetadataBoolean supported in X3D v3.3 and later").setValue(new boolean[] {true,false,true,false}))
.setMetadata(new MetadataDouble("MyMetadataDoubleNode").setName("Metadata_name").setReference("SomeReferenceStandard 1.2.3c").setValue(new double[] {3.141592658,2.71812181}))
.setMetadata(new MetadataFloat("MyMetadataFloatNode").setName("Metadata_name").setReference("SomeReferenceStandard 1.2.3c").setValue(new double[] {9.8,6.023e+23}))
.setMetadata(new MetadataInteger("MyMetadataIntegerNode").setName("Metadata_name").setReference("SomeReferenceStandard 1.2.3c").setValue(new int[] {6,28,496}))
.setMetadata(new MetadataString("MyMetadataStringNode").setName("Metadata_name").setReference("SomeReferenceStandard 1.2.3c").setValue(new String[] {"Part 27","P27","p27"}))
.setMetadata(new MetadataSet("NestedMetadataSetNode").setName("TestNestedMetadataSetNodes")
.addComments(" MetadataSet can also contain multiple Metadata nodes with default containerField='value' including USE nodes ")
.setMetadata(new MetadataString().setUSE("MyMetadataStringNode"))
.setMetadata(new MetadataInteger().setUSE("MyMetadataIntegerNode"))
.setMetadata(new MetadataFloat().setUSE("MyMetadataFloatNode"))
.setMetadata(new MetadataFloat().setName("coefficients").setValue(new double[] {3.141592653,2.7128,1.0,0.0})))))
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.0,0.439216,0.760784})))
.addChild(new Viewpoint().setDescription("View scene source to see metadata examples").setPosition(0.0,0.0,9.0))
.addChild(new Anchor().setDescription("Load scene index page").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"MetadataNodeExamplesIndex.html","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15Metadata/MetadataNodeExamplesIndex.html"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"View scene source","to see","metadata examples"})
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE)))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,0.992157,0.039216))))));
}
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 MetadataNodeExamplesX3D4 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 MetadataNodeExamplesX3D4().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.Chapter15Metadata.MetadataNodeExamplesX3D4\" 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.Chapter15Metadata.MetadataNodeExamplesX3D4 self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter15Metadata/MetadataNodeExamplesX3D4_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter15Metadata/MetadataNodeExamplesX3D4_JavaExport.x3d";
String filenameX3DV = "Chapter15Metadata/MetadataNodeExamplesX3D4_JavaExport.x3dv";
String filenameJSON = "Chapter15Metadata/MetadataNodeExamplesX3D4_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}