package X3dForAdvancedModeling.UserExperienceUX;
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.Networking.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* <p> Display Anchor-linked instructions as Text and include transparent Box to simplify user selection. Authors can change the Material transparency value to view the Box, which helps when resizing it to fit the Text. </p>
<p> Related links: Catalog page <a href="../../../UserExperienceUX/SelectableTextTransparentBoxIndex.html" target="_blank">SelectableTextTransparentBox</a>, source <a href="../../../UserExperienceUX/SelectableTextTransparentBox.java">SelectableTextTransparentBox.java</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dResources.html" target="_blank">X3D Resources</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html" target="_blank">X3D Scene Authoring Hints</a>, and <a href="https://www.web3d.org/x3d/content/X3dTooltips.html" target="_blank">X3D Tooltips</a>. </p>
<table style="color:black; border:0px solid; border-spacing:10px 0px;">
<caption>Scene Meta Information</caption>
<tr style="background-color:silver; border-color:silver;">
<td style="text-align:center; padding:10px 0px;"><i>meta tags</i></td>
<td style="text-align:left; padding:10px 0px;"> Document Metadata </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> title </i> </td>
<td> <a href="../../../UserExperienceUX/SelectableTextTransparentBox.x3d">SelectableTextTransparentBox.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
<td> Display Anchor-linked instructions as Text and include transparent Box to simplify user selection. Authors can change the Material transparency value to view the Box, which helps when resizing it to fit the Text. </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
<td> Don Brutzman </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
<td> 9 February 2014 </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
<td> 31 October 2021 </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> info </i> </td>
<td> SelectableText design pattern is available using Shape customizer in X3D-Edit. </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> Image </i> </td>
<td> <a href="../../../UserExperienceUX/SelectableTextExampleOutput.png">SelectableTextExampleOutput.png</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> Image </i> </td>
<td> <a href="https://savage.nps.edu/X3D-Edit/images/ShapeCustomizer.png" target="_blank">https://savage.nps.edu/X3D-Edit/images/ShapeCustomizer.png</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
<td> <a href="https://x3dgraphics.com" target="_blank">https://x3dgraphics.com</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
<td> <a href="https://www.web3d.org/x3d/content/examples/X3dResources.html" target="_blank">https://www.web3d.org/x3d/content/examples/X3dResources.html</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> identifier </i> </td>
<td> <a href="https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/UserExperienceUX/SelectableTextTransparentBox.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/UserExperienceUX/SelectableTextTransparentBox.x3d</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
<td> X3D-Edit, <a href="https://savage.nps.edu/X3D-Edit" target="_blank">https://savage.nps.edu/X3D-Edit</a> </td>
</tr>
<tr>
<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
<td> <a href="../../../UserExperienceUX/../license.html">../license.html</a> </td>
</tr>
<tr style="background-color:silver; border-color:silver;">
<td style="text-align:center;" colspan="2"> </td>
</tr>
</table>
<p>
This program uses the
<a href="https://www.web3d.org/specifications/java/X3DJSAIL.html" target="_blank">X3D Java Scene Access Interface Library (X3DJSAIL)</a>.
It has been produced using the
<a href="https://www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">X3dToJava.xslt</a>
stylesheet
(<a href="https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">version control</a>)
which is used to create Java source code from an original <code>.x3d</code> model.
</p>
* @author Don Brutzman
*/
public class SelectableTextTransparentBox
{
/** Default constructor to create this object. */
public SelectableTextTransparentBox ()
{
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("SelectableTextTransparentBox.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Display Anchor-linked instructions as Text and include transparent Box to simplify user selection. Authors can change the Material transparency value to view the Box, which helps when resizing it to fit the Text."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("9 February 2014"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("31 October 2021"))
.addMeta(new meta().setName(meta.NAME_INFO ).setContent("SelectableText design pattern is available using Shape customizer in X3D-Edit."))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("SelectableTextExampleOutput.png"))
.addMeta(new meta().setName(meta.NAME_IMAGE ).setContent("https://savage.nps.edu/X3D-Edit/images/ShapeCustomizer.png"))
.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_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/UserExperienceUX/SelectableTextTransparentBox.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit, https://savage.nps.edu/X3D-Edit"))
.addMeta(new meta().setName(meta.NAME_LICENSE ).setContent("../license.html")))
.setScene(new Scene()
.addChild(new WorldInfo().setTitle("SelectableTextTransparentBox.x3d"))
.addChild(new Background().setSkyColor(new MFColor(new double[] {0.0,0.333333,0.66667})))
.addChild(new Anchor().setDescription("select text to view scene").setUrl(new String[] {"../HelloWorld.x3d","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/HelloWorld.x3d","../HelloWorld.wrl","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/HelloWorld.wrl"})
.addChild(new Shape()
.setGeometry(new Text().setString(new String[] {"Users can easily select Text","when a transparent Box is","overlaid behind it.","","Select this anchored text box","to see HelloWorld.x3d model"})
.addComments(" Text string \"\" means to skip a line, each quoted string is rendered on a separate line. ")
.setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.75).setCssStyle("BOLD")))
.setAppearance(new Appearance()
.setMaterial(new Material().setDiffuseColor(1.0,0.9,0.4))))
.addComments(" Invisible box behind text makes user selection (and mouse-over hovering for tooltips) easier. ")
.addChild(new Shape()
.setGeometry(new Box().setSize(10.0,4.0,0.1))
.setAppearance(new Appearance()
.addComments(" Change Material transparency='0.8' to see and adjust the size of the Box in order to fit the Text. ")
.setMaterial(new Material().setTransparency(1))))));
}
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
* <a href="https://dzone.com/articles/java-copy-shallow-vs-deep-in-which-you-will-swim" target="_blank">shallow copy</a>
* of the X3D model.
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html">X3D</a>
* @return SelectableTextTransparentBox 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 <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#handleArguments-java.lang.String:A-">X3D.handleArguments(args)</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#validationReport--">X3D.validationReport()</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html">CommandLine</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html#USAGE">CommandLine.USAGE</a>
* @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/ConfigurationProperties.html">ConfigurationProperties</a>
*/
public static void main(String args[])
{
System.out.println("Build this X3D model, showing validation diagnostics...");
X3D thisExampleX3dModel = new SelectableTextTransparentBox().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: \"X3dForAdvancedModeling.UserExperienceUX.SelectableTextTransparentBox\" 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("X3dForAdvancedModeling.UserExperienceUX.SelectableTextTransparentBox self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// UserExperienceUX/SelectableTextTransparentBox_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "UserExperienceUX/SelectableTextTransparentBox_JavaExport.x3d";
String filenameX3DV = "UserExperienceUX/SelectableTextTransparentBox_JavaExport.x3dv";
String filenameJSON = "UserExperienceUX/SelectableTextTransparentBox_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}