public class X3DObject extends X3DConcreteStatement
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT
String constant COMPONENT defines X3D component for the X3D element: Core
|
static java.lang.String |
FILE_EXTENSION_CLASSICVRML
File extension for X3D ClassicVRML Encoding, with dot prepended: .x3dv
|
static java.lang.String |
FILE_EXTENSION_EXI
File extension for Efficient XML Interchange (EXI) compressed XML file, with dot prepended: .exi
|
static java.lang.String |
FILE_EXTENSION_GZIP
File extension for GZIP compressed file, with dot prepended: .gz
|
static java.lang.String |
FILE_EXTENSION_HTML
File extension for HTML Encoding, with dot prepended: .html
|
static java.lang.String |
FILE_EXTENSION_JAVA
File extension for Java source code, with dot prepended: .java
|
static java.lang.String |
FILE_EXTENSION_JAVASCRIPT
File extension for JavaScript source code, with dot prepended: .js
|
static java.lang.String |
FILE_EXTENSION_JSON
File extension for JavaScript Object Notation (JSON) source data, with dot prepended: .json
|
static java.lang.String |
FILE_EXTENSION_MARKDOWN
File extension for markdown encoding, with dot prepended: .md
|
static java.lang.String |
FILE_EXTENSION_SVG
File extension for Scalable Vector Graphics (SVG), with dot prepended: .svg
|
static java.lang.String |
FILE_EXTENSION_TEXT
File extension for text files, with dot prepended: .txt
|
static java.lang.String |
FILE_EXTENSION_VRML97
File extension for VRML97 Encoding, with dot prepended: .wrl
|
static java.lang.String |
FILE_EXTENSION_X3D
File extension for X3D XML Encoding, with dot prepended: .x3d
|
static java.lang.String |
FILE_EXTENSION_X3DB
File extension for X3D Compressed Binary Encoding, with dot prepended: .x3db
|
static java.lang.String |
FILE_EXTENSION_XHTML
File extension for XHTML Encoding, with dot prepended: .xhtml
|
static java.lang.String |
FILE_EXTENSION_XML
File extension for Extensible Markup Language, with dot prepended: .xml
|
static java.lang.String |
FILE_EXTENSION_ZIP
File extension for ZIP compressed file, with dot prepended: .zip
|
static int |
LEVEL
Integer constant LEVEL provides default X3D Core component level for this element: 1
|
static java.lang.String |
NAME
String constant NAME provides name of this element: X3D.
|
static java.lang.String |
PROFILE_CADINTERCHANGE
SFString field named profile can equal this enumeration value "CADInterchange" (Java syntax) or CADInterchange (XML syntax).
|
static java.lang.String |
PROFILE_CORE
SFString field named profile can equal this enumeration value "Core" (Java syntax) or Core (XML syntax).
|
static java.lang.String |
PROFILE_DEFAULT_VALUE
SFString field named profile has default value "Immersive" (Java syntax) or Immersive (XML syntax).
|
static java.lang.String |
PROFILE_FULL
SFString field named profile can equal this enumeration value "Full" (Java syntax) or Full (XML syntax).
|
static java.lang.String |
PROFILE_IMMERSIVE
SFString field named profile can equal this enumeration value "Immersive" (Java syntax) or Immersive (XML syntax).
|
static java.lang.String |
PROFILE_INTERACTIVE
SFString field named profile can equal this enumeration value "Interactive" (Java syntax) or Interactive (XML syntax).
|
static java.lang.String |
PROFILE_INTERCHANGE
SFString field named profile can equal this enumeration value "Interchange" (Java syntax) or Interchange (XML syntax).
|
static java.lang.String |
PROFILE_MEDICALINTERCHANGE
SFString field named profile can equal this enumeration value "MedicalInterchange" (Java syntax) or MedicalInterchange (XML syntax).
|
static java.lang.String |
PROFILE_MPEG4INTERACTIVE
SFString field named profile can equal this enumeration value "MPEG4Interactive" (Java syntax) or MPEG4Interactive (XML syntax).
|
static java.lang.String |
VERSION_3_0
SFString field named version can equal this enumeration value "3.0" (Java syntax) or 3.0 (XML syntax).
|
static java.lang.String |
VERSION_3_1
SFString field named version can equal this enumeration value "3.1" (Java syntax) or 3.1 (XML syntax).
|
static java.lang.String |
VERSION_3_2
SFString field named version can equal this enumeration value "3.2" (Java syntax) or 3.2 (XML syntax).
|
static java.lang.String |
VERSION_3_3
SFString field named version can equal this enumeration value "3.3" (Java syntax) or 3.3 (XML syntax).
|
static java.lang.String |
VERSION_4_0
SFString field named version can equal this enumeration value "4.0" (Java syntax) or 4.0 (XML syntax).
|
static java.lang.String |
VERSION_DEFAULT_VALUE
SFString field named version has default value "3.3" (Java syntax) or 3.3 (XML syntax).
|
static java.lang.String |
X3D_XML_SCHEMA_3_0_ATTRIBUTES
XML Schema attributes for X3D element.
|
static java.lang.String |
X3D_XML_SCHEMA_3_1_ATTRIBUTES
XML Schema attributes for X3D element.
|
static java.lang.String |
X3D_XML_SCHEMA_3_2_ATTRIBUTES
XML Schema attributes for X3D element.
|
static java.lang.String |
X3D_XML_SCHEMA_3_3_ATTRIBUTES
XML Schema attributes for X3D element.
|
static java.lang.String |
X3D_XML_SCHEMA_4_0_ATTRIBUTES
XML Schema attributes for X3D element.
|
static java.lang.String |
X3D_XML_SCHEMA_4_1_ATTRIBUTES
XML Schema attributes for X3D element.
|
static java.lang.String |
XML_DOCTYPE_X3D_3_0
XML document type declaration.
|
static java.lang.String |
XML_DOCTYPE_X3D_3_1
XML document type declaration.
|
static java.lang.String |
XML_DOCTYPE_X3D_3_2
XML document type declaration.
|
static java.lang.String |
XML_DOCTYPE_X3D_3_3
XML document type declaration.
|
static java.lang.String |
XML_DOCTYPE_X3D_4_0
XML document type declaration.
|
static java.lang.String |
XML_DOCTYPE_X3D_4_1
XML document type declaration.
|
static java.lang.String |
XML_HEADER
XML declaration appears on first line of an XML document.
|
validationResult| Constructor and Description |
|---|
X3DObject()
Constructor for X3DObject to initialize member variables with default values.
|
| Modifier and Type | Method and Description |
|---|---|
X3DObject |
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.
|
X3DObject |
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.
|
X3DObject |
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.
|
X3DObject |
clearHead()
Utility method to clear SFNode value of head field.
|
X3DObject |
clearScene()
Utility method to clear SFNode value of Scene field.
|
static boolean |
fileNameMeetsX3dNamingConventions(java.lang.String fileName)
Check whether fileName meets X3D naming conventions, ignoring prior path (if any).
|
X3DConcreteElement |
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
|
X3DConcreteElement |
findElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
|
X3DConcreteNode |
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
|
boolean |
fromFileEXI(java.lang.String exiFileName)
Load new model from an EXI file, using unzip to extract the model plus any associated files into the same path location.
|
boolean |
fromFileGZIP(java.lang.String gzipFileName)
Load new model from a gz gzip file, using ungzip to extract the model into the same path location.
|
boolean |
fromFileZIP(java.lang.String zipFileName,
java.lang.String outputFileName)
Load new model from a zip file, using unzip to extract the model plus any associated files into the same path location.
|
boolean |
fromFileZIP(java.lang.String zipFileName,
java.lang.String outputFileName,
java.lang.String modelFileName)
Load new model from a zip file, using unzip to extract the model plus any associated files into the same path location.
|
java.lang.String |
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.
|
java.lang.String |
getComponent()
Defines X3D component for the X3D element: Core
|
int |
getComponentLevel()
Provides default X3D component level for this element: 1
|
java.lang.String |
getElementName()
Provides name of this element: X3D
|
java.lang.String |
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.
|
headObject |
getHead()
Provide headObject instance (using a properly typed node) from inputOutput SFNode field head.
|
java.lang.String |
getProfile()
Provide String enumeration value ['Core'|'Interchange'|'CADInterchange'|'Interactive'|'Immersive'|'MedicalInterchange'|'MPEG4Interactive'|'Full'] from inputOutput SFString field named profile.
|
SceneObject |
getScene()
Provide SceneObject instance (using a properly typed node) from inputOutput SFNode field Scene.
|
java.lang.String |
getVersion()
Provide String enumeration value ['3.0'|'3.1'|'3.2'|'3.3'|'4.0'] from inputOutput SFString field named version.
|
void |
handleArguments(java.lang.String[] args)
Utility method for standalone programs that get created with stylesheet X3dToJava.xslt,
also sets loaded X3D model in global CommandLine to this X3DObject.
|
boolean |
hasElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
|
boolean |
hasHead()
Indicate whether an object is available for inputOutput SFNode field head.
|
boolean |
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
|
boolean |
hasScene()
Indicate whether an object is available for inputOutput SFNode field Scene.
|
void |
initialize()
Initialize all member variables to default values.
|
boolean |
isEmpty()
Determine if this X3D model is empty and no content is present.
|
static boolean |
isFileNameNMTOKEN(java.lang.String fileName)
Check whether fileName is satisfactory NMTOKEN, ignoring prior path (if any).
|
boolean |
loadModelFromFileX3D(java.io.File x3dFile)
Load X3D model from file to initialize or replace contents of this X3DObject.
|
boolean |
loadModelFromFileX3D(java.lang.String fileName)
Load X3D model from file to initialize or replace contents of this X3DObject.
|
boolean |
loadModelFromFileX3D(java.lang.String path,
java.lang.String fileName)
Load X3D model from file to initialize or replace contents of this X3DObject.
|
boolean |
replace(X3DObject newX3DObject)
Replaces current X3DObject with new X3DObject.
|
X3DObject |
setHead(headObject newValue)
Assign headObject instance (using a properly typed node) to inputOutput SFNode field head.
|
void |
setIncludeSubdirectoryPaths(boolean value) |
X3DObject |
setProfile(SFStringObject newValue)
Assign typed object value to SFString profile field, similar to
setProfile(String). |
X3DObject |
setProfile(java.lang.String newValue)
Assign String enumeration value ("Core"|"Interchange"|"CADInterchange"|"Interactive"|"Immersive"|"MedicalInterchange"|"MPEG4Interactive"|"Full") ['Core'|'Interchange'|'CADInterchange'|'Interactive'|'Immersive'|'MedicalInterchange'|'MPEG4Interactive'|'Full'] to inputOutput SFString field named profile.
|
X3DObject |
setScene(SceneObject newValue)
Assign SceneObject instance (using a properly typed node) to inputOutput SFNode field Scene.
|
X3DObject |
setVersion(SFStringObject newValue)
Assign typed object value to SFString version field, similar to
setVersion(String). |
X3DObject |
setVersion(java.lang.String newValue)
Assign String enumeration value ("3.0"|"3.1"|"3.2"|"3.3"|"4.0") ['3.0'|'3.1'|'3.2'|'3.3'|'4.0'] to inputOutput SFString field named version.
|
java.io.File |
toFileClassicVRML(java.lang.String fileName)
Serialize scene graph using toStringClassicVRML() to create a new X3D file with extension x3dv.
|
java.io.File |
toFileCobweb(java.lang.String sourceSceneName,
java.lang.String resultFileName)
Deprecated.
|
java.io.File |
toFileEXI(java.lang.String resultFileName)
Save current model as an EXI file.
|
java.io.File |
toFileGZIP(java.lang.String resultFileName)
Save current model as a GZIP file.
|
java.io.File |
toFileHtmlDocumentation(java.lang.String fileName)
Serialize scene graph using toFileX3D() and then create a new pretty-print HTML file with extension .html, suitable for documentation purposes.
|
java.io.File |
toFileJava(java.lang.String fileName)
Serialize scene graph using X3dToJava.xslt stylesheet to create a new Java source file with extension java, no default license included.
|
java.io.File |
toFileJava(java.lang.String fileName,
boolean includeWeb3dLicense)
Serialize scene graph using X3dToJava.xslt stylesheet to create a new Java source file with extension java.
|
java.io.File |
toFileJavaScript(java.lang.String fileName)
Serialize scene graph using JavaScriptSerializer.js to create a JavaScript file.
|
java.io.File |
toFileJSON(java.lang.String fileName)
Serialize scene graph using X3dToJson.xslt stylesheet to create a new JSON-encoding X3D file with extension json.
|
java.io.File |
toFileModelMetaMarkdown(java.lang.String fileName)
Create model meta information as `name`=`value` pairs, providing markdown output as an output file having extension .md.
|
java.io.File |
toFileStylesheetConversion(java.lang.String stylesheetName,
java.lang.String fileName)
Utility method for toFileStylesheetConversion() with no stylesheet parameters.
|
java.io.File |
toFileStylesheetConversion(java.lang.String stylesheetName,
java.lang.String fileName,
java.lang.String parameterName1,
java.lang.String parameterValue1)
Utility method for toFileStylesheetConversion() with a single stylesheet name=value parameter pair.
|
java.io.File |
toFileStylesheetConversion(java.lang.String stylesheetName,
java.lang.String fileName,
java.lang.String parameterName1,
java.lang.String parameterValue1,
java.lang.String parameterName2,
java.lang.String parameterValue2)
Serialize scene graph using toFileX3D() and then create a new file with corresponding filename extension (e.g.
|
java.io.File |
toFileVRML97(java.lang.String fileName)
Serialize scene graph using toStringVRML97() to create a new X3D file with extension wrl.
|
java.io.File |
toFileX_ITE(java.lang.String sourceSceneName,
java.lang.String resultFileName)
Create displayable scene page rendered with X_ITE (formerly Cobweb) using STYLESHEET_X3DOM and special settings, by serializing XML syntax within an XHTML file having extension .xhtml.
|
java.io.File |
toFileX3D(java.lang.String fileName)
Serialize scene graph using toStringX3D() to create a new XML-encoding X3D file with extension x3d or xml.
|
java.io.File |
toFileX3DOM(java.lang.String fileName)
Create displayable scene page rendered with X3DOM, using STYLESHEET_X3DOM by serializing XML syntax within an XHTML file having extension .xhtml.
|
java.io.File |
toFileX3dTidy(java.lang.String fileName)
Create alternate cleaned-up X3D scene using STYLESHEET_X3DTIDY within an output file having extension .x3d.
|
java.io.File |
toFileXML(java.lang.String fileName)
Serialize scene graph using toStringX3D() to create a new XML-encoding X3D file with extension x3d or xml.
|
java.io.File |
toFileZIP(java.lang.String zipFileName,
java.lang.String modelName)
Save current model as a ZIP file.
|
java.lang.String |
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.
|
java.lang.String |
toStringHtmlDocumentation()
Serialize scene graph using STYLESHEET_htmlDocumentation to create a new X3DOM html page as a string.
|
java.lang.String |
toStringJava()
Serialize scene graph using toFileJava() to create new Java source as a string.
|
java.lang.String |
toStringJavaScript()
Serialize scene graph using JavaScriptSerializer.js to create a JavaScript string.
|
java.lang.String |
toStringJSON()
Serialize scene graph using X3dToJson.xslt stylesheet to create a new JSON-encoding string.
|
java.lang.String |
toStringModelMetaMarkdown()
Produce model meta information as `name`=`value` pairs, providing markdown output as a string.
|
java.lang.String |
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.
|
java.lang.String |
toStringX_ITE(java.lang.String sourceSceneName)
Serialize scene graph using STYLESHEET_X3DOM (with appropriate parameters) to create a new X_ITE html page as a string.
|
java.lang.String |
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
|
java.lang.String |
toStringX3DOM()
Serialize scene graph using STYLESHEET_X3DOM to create a new X3DOM html page as a string.
|
java.lang.String |
toStringX3dTidy()
Produce alternate cleaned-up X3D scene using STYLESHEET_X3DTIDY, providing output as a string.
|
java.lang.String |
toStringXML()
Provide XML string serialization of this model subgraph, utilizing X3D XML encoding and conforming to X3D Canonical Form.
|
java.lang.String |
toStringXML(int indentLevel)
Provide XML string serialization of this model subgraph, utilizing X3D XML encoding and conforming to X3D Canonical Form.
|
java.lang.String |
validate()
Recursive method to validate this element plus all contained nodes and statements,
using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
|
java.lang.String |
validationReport()
Provide thorough X3DJSAIL validation results for this X3D model.
|
isNode, isStatementclearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3Dpublic static final java.lang.String XML_HEADER
public static final java.lang.String XML_DOCTYPE_X3D_4_1
public static final java.lang.String XML_DOCTYPE_X3D_4_0
public static final java.lang.String XML_DOCTYPE_X3D_3_3
public static final java.lang.String XML_DOCTYPE_X3D_3_2
public static final java.lang.String XML_DOCTYPE_X3D_3_1
public static final java.lang.String XML_DOCTYPE_X3D_3_0
public static final java.lang.String X3D_XML_SCHEMA_3_0_ATTRIBUTES
public static final java.lang.String X3D_XML_SCHEMA_3_1_ATTRIBUTES
public static final java.lang.String X3D_XML_SCHEMA_3_2_ATTRIBUTES
public static final java.lang.String X3D_XML_SCHEMA_3_3_ATTRIBUTES
public static final java.lang.String X3D_XML_SCHEMA_4_0_ATTRIBUTES
public static final java.lang.String X3D_XML_SCHEMA_4_1_ATTRIBUTES
public static final java.lang.String PROFILE_CORE
public static final java.lang.String PROFILE_INTERCHANGE
public static final java.lang.String PROFILE_CADINTERCHANGE
public static final java.lang.String PROFILE_INTERACTIVE
public static final java.lang.String PROFILE_IMMERSIVE
public static final java.lang.String PROFILE_MEDICALINTERCHANGE
public static final java.lang.String PROFILE_MPEG4INTERACTIVE
public static final java.lang.String PROFILE_FULL
public static final java.lang.String VERSION_3_0
public static final java.lang.String VERSION_3_1
public static final java.lang.String VERSION_3_2
public static final java.lang.String VERSION_3_3
public static final java.lang.String VERSION_4_0
public static final java.lang.String NAME
public static final java.lang.String COMPONENT
public static final int LEVEL
public static final java.lang.String PROFILE_DEFAULT_VALUE
public static final java.lang.String VERSION_DEFAULT_VALUE
public static final java.lang.String FILE_EXTENSION_X3D
public static final java.lang.String FILE_EXTENSION_CLASSICVRML
public static final java.lang.String FILE_EXTENSION_X3DB
public static final java.lang.String FILE_EXTENSION_VRML97
public static final java.lang.String FILE_EXTENSION_XML
public static final java.lang.String FILE_EXTENSION_SVG
public static final java.lang.String FILE_EXTENSION_HTML
public static final java.lang.String FILE_EXTENSION_MARKDOWN
public static final java.lang.String FILE_EXTENSION_XHTML
public static final java.lang.String FILE_EXTENSION_TEXT
public static final java.lang.String FILE_EXTENSION_JAVA
public static final java.lang.String FILE_EXTENSION_JAVASCRIPT
public static final java.lang.String FILE_EXTENSION_JSON
public static final java.lang.String FILE_EXTENSION_EXI
public static final java.lang.String FILE_EXTENSION_GZIP
public static final java.lang.String FILE_EXTENSION_ZIP
public X3DObject()
public final java.lang.String getElementName()
getElementName in class X3DConcreteElementpublic final java.lang.String getComponent()
getComponent in class X3DConcreteElementpublic final int getComponentLevel()
getComponentLevel in class X3DConcreteElementpublic java.lang.String getFieldType(java.lang.String fieldName)
getFieldType in class X3DConcreteElementfieldName - name of field in this X3D statementConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPEpublic java.lang.String getAccessType(java.lang.String fieldName)
getAccessType in class X3DConcreteElementfieldName - name of field in this X3D statementConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPEpublic final void initialize()
initialize in class X3DConcreteStatementpublic java.lang.String toStringXML()
FILE_EXTENSION_X3D,
FILE_EXTENSION_XML,
toStringXML(),
toFileXML(String),
toFileX3D(String),
X3D XML Encoding,
X3D Compressed Binary Encoding: X3D Canonical Formpublic java.lang.String toStringXML(int indentLevel)
indentLevel - number of levels of indentation for this elementFILE_EXTENSION_X3D,
FILE_EXTENSION_XML,
toStringXML(),
toFileXML(String),
toFileX3D(String),
X3D XML Encoding,
X3D Compressed Binary Encoding: X3D Canonical Formpublic java.io.File toFileXML(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .x3dtoStringXML(),
toFileXML(String),
toFileX3D(String),
Buffered I/O Methods for Text Filespublic static boolean isFileNameNMTOKEN(java.lang.String fileName)
fileName - name of file to checkSFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String)public static boolean fileNameMeetsX3dNamingConventions(java.lang.String fileName)
fileName - name of file to checkSFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String)public java.io.File toFileX3D(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .x3dX3DConcreteElement.toStringX3D(),
toStringXML(),
toFileXML(String),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String),
Buffered I/O Methods for Text Filespublic java.io.File toFileClassicVRML(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .x3dvX3DConcreteElement.toStringClassicVRML(),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String),
Buffered I/O Methods for Text Filespublic java.io.File toFileVRML97(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .wrlX3DConcreteElement.toStringVRML97(),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String),
Buffered I/O Methods for Text Filespublic java.io.File toFileStylesheetConversion(java.lang.String stylesheetName,
java.lang.String fileName)
stylesheetName - name of stylesheet to applyfileName - name of file to create and save, can include local directory path, must end with allowed file extension (e.g. ".html")public java.io.File toFileStylesheetConversion(java.lang.String stylesheetName,
java.lang.String fileName,
java.lang.String parameterName1,
java.lang.String parameterValue1)
stylesheetName - name of stylesheet to applyfileName - name of file to create and save, can include local directory path, must end with allowed file extension (e.g. ".html")parameterName1 - first stylesheet parameter nameparameterValue1 - first stylesheet parameter valuepublic java.io.File toFileStylesheetConversion(java.lang.String stylesheetName,
java.lang.String fileName,
java.lang.String parameterName1,
java.lang.String parameterValue1,
java.lang.String parameterName2,
java.lang.String parameterValue2)
stylesheetName - name of stylesheet to applyfileName - name of file to create and save, can include local directory path, must end with allowed file extension (e.g. ".html")parameterName1 - first stylesheet parameter nameparameterValue1 - first stylesheet parameter valueparameterName2 - second stylesheet parameter nameparameterValue2 - second stylesheet parameter valueX3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileJSON(String),
toFileX3DOM(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String),
ConfigurationProperties.X3DJSAIL_JAR_RELEASE_VERSIONS,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic java.io.File toFileHtmlDocumentation(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .htmlConfigurationProperties.STYLESHEET_htmlDocumentation,
ConfigurationProperties.STYLESHEET_extrusionCrossSectionSVG,
X3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileJSON(String),
toFileX3DOM(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic java.lang.String toStringJSON()
toFileJSON(String),
ConfigurationProperties.isNormalizeCommentWhitespace(),
X3D JSON Encoding,
X3D to JSON Stylesheet Converterpublic java.lang.String toStringJava()
toFileJava(String)public java.lang.String toStringJavaScript()
toFileJavaScript(String)public java.io.File toFileJavaScript(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .jstoStringJavaScript(),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String)public java.lang.String toStringHtmlDocumentation()
toFileHtmlDocumentation(String),
FILE_EXTENSION_HTML,
FILE_EXTENSION_XHTML,
ConfigurationProperties.STYLESHEET_htmlDocumentation,
X3DOM open-source X3D playerpublic java.lang.String toStringModelMetaMarkdown()
toFileModelMetaMarkdown(String),
FILE_EXTENSION_MARKDOWN,
ConfigurationProperties.STYLESHEET_MODEL_META_TO_MARKDOWNpublic java.lang.String toStringX3dTidy()
toFileX3dTidy(String),
FILE_EXTENSION_X3D,
ConfigurationProperties.STYLESHEET_X3DTIDY,
X3D Tidy for Scene Cleanup, Corrections and Modificationspublic java.lang.String toStringX3DOM()
toFileX3DOM(String),
FILE_EXTENSION_HTML,
FILE_EXTENSION_XHTML,
ConfigurationProperties.STYLESHEET_X3DOM,
X3DOM open-source X3D playerpublic java.lang.String toStringX_ITE(java.lang.String sourceSceneName)
sourceSceneName - X3D file to load and viewtoFileX_ITE(String,String),
X_ITE open-source X3D player,
FILE_EXTENSION_HTML,
FILE_EXTENSION_XHTML,
ConfigurationProperties.STYLESHEET_X3DOM,
ConfigurationProperties.STYLESHEET_X_ITEpublic java.io.File toFileJSON(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .htmltoStringJSON(),
X3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileHtmlDocumentation(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
toFileX3DOM(String),
FILE_EXTENSION_JSON,
FILE_EXTENSION_JAVASCRIPT,
ConfigurationProperties.STYLESHEET_JSON,
ConfigurationProperties.isNormalizeCommentWhitespace(),
X3dToJson.xslt,
examples/HelloWorldProgramOutput.json,
X3D JSON Encoding,
X3D to JSON Stylesheet Converter,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic java.io.File toFileJava(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .htmltoFileJava(String,boolean),
X3dToJava.xslt,
examples/HelloWorldProgramOutput.javapublic java.io.File toFileJava(java.lang.String fileName,
boolean includeWeb3dLicense)
fileName - name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .htmlincludeWeb3dLicense - whether to insert default open-source Web3D license at top of source fileX3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJSON(String),
toFileHtmlDocumentation(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
toFileX3DOM(String),
FILE_EXTENSION_JSON,
FILE_EXTENSION_JAVASCRIPT,
ConfigurationProperties.STYLESHEET_JSON,
X3dToJava.xslt,
examples/HelloWorldProgramOutput.java,
X3D JSON Encoding,
X3D to JSON Stylesheet Converter,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic void setIncludeSubdirectoryPaths(boolean value)
public java.io.File toFileModelMetaMarkdown(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .htmltoStringModelMetaMarkdown(),
X3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileJSON(String),
toFileHtmlDocumentation(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String),
ConfigurationProperties.STYLESHEET_MODEL_META_TO_MARKDOWN,
X3D Tidy for Scene Cleanup, Corrections and Modifications,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic java.io.File toFileX3dTidy(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .htmltoStringX3dTidy(),
X3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileJSON(String),
toFileHtmlDocumentation(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String),
ConfigurationProperties.STYLESHEET_X3DTIDY,
X3D Tidy for Scene Cleanup, Corrections and Modifications,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic java.io.File toFileX3DOM(java.lang.String fileName)
fileName - name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .htmlX3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileJSON(String),
toFileHtmlDocumentation(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
SFStringObject.isNMTOKEN(String),
SFStringObject.meetsX3dInteroperabilityNamingConventions(String),
ConfigurationProperties.STYLESHEET_X3DOM,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic java.io.File toFileX_ITE(java.lang.String sourceSceneName,
java.lang.String resultFileName)
sourceSceneName - X3D file to load and viewresultFileName - name of file to create and save, can include local directory path, must end with .html (preferred) or .xhtmlX3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileJSON(String),
toFileHtmlDocumentation(String),
toFileX3DOM(String),
toFileX_ITE(String,String),
toFileCobweb(String,String),
ConfigurationProperties.STYLESHEET_X3DOM,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Files@Deprecated
public java.io.File toFileCobweb(java.lang.String sourceSceneName,
java.lang.String resultFileName)
sourceSceneName - X3D file to load and viewresultFileName - name of file to create and save, can include local directory path, must end with .html (preferred) or .xhtmlX3DConcreteElement.toStringX3D(),
toFileX3D(String),
toFileJava(String),
toFileJSON(String),
toFileHtmlDocumentation(String),
toFileX3DOM(String),
toFileX_ITE(String,String),
ConfigurationProperties.STYLESHEET_X3DOM,
Saxonica > Saxon > Using XSLT > Invoking XSLT from an application,
Saxon-HE 9.7,
Java Tutorials: Transforming XML Data with XSLT,
Java Tutorials: Transforming XML Data with XSLT, sample files,
Buffered I/O Methods for Text Filespublic boolean fromFileZIP(java.lang.String zipFileName,
java.lang.String outputFileName)
zipFileName - name of zip file to load, can include local directory path, must end with .zipoutputFileName - name of output file to save, can include local directory path, must end with .x3d or .xmlfromFileZIP(String,String,String)public boolean fromFileZIP(java.lang.String zipFileName,
java.lang.String outputFileName,
java.lang.String modelFileName)
modelFileName is provided, then the first .x3d model encountered in the zip file is returned (if any).
zipFileName - name of zip file to load, can include local directory path, must end with .zipoutputFileName - name of output file to save, can include local directory path, must end with .x3d or .xmlmodelFileName - name of model file to load, can include local directory path, must end with .x3dFILE_EXTENSION_EXI,
FILE_EXTENSION_GZIP,
FILE_EXTENSION_ZIP,
fromFileEXI(String),
fromFileGZIP(String),
toFileZIP(String,String),
fromFileZIP(String,String)public boolean fromFileGZIP(java.lang.String gzipFileName)
gzipFileName - name of file to load, can include local directory path, must end with .exiFILE_EXTENSION_EXI,
FILE_EXTENSION_GZIP,
FILE_EXTENSION_ZIP,
fromFileEXI(String),
fromFileZIP(String,String),
toFileGZIP(String)public boolean fromFileEXI(java.lang.String exiFileName)
exiFileName - name of file to load, can include local directory path, must end with .exiConfigurationProperties.getExiEngine(),
ConfigurationProperties.setExiEngine(String),
FILE_EXTENSION_EXI,
FILE_EXTENSION_GZIP,
FILE_EXTENSION_ZIP,
toFileEXI(String),
fromFileZIP(String,String),
fromFileGZIP(String)public boolean isEmpty()
public boolean loadModelFromFileX3D(java.lang.String fileName)
fileName - name of model file that replaces current X3DObjectpublic boolean loadModelFromFileX3D(java.lang.String path,
java.lang.String fileName)
path - directory path to file of interestfileName - name of model file that replaces current X3DObjectpublic boolean loadModelFromFileX3D(java.io.File x3dFile)
x3dFile - model file that replaces current X3DObjectpublic boolean replace(X3DObject newX3DObject)
newX3DObject - replaces current X3DObjectpublic java.io.File toFileEXI(java.lang.String resultFileName)
resultFileName - name of file to create and save, can include local directory path, must end with .exiConfigurationProperties.getExiEngine(),
ConfigurationProperties.setExiEngine(String),
FILE_EXTENSION_EXI,
FILE_EXTENSION_GZIP,
FILE_EXTENSION_ZIP,
fromFileEXI(String),
toFileGZIP(String),
toFileZIP(String,String),
toFileX3D(String)public java.io.File toFileGZIP(java.lang.String resultFileName)
resultFileName - name of file to create and save, can include local directory path, must end with .gz (TODO or .tgz)FILE_EXTENSION_EXI,
FILE_EXTENSION_GZIP,
FILE_EXTENSION_ZIP,
toFileEXI(String),
toFileZIP(String,String),
toFileX3D(String)public java.io.File toFileZIP(java.lang.String zipFileName,
java.lang.String modelName)
zipFileName - name of zip archive file to create and save, can include local directory path, must end with .zipmodelName - name of X3D file to create and save within the .zip archiveFILE_EXTENSION_EXI,
FILE_EXTENSION_GZIP,
FILE_EXTENSION_ZIP,
toFileEXI(String),
toFileGZIP(String),
toFileX3D(String)public java.lang.String validationReport()
public void handleArguments(java.lang.String[] args)
args - command-line argumentsCommandLine,
CommandLine.USAGE,
X3dToJava.xslt,
examples/HelloWorldProgramOutput.javapublic headObject getHead()
public X3DObject setHead(headObject newValue)
newValue - is new value for the head field.X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DObject clearHead()
X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public boolean hasHead()
getHead()public java.lang.String getProfile()
CORE, INTERCHANGE, CADINTERCHANGE, INTERACTIVE, IMMERSIVE, MEDICALINTERCHANGE, MPEG4INTERACTIVE, FULL.public X3DObject setProfile(java.lang.String newValue)
CORE, INTERCHANGE, CADINTERCHANGE, INTERACTIVE, IMMERSIVE, MEDICALINTERCHANGE, MPEG4INTERACTIVE, FULL).
newValue - is new value for the profile field.X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DObject setProfile(SFStringObject newValue)
setProfile(String).newValue - is new value for the profile field.X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public SceneObject getScene()
public X3DObject setScene(SceneObject newValue)
newValue - is new value for the Scene field.X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DObject clearScene()
X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public boolean hasScene()
getScene()public java.lang.String getVersion()
3_0, 3_1, 3_2, 3_3, 4_0.public X3DObject setVersion(java.lang.String newValue)
3_0, 3_1, 3_2, 3_3, 4_0).
newValue - is new value for the version field.X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DObject setVersion(SFStringObject newValue)
setVersion(String).newValue - is new value for the version field.X3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public X3DObject addComments(java.lang.String newComment)
addComments in class X3DConcreteElementnewComment - initial valueX3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public X3DObject addComments(java.lang.String[] newComments)
addComments in class X3DConcreteElementnewComments - array of commentsX3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public X3DObject addComments(CommentsBlock newCommentsBlock)
addComments in class X3DConcreteElementnewCommentsBlock - block of comments to addX3DObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public java.lang.String toStringX3D(int indentLevel)
toStringX3D in class X3DConcreteElementindentLevel - number of levels of indentation for this elementFILE_EXTENSION_X3D,
FILE_EXTENSION_XML,
toStringXML(),
toFileXML(String),
toFileX3D(String),
X3D XML Encoding,
X3D Compressed Binary Encoding: X3D Canonical Formpublic java.lang.String toStringClassicVRML(int indentLevel)
toStringClassicVRML in class X3DConcreteElementindentLevel - number of levels of indentation for this elementFILE_EXTENSION_CLASSICVRML,
X3D Resources: Virtual Reality Modeling Language (VRML) 97,
Extensible 3D (X3D) encodings Part 2: Classic VRML encoding,
Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammarpublic java.lang.String toStringVRML97(int indentLevel)
toStringVRML97 in class X3DConcreteElementindentLevel - number of levels of indentation for this elementFILE_EXTENSION_VRML97,
X3D Resources: Virtual Reality Modeling Language (VRML) 97,
Virtual Reality Modeling Language (VRML) 97 specification,
VRML 97 v2.1 Amendmentpublic X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
findElementByNameValue in class X3DConcreteElementnameValue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
findElementByNameValue in class X3DConcreteElementnameValue - is value of the name field being searched for in this element and child elements(if any)elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
nameValue - is value of the name field being searched for in this element and child elements(if any)elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)findElementByNameValue(String, String)public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
findNodeByDEF in class X3DConcreteElementDEFvalue - is value of the name field being searched for in this element and child elements(if any)findElementByNameValue(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasNodeByDEF(java.lang.String DEFvalue)
DEFvalue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String)public java.lang.String validate()
validate in class X3DConcreteElementCopyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.