package Savage.Tools.SMAL;
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.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.PointingDeviceSensor.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* This scene defines the exemplar template for Savage Static Model metadata, allowing further interoperability via SMAL constructs. Savage Modeling Analysis Language (SMAL) authoring capabilities for X3D assume proper metadata within a scene to identify an object properly. A corresponding native-XML .xsd schema for SMAL will also be developed to facilitate conversion and use of vehicle metadata.
Related links: Catalog page SavageObjectMetadataTemplate, source SavageObjectMetadataTemplate.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 Travis Rauch, Don Brutzman
*/
public class SavageObjectMetadataTemplate
{
/** Default constructor to create this object. */
public SavageObjectMetadataTemplate ()
{
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("SavageObjectMetadataTemplate.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This scene defines the exemplar template for Savage Static Model metadata, allowing further interoperability via SMAL constructs. Savage Modeling Analysis Language (SMAL) authoring capabilities for X3D assume proper metadata within a scene to identify an object properly. A corresponding native-XML .xsd schema for SMAL will also be developed to facilitate conversion and use of vehicle metadata."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Travis Rauch, Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("20 May 2005"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("28 November 2019"))
.addMeta(new meta().setName(meta.NAME_TODO ).setContent("add corresponding XML versions of metadata"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://x3dgraphics.com/chapters/Chapter15-MetadataInformation.html"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("SMAL object metadata"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("SMAL.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/SMAL/SMAL.html"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/SMAL/SavageObjectMetadataTemplate.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("SavageObjectMetadataTemplate.x3d"))
.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("View source in browser").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"SavageObjectMetadataTemplate.html","https://www.web3d.org/x3d/content/examples/Savage/Tools/SMAL/SavageObjectMetadataTemplate.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).setCssStyle("BOLD")))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,0.99,0.6))))
.addChild(new Shape()
.setGeometry(new Box().setSize(7.0,3.0,.001))
.setAppearance(new Appearance()
.setMaterial(new Material().setTransparency(1))))
.addChild(new TouchSensor().setDescription("Select this text to view pretty-print documentation")))
.addChild(new WorldInfo().setInfo(new String[] {"https://www.web3d.org/x3d/content/examples/Savage/Tools/SMAL/SavageObjectMetadataTemplate.x3d"}).setTitle("SavageObjectMetadataTemplate")
.addComments(" This initial MetadataSet is itself metadata for the parent WorldInfo, thus it has (omitted) default containerField='metadata' ")
.setMetadata(new MetadataSet().setName("SMAL").setReference("https://www.web3d.org/x3d/content/examples/Savage/Tools/SMAL/SMAL.html")
.addComments(" All other SMAL Metadata nodes serve as values for their parent MetadataSet nodes, and thus have containerField='value' ")
.setMetadata(new MetadataString().setName("version").setValue(new String[] {"1.0"})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"This is the version of SMAL employed, not of the model."})))
.setMetadata(new MetadataSet().setName("StaticModelDefinition")
.addComments(" Identifying metadata for the current simulation of interest ")
.setMetadata(new MetadataSet().setName("Classification")
.setMetadata(new MetadataString().setName("level").setValue(new String[] {"UNCLASSIFIED"})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"UNCLASSIFIED","FOUO","CONFIDENTIAL","SECRET"})))
.setMetadata(new MetadataString().setName("reference")
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The published source of classified information, if any, contained in the Metadata."})))
.setMetadata(new MetadataString().setName("rationale")
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The specific element which contains the information classifying this document."}))))
.setMetadata(new MetadataSet().setName("IdentificationParameters")
.setMetadata(new MetadataString().setName("name").setValue(new String[] {"provideVehicleNameHere"})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The plain language name of the object this model represents."}))))
.setMetadata(new MetadataSet().setName("X3DArchiveModel")
.setMetadata(new MetadataString().setName("name").setValue(new String[] {"provideX3DArchiveModelUrlHere"})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"This is a placeholder element which ensures the proper validation of autogenerated SMAL code."}))))
.setMetadata(new MetadataSet().setName("PhysicalParameters")
.setMetadata(new MetadataSet().setName("PhysicalConstraints")
.setMetadata(new MetadataFloat().setName("height").setValue(new double[] {0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The maximum structural height of the object in meters. This may be used for clearance checking or other calculations."})))
.setMetadata(new MetadataFloat().setName("width").setValue(new double[] {0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The maximum width of the object in meters. This may be used for clearance checking or other calculations."})))
.setMetadata(new MetadataFloat().setName("length").setValue(new double[] {0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The maximum structural length of the object in meters. This may be used for clearance checking or other calculations."})))
.setMetadata(new MetadataFloat().setName("draft").setValue(new double[] {0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The vertical distance in meters from the deepest point to the waterline of this object at its stated displacement or gross weight."})))
.setMetadata(new MetadataFloat().setName("grossWeight").setValue(new double[] {0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"The standard operational weight of the vehicle in pounds or kilograms. This may be used in physics calculations."}))))
.setMetadata(new MetadataSet().setName("DynamicResponseConstraints")
.setMetadata(new MetadataFloat().setName("centerOfGravity").setValue(new double[] {0.0,0.0,0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"Sets the Center of Gravity of the object as an (x, y, z) distance in meters from the physical center of the object, which is located at (0, 0, 0)."})))
.setMetadata(new MetadataFloat().setName("aerodynamicCenter").setValue(new double[] {0.0,0.0,0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"Sets the Aerodynamic Center of the object as an (x, y, z) distance in meters from the physical center of the object, which is located at (0, 0, 0)."})))
.setMetadata(new MetadataFloat().setName("centerOfBuoyancy").setValue(new double[] {0.0,0.0,0.0})
.setMetadata(new MetadataString().setName("appinfo").setValue(new String[] {"Sets the Center of Buoyancy of the object as an (x, y, z) distance in meters from the physical center of the object, which is located at (0, 0, 0)."})))))
.setMetadata(new MetadataSet().setName("LocationOrientation")
.setMetadata(new MetadataSet().setName("Location")
.addComments(" Insert additional metadata, if appropriate "))
.setMetadata(new MetadataSet().setName("Orientation")
.addComments(" Insert additional metadata, if appropriate ")))))));
}
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 SavageObjectMetadataTemplate 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 SavageObjectMetadataTemplate().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: \"Savage.Tools.SMAL.SavageObjectMetadataTemplate\" 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("Savage.Tools.SMAL.SavageObjectMetadataTemplate self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/SMAL/SavageObjectMetadataTemplate_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/SMAL/SavageObjectMetadataTemplate_JavaExport.x3d";
String filenameX3DV = "Tools/SMAL/SavageObjectMetadataTemplate_JavaExport.x3dv";
String filenameJSON = "Tools/SMAL/SavageObjectMetadataTemplate_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}