package X3dForWebAuthors.Chapter02GeometryPrimitives;
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.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Text node demonstration of quotation, apostrophe, ampersand and backslash characters using X3D MFString escaping for XML character entities.
Related links: Catalog page TextSpecialCharacters, source TextSpecialCharacters.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 TextSpecialCharacters
{
/** Default constructor to create this object. */
public TextSpecialCharacters ()
{
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()
.addComments(" note quotes in comment and meta reference: https://en.wikipedia.org/wiki/\"Hello,_World!\"_program ")
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("TextSpecialCharacters.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Text node demonstration of quotation, apostrophe, ampersand and backslash characters using X3D MFString escaping for XML character entities."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("12 July 2008"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("20 October 2019"))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("See screenshot figures and various encoding conversions to note that multiple equivalences in XML character representations lead to consistent results despite slight differences in source."))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("TextSpecialCharactersScreenshotXmlSource.png"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("TextSpecialCharactersScreenshotPrettyPrintHtml.png"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("Character entity references in HTML 4, http://www.w3.org/TR/REC-html40/sgml/entities.html"))
.addMeta(new meta().setName(meta.NAME_REFERENCE ).setContent("https://en.wikipedia.org/wiki/\"Hello,_World!\"_program"))
.addMeta(new meta().setName(meta.NAME_RIGHTS ).setContent("Copyright (c) Don Brutzman and Leonard Daly, 2008"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02GeometryPrimitives/TextSpecialCharacters.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("TextSpecialCharacters.x3d"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {1.0,1.0,1.0})))
.addChild(new Viewpoint().setDescription("Default View").setPosition(0.0,0.0,15.0))
.addChild(new Shape()
.addComments(" Empty string \"\" means to skip a line ")
.addComments(" The ampersand escape characters are based on XML rules ")
.addComments(" apostrophe ' is ' and needs to be escaped in single-quote delimiters used for string='value' attribute ")
.addComments(" ampersand & is & and needs to be escaped ")
.addComments(" quotation mark \" is " and isn't needed if single-quote delimiters used for string='value' attribute ")
.addComments(" quotation mark \" character can be used within an X3D string value if escaped with backslash \\ as \\\" ")
.addComments(" backslash \\ is used as escape character for \" (and itself) in X3D ")
.addComments(" character entities are listed in HTML specification and are good for any XML ")
.setGeometry(new Text("DefaultText").setString(new String[] {"Character entity substitutions:","empty string \"\" skips a line:","","apostrophe ' is '","ampersand & is &","quote mark \" is "","backslash \\ is X3D escape character","double backslash \\\\ is X3D backslash \\ character","Pi Π is Π XML character entity"})
.setFontStyle(new FontStyle("CenteredFontStyle").setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE)))
.setAppearance(new Appearance()
.setMaterial(new Material("DefaultMaterial").setDiffuseColor(0.2,0.2,0.2)))));
}
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 TextSpecialCharacters 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 TextSpecialCharacters().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.Chapter02GeometryPrimitives.TextSpecialCharacters\" 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.Chapter02GeometryPrimitives.TextSpecialCharacters self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Chapter02GeometryPrimitives/TextSpecialCharacters_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Chapter02GeometryPrimitives/TextSpecialCharacters_JavaExport.x3d";
String filenameX3DV = "Chapter02GeometryPrimitives/TextSpecialCharacters_JavaExport.x3dv";
String filenameJSON = "Chapter02GeometryPrimitives/TextSpecialCharacters_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}