package Savage.Tools.HeadsUpDisplays;
import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Grouping.*;
import org.web3d.x3d.jsail.Scripting.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;
// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
* Digital Virtual Display (DVD) Controller interface example to control a scenario's animation timing, defined using an ExternProtoDeclare for easy reuse.
Related links: Catalog page DvdControllerExample, source DvdControllerExample.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 Jane Wu, Don Brutzman
*/
public class DvdControllerExample
{
/** Default constructor to create this object. */
public DvdControllerExample ()
{
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_0)
.setHead(new head()
.addMeta(new meta().setName(meta.NAME_TITLE ).setContent("DvdControllerExample.x3d"))
.addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("Digital Virtual Display (DVD) Controller interface example to control a scenario's animation timing, defined using an ExternProtoDeclare for easy reuse."))
.addMeta(new meta().setName(meta.NAME_CREATOR ).setContent("Jane Wu, Don Brutzman"))
.addMeta(new meta().setName(meta.NAME_CREATED ).setContent("10 November 2001"))
.addMeta(new meta().setName(meta.NAME_MODIFIED ).setContent("5 March 2024"))
.addMeta(new meta().setName(meta.NAME_SUBJECT ).setContent("DvdController animation control"))
.addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/DvdControllerExample.x3d"))
.addMeta(new meta().setName(meta.NAME_GENERATOR ).setContent("X3D-Edit 4.0, 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("DvdControllerExample.x3d"))
.addChild(new ExternProtoDeclare("DvdController").setName("DvdController").setAppinfo("Digital Virtual Display (DVD) Controller Prototype is a heads=up display (HUD) to control animation timing").setUrl(new String[] {"DvdControllerPrototype.x3d#DvdController","../../../Savage/Tools/HeadsUpDisplays/DvdControllerPrototype.x3d#DvdController","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/DvdControllerPrototype.x3d#DvdController","DvdControllerPrototype.wrl#DvdController","../../../Savage/Tools/HeadsUpDisplays/DvdControllerPrototype.wrl#DvdController","https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/DvdControllerPrototype.wrl#DvdController"})
.addField(new field().setName("description").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Short description of what is animated by this DvdController."))
.addField(new field().setName("playEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Whether or not play mode is enabled including during startup."))
.addField(new field().setName("displayMode").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Initializes how control buttons and slider are displayed. The control buttons include DIS control (i.e. Master Ghost Local) and Playback control (i.e. Reset to Start Fast Rewind Rewind Pause Play Fast Forward Reset to End). Possible values are (case sensitive): ALL DIS_ONLY PLAYBACK_ONLY SLIDER_ONLY DIS_PLAYBACK DIS_SLIDER PLAYBACK_SLIDER and NONE."))
.addField(new field().setName("setDisplayMode").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_INPUTONLY).setAppinfo("Sets how control buttons and slider are displayed. The control buttons include DIS control (i.e. Master Ghost Local) and Playback control (i.e. Reset to Start Fast Rewind Rewind Pause Play Fast Forward Reset to End). Possible values are (case sensitive): ALL DIS_ONLY PLAYBACK_ONLY SLIDER_ONLY DIS_PLAYBACK DIS_SLIDER PLAYBACK_SLIDER and NONE."))
.addField(new field().setName("buttonColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Default button color."))
.addField(new field().setName("selectedButtonColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Button color when selected by user."))
.addField(new field().setName("labelColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Default label color."))
.addField(new field().setName("selectedLabelColor").setType(field.TYPE_SFCOLOR).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Label color when selected by user."))
.addField(new field().setName("locationOffset").setType(field.TYPE_SFVEC3F).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Modified screen location and distance (for size)."))
.addField(new field().setName("clockEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY))
.addField(new field().setName("cycleInterval").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Time for complete loop cycle in seconds."))
.addField(new field().setName("set_cycleInterval").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("cycleInterval_changed").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("speedFactor").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Factor used to determine the speed increase/decrease for Fast Rewind and Fast Forward action."))
.addField(new field().setName("isActive").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("startTime_changed").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("stopTime_changed").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("time_changed").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("fraction_changed").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("secondsElapsed").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("isMaster").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("isMaster isRemote and isLocal are booleans represent a 3-way toggle. Only one of them can have a true value at any time."))
.addField(new field().setName("isRemote").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("isMaster isRemote and isLocal are booleans represent a 3-way toggle. Only one of them can have a true value at any time."))
.addField(new field().setName("isLocal").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("isMaster isRemote and isLocal are booleans represent a 3-way toggle. Only one of them can have a true value at any time."))
.addField(new field().setName("isPaused").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("isPaused and isRunning always have opposite values. When isPaused is true isRunning will be false and vice versa."))
.addField(new field().setName("isRunning").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY).setAppinfo("isPaused and isRunning always have opposite values. When isPaused is true isRunning will be false and vice versa."))
.addField(new field().setName("traceEnabled").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("Enable/disable console output for troubleshooting."))
.addField(new field().setName("testTimeVal").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY)))
.addChild(new ExternProtoDeclare("SingleTypeConversion").setName("SingleTypeConversion").setAppinfo("SingleTypeConversion converts from a single typed value to various other types of values").setUrl(new String[] {"../../../Savage/Tools/Authoring/SingleTypeConversionPrototype.x3d#SingleTypeConversion","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/SingleTypeConversionPrototype.x3d#SingleTypeConversion","../../../Savage/Tools/Authoring/SingleTypeConversionPrototype.wrl#SingleTypeConversion","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/SingleTypeConversionPrototype.wrl#SingleTypeConversion"})
.addField(new field().setName("decimalPlaces").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setAppinfo("decimalPlaces is the number of significant digits after the decimal point. The -1 value indicates no round off."))
.addField(new field().setName("setDecimalPlaces").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("BooleanValue").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("FloatValue").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("IntegerValue").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("TimeValue").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("BooleanResult").setType(field.TYPE_SFBOOL).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("FloatResult").setType(field.TYPE_SFFLOAT).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("IntegerResult").setType(field.TYPE_SFINT32).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("TimeResult").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("StringResult").setType(field.TYPE_SFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY))
.addField(new field().setName("StringsResult").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addComments(" ============================== ")
.addChild(new Transform()
.addChild(new ProtoInstance("DvdController", "DvdControllerInterface").setContainerField("children")
.addFieldValue(new fieldValue().setName("displayMode").setValue("PLAYBACK_SLIDER"))
.addFieldValue(new fieldValue().setName("playEnabled").setValue(true))
.addFieldValue(new fieldValue().setName("buttonColor").setValue(new SFColor(0.655,0.655,0.655)))
.addFieldValue(new fieldValue().setName("selectedButtonColor").setValue(new SFColor(0.675,0.675,0.675)))
.addFieldValue(new fieldValue().setName("selectedLabelColor").setValue(new SFColor(0.9,0.0,0.0)))
.addFieldValue(new fieldValue().setName("locationOffset").setValue(new SFVec3f(-5.0,-2.0,0.0)))
.addFieldValue(new fieldValue().setName("cycleInterval").setValue(10))
.addFieldValue(new fieldValue().setName("speedFactor").setValue(10.0))
.addFieldValue(new fieldValue().setName("traceEnabled").setValue(true))))
.addChild(new Transform().setTranslation(-3.0,0.0,0.0)
.addChild(new Transform().setTranslation(-5.0,3.0,-5.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text().setString(new String[] {"fraction_changed:"}))))
.addChild(new Transform().setTranslation(4.0,3.0,-5.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text("FractionText").setString(new String[] {"N/A"}))))
.addChild(new Transform().setTranslation(-5.0,2.0,-5.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text().setString(new String[] {"secondsElapsed:"}))))
.addChild(new Transform().setTranslation(4.0,2.0,-5.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text("SecondsElapsedText").setString(new String[] {"N/A"}))))
.addChild(new Transform().setTranslation(-5.0,1.0,-5.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text("actual_time_changed").setString(new String[] {"local clock time:"}))))
.addChild(new Transform().setTranslation(4.0,1.0,-5.0)
.addChild(new Shape()
.setAppearance(new Appearance()
.setMaterial(new Material()))
.setGeometry(new Text("TimeText").setString(new String[] {"N/A"})))))
.addChild(new Script("TimeTextScript").setSourceCode("""
ecmascript:
function initialize ()
{
tracePrint('initialize () complete');
}
function setCurrentTime(value, timeStamp)
{
tracePrint('setCurrentTime(' + value + ')');
myDate = new Date(); // value unused, causes BS Contact fatal error
if (myDate == null)
{
Browser.println ('[DvdControllerExample TimeTextScript] setCurrentTime() error: class Date not supported');
return;
}
numHour = myDate.getHours();
numMinute = myDate.getMinutes();
numSecond = myDate.getSeconds();
date = myDate.getDate();
monthNumber = myDate.getMonth();
year = myDate.getYear() + 1900;
// javascript switch statement is convenient but not consistently supported, so test the old-fashioned way:
if (monthNumber==0)
{
monthText ='January';
}
else if (monthNumber==1)
{
monthText ='February';
}
else if (monthNumber==2)
{
monthText ='March';
}
else if (monthNumber==3)
{
monthText ='April';
}
else if (monthNumber==4)
{
monthText ='May';
}
else if (monthNumber==5)
{
monthText ='June';
}
else if (monthNumber==6)
{
monthText ='July';
}
else if (monthNumber==7)
{
monthText ='August';
}
else if (monthNumber==8)
{
monthText ='September';
}
else if (monthNumber==9)
{
monthText ='October';
}
else if (monthNumber==10)
{
monthText ='November';
}
else if (monthNumber==11)
{
monthText ='December';
}
else
{
monthText ='(illegal month index)';
}
if (numHour < 10)
hour ='0' + numHour;
else
hour = numHour;
if (numMinute < 10)
minute ='0' + numMinute;
else
minute = numMinute;
numSecond = Math.round(numSecond * 1000.0) / 1000.0;
if (numSecond < 10)
second ='0' + numSecond;
else
second = numSecond;
text = hour + ':' + minute + ':' + second + ', ' + date + ' ' + monthText + ' ' + year;
timeText = new MFString(text);
//deprecated timeText = new MFString(myDate.toGMTString());
tracePrint ('timeText=' + timeText.toString());
}
function tracePrint (text)
{
if (true) Browser.println ('[DvdControllerExample TimeTextScript] ' + text);
}
""")
.addField(new field().setName("time").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INITIALIZEONLY).setValue(-1))
.addField(new field().setName("setCurrentTime").setType(field.TYPE_SFTIME).setAccessType(field.ACCESSTYPE_INPUTONLY))
.addField(new field().setName("timeText").setType(field.TYPE_MFSTRING).setAccessType(field.ACCESSTYPE_OUTPUTONLY)))
.addChild(new ROUTE().setFromNode("DvdControllerInterface").setFromField("time_changed").setToNode("TimeTextScript").setToField("setCurrentTime"))
.addChild(new ROUTE().setFromNode("TimeTextScript").setFromField("timeText").setToNode("TimeText").setToField("set_string"))
.addChild(new ProtoInstance("SingleTypeConversion", "FractionConverter").setContainerField("children")
.addFieldValue(new fieldValue().setName("decimalPlaces").setValue(2)))
.addChild(new ROUTE().setFromNode("DvdControllerInterface").setFromField("fraction_changed").setToNode("FractionConverter").setToField("FloatValue"))
.addChild(new ROUTE().setFromNode("FractionConverter").setFromField("StringsResult").setToNode("FractionText").setToField("set_string"))
.addChild(new ProtoInstance("SingleTypeConversion", "SecondsConverter").setContainerField("children")
.addFieldValue(new fieldValue().setName("decimalPlaces").setValue(2)))
.addChild(new ROUTE().setFromNode("DvdControllerInterface").setFromField("secondsElapsed").setToNode("SecondsConverter").setToField("TimeValue"))
.addChild(new ROUTE().setFromNode("SecondsConverter").setFromField("StringsResult").setToNode("SecondsElapsedText").setToField("set_string")));
}
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 DvdControllerExample 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 DvdControllerExample().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.HeadsUpDisplays.DvdControllerExample\" 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.HeadsUpDisplays.DvdControllerExample self-validation test confirmation: ");
if (!validationResults.equals("success"))
System.out.println();
System.out.println(validationResults.trim());
// experimental: test X3DJSAIL output files
// Tools/HeadsUpDisplays/DvdControllerExample_JavaExport.* file validation is checked when building X3D Example Archives
String filenameX3D = "Tools/HeadsUpDisplays/DvdControllerExample_JavaExport.x3d";
String filenameX3DV = "Tools/HeadsUpDisplays/DvdControllerExample_JavaExport.x3dv";
String filenameJSON = "Tools/HeadsUpDisplays/DvdControllerExample_JavaExport.json";
thisExampleX3dModel.toFileX3D (filenameX3D);
thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO thisExampleX3dModel.toFileJSON (filenameJSON);
}
}
}