Class X3D
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.X3D
X3D is the root node for an Extensible 3D (X3D) Graphics model. This concrete class represents an X3D statement. Note atypical upper-case capitalization for this class name.
X3D statement tooltip: X3D is the top-most XML element for an Extensible 3D (X3D) Graphics model. The X3D element contains a single head element for metadata, and a single Scene element which is root node of the 3D scene graph.
X3D statement tooltip: X3D is the top-most XML element for an Extensible 3D (X3D) Graphics model. The X3D element contains a single head element for metadata, and a single Scene element which is root node of the 3D scene graph.
- Hint: for more on XML declaration and DOCTYPE (DTD) statements, which precede the X3D statement, see https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Validation
- Hint: each X3D model has a tree structure. Wikipedia: Tree (data structure) https://en.wikipedia.org/wiki/Tree_(data_structure)
- Hint: X3D model is also a form of Directed Acyclic Graph (DAG), which has no loops and helps to ensure efficient processing.
- Hint: additional attributes are under consideration for use when embedding X3D version 4 scenes within HTML version 5 web pages.
- Hint: X3D Architecture 7.2.5.2 Header statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#HeaderStatement
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringString constant COMPONENT defines X3D component for the X3D element: Corestatic final StringFile extension for X3D ClassicVRML Encoding, with dot prepended: .x3dvstatic final StringFile extension for Efficient XML Interchange (EXI) compressed XML file, with dot prepended: .existatic final StringFile extension for Graphics Interchange Format (GIF) image format, with dot prepended: .gifstatic final StringFile extension for GZIP compressed file, with dot prepended: .gzstatic final StringFile extension for HTML Encoding, with dot prepended: .htmlstatic final StringFile extension for Java source code, with dot prepended: .javastatic final StringFile extension for JavaScript source code, with dot prepended: .jsstatic final StringFile extension for Joint Photographic Experts Group (JPEG) image format, with dot prepended: .jpegstatic final StringFile extension for Joint Photographic Experts Group (JPEG) image format, with dot prepended: .jpgstatic final StringFile extension for JavaScript Object Notation (JSON) source data, with dot prepended: .jsonstatic final StringFile extension for markdown encoding, with dot prepended: .mdstatic final StringFile extension for MIDI encoding, with dot prepended: .midistatic final StringFile extension for PLY file format (Polygon File Format, or Stanford Triangle Format) with dot prepended: .ply.static final StringFile extension for Portable Network Graphics (PNG) image format, with dot prepended: .pngstatic final StringFile extension for Python programming-language source code, with dot prepended: .pystatic final StringFile extension for STL (stereolithography) file format with dot prepended: .stlstatic final StringFile extension for Scalable Vector Graphics (SVG), with dot prepended: .svgstatic final StringFile extension for Schematron Validation Report Language (SVRL) text files, produced by X3dSchematron xslt spreadsheet, with dot prepended: .txtstatic final StringFile extension for text files, with dot prepended: .txtstatic final StringFile extension for VRML97 Encoding, with dot prepended: .wrlstatic final StringFile extension for X3D XML Encoding, with dot prepended: .x3dstatic final StringFile extension for X3D Compressed Binary Encoding, with dot prepended: .x3dbstatic final StringFile extension alternative to .json for JavaScript Object Notation (JSON) source data, with dot prepended: .x3djstatic final StringFile extension for XHTML Encoding, with dot prepended: .xhtmlstatic final StringFile extension for Extensible Markup Language, with dot prepended: .xmlstatic final StringFile extension for ZIP compressed file, with dot prepended: .zipstatic final Stringactivate: cause a sensorNode to generate an isActive eventstatic final Stringancestor: node which is an antecedent of another node in the transformationHierarchystatic final StringAudioGraph: structured collection of nodes that process audio inputs and outputsstatic final Stringauthor: person or agent that creates an X3DFilestatic final StringAuthoringTool: see generatorstatic final Stringavatar: abstract representation of the user in an X3D worldstatic final Stringbearing: straight line passing through the pointer location in the direction of the pointerstatic final StringBindableNode: node that may have many instances in a sceneGraph but only one instance may be active at any instant of timestatic final Stringbrowser: computer program that interprets 3X3DFiles, presents their content to a user on a displayDevice, and allows the user to interact with worlds defined by X3D files by means of a user interfacestatic final StringBrowserExtension: nodes defined using the prototyping mechanism that are understood only by certain browsersstatic final StringBuiltInNode: node of a type explicitly defined in this documentstatic final StringCAD: Computer-Assisted Designstatic final Stringcallback: function defined in a scriptingLanguage to which events are passedstatic final Stringchild: instance of a ChildrenNodestatic final StringChildrenNode: one of a set of nodeTypes, instances of which can be collected in a group to share specific properties dependent on the type of the GroupingNodestatic final StringClientSystem: computer system, attached to a network, that relies on another computer (the server) for essential processing functionsstatic final StringCollisionProxy: node used as a substitute for all of a Collision node's children during collision detectionstatic final StringColourModel: characterization of a colour space in terms of explicit parametersstatic final Stringculling: process of identifying objects or parts of objects which do not need to be processed further by the browser in order to produce the desired view of a worldstatic final Stringdescendant: node which descends from another node in the transformationHierarchy (a ChildrenNode)static final StringDisplayDevice: graphics device on which X3D worlds may be renderedstatic final StringDragSensor: pointingDeviceSensor that causes events to be generated in response to sensor-dependent pointer motionsstatic final StringEnvironmentalSensor: sensor node that generates events based on the location of the viewpoint in the world or in relation to objects in the worldstatic final Stringevent: message sent from one node to another as defined by a ROUTEstatic final StringEventCascade: sequence of @events initiated by a script or sensor event and propagated from node to node along one or more routes all of which are considered to have occurred simultaneouslystatic final StringExecutionModel: rules governing how events are processed by browsers and scriptsstatic final StringExternaPrototype: prototype defined in an external file and referenced by a URLstatic final Stringfield: property or attribute of a nodestatic final StringFieldName: identifier of a fieldstatic final Stringframe: single rendering of a world on a displayDevice or a single time-step in a simulationstatic final Stringgenerator: computer program which creates X3DFilesstatic final StringGeometricPropertyNode: node defining the properties of a specific geometry nodestatic final StringGeometryNode: node containing mathematical descriptions of points, lines, surfaces, text strings and solidsstatic final Stringgrab: receive events from activated pointingDevicesstatic final StringGroupingNode: one of a set of nodeTypes which include a list of nodes, referred to as its ChildrenNodesstatic final StringHostApplication: client application with which the browser communicates using the SAIstatic final StringHSV: Hue, Saturation, and Value colour modelstatic final Stringimage: two-dimensional (2D) rectangular array of pixel valuesstatic final Stringimmersive: creating the illusion of being inside a computer-generated scenestatic final StringInlining: mechanism by which one X3DFile is hierarchically included in anotherstatic final Stringinstance: the node created by an instantiationstatic final Stringinstantiation: the creation of a node based on its nodeTypestatic final StringInterpolatorNode: node that defines a piece-wise or smoothly continuous interpolationstatic final Stringintranet: private network that uses the same protocols and standards as the Internetstatic final StringJPEG: Joint Photographic Experts Groupstatic final StringLevelOfDetail: amount of detail or complexity which is displayed at any particular time for any particular objectstatic final StringLineTerminator: linefeed character (0x0A) and/or carriage return character (0x0D)static final Stringloop: sequence of events which would result in a specific event generator sending more than one event with the same timestampstatic final StringMF: Multiple-valued fieldstatic final StringMIDI: Musical Instrument Digital Interface.static final StringMIME: Multipurpose Internet Mail Extensionstatic final StringMPEG: Moving Picture Experts Groupstatic final Stringmultimedia: integrated presentation, typically on a computer, of content of various types, such as computer graphics, audio, and videonstatic final Stringnetwork: set of interconnected computersstatic final Stringnode: fundamental component of a sceneGraph that defines model information, such as graph structure, geometry, animation, interaction, object metadata, rendering, or displaystatic final StringnodeType: characteristic of each node that describes, in general, its particular semanticsstatic final Stringobject: collection of data and procedures, packaged according to the rules and syntax defined in this document.static final StringorderOfPreference: order (specified by the user) in which a list of field values is processed by the browserstatic final Stringpanorama: background texture that is placed behind all geometry in the scene and in front of the ground and skystatic final Stringparent: node which is an instance of a GroupingNodestatic final Stringpixel: one element of an image specified as a matrix of colour elementsstatic final StringPNG: Portable Network Graphics.static final Stringpointer: location and direction in the virtualWorld defined by the pointingDevice with which the user is currently interacting with the virtual worldstatic final StringpointingDevice: hardware device connected to the user's computer by which the user directly controls the location and direction of the pointerstatic final StringpointingDeviceSensor: sensor node that generates events based on user actions, such as pointingDevice motions or button activationsstatic final Stringpolyline: piecewise linear curvestatic final Stringprofile: named collection of criteria for functionality and conformance that defines an implementable subset of a standardstatic final Stringprototype: definition of a new nodeType in terms of the nodes defined in this documentstatic final Stringprototyping: mechanism for extending the set of nodeTypes from within a X3DFilestatic final StringRGB: Red, Green, and Blue colour modelstatic final StringROUTE: connection between a node generating an event and a node receiving the eventstatic final StringRURL: Relative Uniform Resource Locatorstatic final StringSAI: Scene Access Interfacestatic final StringsceneGraph: ordered set of nodes and statementsstatic final Stringscript: set of procedural functions normally executed as part of an eventCascadestatic final Stringscripting: process of creating or referring to a scriptstatic final StringsensorNode: node that enables the user to interact with the world in the scene graph hierarchystatic final StringseparatorCharacter: UTF-8 character used to separate syntactical entities in an X3DFilestatic final StringSF: Single-valued fieldstatic final Stringsibling: node which shares a parent with other nodesstatic final StringsimulationTick: smallest time unit capable of being identified in a digital simulation of analog timestatic final Stringslerp: spherical linear interpolation for animating 3D rotation valuesstatic final StringspecialGroupNode: grouping node that exhibits special behaviour ( e.g., Switch or LOD)static final Stringstatement: A statement specifies fundamental scene-related informationstatic final Stringtexel: pixel in an image used as a texturestatic final Stringtexture: image used to create visual appearance effects when applied to geometry nodesstatic final StringtextureCoordinates: set of coordinates used to map a texture to geometrystatic final Stringtime: monotonically increasing value generated by a nodestatic final Stringtimestamp: that part of an event that describes the time the event occurred and that caused the message to be sentstatic final StringtransformationHierarchy: subset of the sceneGraph consisting of nodes that have well-defined coordinate systemsstatic final StringtransparencyChunk: section of a PNG file containing transparency information (derived from ISO/IEC 15948)static final Stringtraverse: process the nodes in a scene graph in the correct orderstatic final StringUCS: Universal multiple-octet coded Character Setstatic final StringURI: Universal Resource Identifierstatic final StringURL: Uniform Resource Locatorstatic final StringURN: Universal Resource Namestatic final Stringuser: person or agent who uses and interacts with X3DFiles by means of a browserstatic final StringUTF-8: variable-length 8-bit Universal multiple-octet coded character set Transformation Formatstatic final Stringviewer: location, direction, and viewing angle in a virtualWorld that determines the portion of the virtual world presented by the browser to the userstatic final StringvirtualWorld: See world.static final StringwhiteSpace: one or more consecutive occurrences of a separatorCharacterstatic final Stringworld: collection of one or more X3DFiles (potentially including other multimedia content) that is interpreted by an X3D browser to present an interactive experience to the user that is consistent with the intent of the authorstatic final StringworldCoordinateSpace: coordinate system in which each X3D world is definedstatic final StringX3DBrowser: see browserstatic final StringX3DDocumentServer: computer program that locates and transmits X3DFiles and supporting files in response to requests from browsersstatic final StringX3DFile: set of X3D nodes and statements as defined in this documentstatic final StringXYPlane: plane perpendicular to the Z-axis that passes through the point Z = 0.0static final StringYZPlane: plane perpendicular to the X-axis that passes through the point X = 0.0static final StringZXPlane: plane perpendicular to the Y-axis that passes through the point Y = 0.0static final headSFNode field named head has default value null (Java syntax) or NULL (XML syntax).static final intInteger constant LEVEL provides default X3D Core component level for this element: 1static final StringString constant NAME provides name of this element: X3D.static final StringTooltip: CADInterchange Profile adds support for CADGeometry component nodes to Interchange Profile.static final StringTooltip: Core Profile includes no nodes and is provided as the basis for custom componentization.static final StringSFString field named profile has default value "Full" (Java syntax) or Full (XML syntax).static final StringTooltip: The Full Profile corresponds to all Immersive X3D nodes plus all approved/implemented extensions.static final StringTooltip: Immersive Profile equals all of the nodes in the VRML97 Specification, plus various X3D node additions including KeySensor, StringSensor and Scene.static final StringTooltip: Interactive Profile adds interaction nodes (Anchor, KeySensor) to the minimum subset of nodes needed to display lightweight compelling content.static final StringTooltip: Interchange Profile equals the minimum subset of nodes needed to display lightweight compelling content.static final StringTooltip: The MedicalInterchange profile adds support for VolumeRendering component to Interchange profile.static final StringTooltip: MPEGInteractive Profile defines base interoperability with MPEG4 standards to a small subset of nodes needed to display lightweight compelling content.static final SceneSFNode field named Scene has default value null (Java syntax) or NULL (XML syntax).static final StringTooltip: X3D version 3.0 approved by ISO in 2004.static final StringTooltip: X3D version 3.1 Amendment 1 approved by ISO in 2005.static final StringTooltip: X3D version 3.2 Amendment 2 approved by ISO in 2007.static final StringTooltip: X3D version 3.3 approved by ISO in 2013 as International Standard (IS).static final StringTooltip: X3D version 4.0 approved by ISO in 2023 as International Standard (IS).static final StringTooltip: X3D version 4.1 under development by Web3D Consortium.static final StringSFString field named version has default value "4.0" (Java syntax) or 4.0 (XML syntax).static final StringXML Schema attributes for X3D element.static final StringXML Schema attributes for X3D element.static final StringXML Schema attributes for X3D element.static final StringXML Schema attributes for X3D element.static final StringXML Schema attributes for X3D element.static final StringXML Schema attributes for X3D element.static final StringVersion date when the current X3DJSAIL library was created.static final StringXML document type declaration.static final StringXML document type declaration.static final StringXML document type declaration.static final StringXML document type declaration.static final StringXML document type declaration.static final StringXML document type declaration.static final StringXML declaration appears on first line of an XML document.Fields inherited from class X3DConcreteElement
validationResult -
Constructor Summary
ConstructorsConstructorDescriptionX3D()Constructor for X3D to initialize member variables with default values.Constructor for X3D object to load model from file.Constructor for X3D object to load model from file.Constructor for X3D object to load model from path, fileName. -
Method Summary
Modifier and TypeMethodDescriptionaddComments(String newComment) Add comment as String to contained commentsList.addComments(String[] newComments) Add comments as String[] array to contained commentsList.addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.voidUtility method to add meta name=generator for X3DJSAIL.Utility method to clear SFNode value of head field.Utility method to clear SFNode value of Scene field.static booleanfileNameMeetsX3dNamingConventions(String fileName) Check whether fileName ending in .x3d meets X3D naming conventions, ignoring prior path (if any).findElementByNameValue(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.findElementByNameValue(String nameValue, 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.findNodeByDEF(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.booleanfromFileEXI(String exiFileName) Load new model from an EXI file, using unzip to extract the model plus any associated files into the same path location.booleanfromFileGZIP(String gzipFileName) Load new model from a gz gzip file, using ungzip to extract the model into the same path location.booleanfromFileZIP(String zipFileName, String outputFileName) Load new model from a zip file, using unzip to extract the model plus any associated files into the same path location.booleanfromFileZIP(String zipFileName, String outputFileName, String modelFileName) Load new model from a zip file, using unzip to extract the model plus any associated files into the same path location.getAccessType(String fieldName) Indicate accessType corresponding to given fieldName.final StringDefines X3D component for the X3D element: Corefinal intProvides default X3D component level for this element: 1Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.final StringProvides name of this element: X3DgetFieldType(String fieldName) Indicate type corresponding to given fieldName.getHead()Provide head instance (using a properly typed node) from inputOutput SFNode field head.static final headPublic accessor for encapsulated SFNode default value null, returned as head.Provide String value from inputOutput SFString field named id.Provide String enumeration value (baseType xs:NMTOKEN) ["Core" | "Interchange" | "CADInterchange" | "Interactive" | "Immersive" | "MedicalInterchange" | "MPEG4Interactive" | "Full"] from inputOutput SFString field named profile.static final StringPublic accessor for encapsulated SFString default value "Full", returned as String.getScene()Provide Scene instance (using a properly typed node) from inputOutput SFNode field Scene.static final ScenePublic accessor for encapsulated SFNode default value null, returned as Scene.static FilegetTempFileFromX3dJsailJar(String internalPath, String fileName) Return a file found within X3DJSAIL jarProvide String enumeration value (baseType xs:NMTOKEN) ["3.0" | "3.1" | "3.2" | "3.3" | "4.0" | "4.1"] from inputOutput SFString field named version.static final StringPublic accessor for encapsulated SFString default value "4.0", returned as String.voidhandleArguments(String[] args) Utility method for standalone programs that get created with stylesheet X3dToJava.xslt, also sets loaded X3D model fileInputStream global CommandLine to this X3D object.booleanhasElementByNameValue(String nameValue, 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.booleanhasHead()Indicate whether an object is available for inputOutput SFNode field head.booleanhasNodeByDEF(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.booleanhasScene()Indicate whether an object is available for inputOutput SFNode field Scene.final voidInitialize all member variables to default values.booleanisEmpty()Determine if this X3D model is empty and no content is present.static booleanisFileNameNMTOKEN(String fileName) Check whether fileName is satisfactory NMTOKEN, ignoring prior path (if any).booleanloadModelFromFileX3D(File x3dFile) Load X3D model from file to initialize or replace contents of this X3D object.booleanloadModelFromFileX3D(String fileName) Load X3D model from file to initialize or replace contents of this X3D object.booleanloadModelFromFileX3D(String path, String fileName) Load X3D model from file to initialize or replace contents of this X3D object.booleanReplaces current X3D object with new X3D object.final X3DsetCssClass(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String).final X3DsetCssStyle(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String).Accessor method to assign head instance (using a properly typed node) to inputOutput SFNode field head.final X3DAccessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlId field, similar tosetHtmlId(String).voidsetIncludeSubdirectoryPaths(boolean value) Set whether to include subdirectory paths when creating markdown (default is true)setProfile(String newValue) Accessor method to assign String enumeration value ("Core" | "Interchange" | "CADInterchange" | "Interactive" | "Immersive" | "MedicalInterchange" | "MPEG4Interactive" | "Full") to inputOutput SFString field named profile.setProfile(SFString newValue) Assign typed object value to SFString profile field, similar tosetProfile(String).Accessor method to assign Scene instance (using a properly typed node) to inputOutput SFNode field Scene.setVersion(String newValue) Accessor method to assign String enumeration value ("3.0" | "3.1" | "3.2" | "3.3" | "4.0" | "4.1") to inputOutput SFString field named version.setVersion(SFString newValue) Assign typed object value to SFString version field, similar tosetVersion(String).booleansupportsX3dComponent(String otherComponent, int minimumLevel) Confirm whether given component is supported by current X3D model, [warning] no support for level tests yet.booleansupportsX3dProfile(String otherProfile) Confirm whether given profile is supported by current X3D modelbooleansupportsX3dVersion(String otherVersion) Confirm whether given version is supported by current X3D object.toFileClassicVRML(String fileName) Serialize scene graph using toStringClassicVRML() to create a new X3D file with extension x3dv.toFileCobweb(String sourceSceneName, String resultFileName) Deprecated.Save current model as an EXI file.toFileGZIP(String resultFileName) Save current model as a GZIP file.toFileHtmlDocumentation(String fileName) Serialize scene graph using toFileX3D() and then create a new pretty-print HTML file with extension .html, suitable for documentation purposes.toFileJava(String fileName) Serialize scene graph using X3dToJava.xslt stylesheet to create a new Java source file with extension java, no default license included.toFileJava(String fileName, boolean includeWeb3dLicense) Serialize scene graph using X3dToJava.xslt stylesheet to create a new Java source file with extension java.toFileJavaScript(String fileName) Serialize scene graph using NodeSerializer.js to create a JavaScript file.toFileJavaScript(String fileName, boolean includeWeb3dLicense) Serialize scene graph using NodeSerializer.js to create a JavaScript file, with boolean indicating whether to include open-source license.toFileJSON(String fileName) Serialize scene graph using X3dToJson.xslt stylesheet to create a new JSON-encoding X3D file with extension json.toFileModelMetaMarkdown(String fileName) Create model meta information as `name`=`value` pairs, providing markdown output as an output file having extension .md.toFilePython(String fileName) Serialize scene graph using X3dToPython.xslt stylesheet to create a new Python-language X3D file with extension py.toFileStylesheetConversion(String stylesheetName, String fileName) Utility method for toFileStylesheetConversion() with no stylesheet parameters.toFileStylesheetConversion(String stylesheetName, String fileName, String parameterName1, String parameterValue1) Utility method for toFileStylesheetConversion() with a single stylesheet name=value parameter pair.toFileStylesheetConversion(String stylesheetName, String fileName, String parameterName1, String parameterValue1, String parameterName2, String parameterValue2) Serialize current X3D scene graph using toFileX3D() and then create a new file with corresponding filename extension (e.g.toFileVRML97(String fileName) Serialize scene graph using toStringVRML97() to create a new X3D file with extension wrl.toFileX_ITE(String sourceSceneName, 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.Serialize scene graph using toStringX3D() to create a new XML-encoding X3D file with extension x3d or xml.toFileX3DOM(String fileName) Create displayable scene page rendered with X3DOM, using STYLESHEET_X3DOM by serializing XML syntax within an XHTML file having extension .xhtml.toFileX3dSchematronReport(String fileName) Create alternate cleaned-up X3D scene using STYLESHEET_X3DSCHEMATRON within an output file having extension .x3d.toFileX3dTidy(String fileName) Create alternate cleaned-up X3D scene using STYLESHEET_X3DTIDY within an output file having extension .x3d.Serialize scene graph using toStringX3D() to create a new XML-encoding X3D file with extension x3d or xml.Save current model as a ZIP file.toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.Serialize scene graph using STYLESHEET_HTML_DOCUMENTATION to create a new X3DOM html page as a string.Serialize scene graph using toFileJava() to create new Java source as a string.Serialize scene graph using NodeSerializer.js to create a JavaScript string.Serialize scene graph using X3dToJson.xslt stylesheet to create a new JSON-encoding string.Produce model meta information as `name`=`value` pairs, providing markdown output as a string.Serialize scene graph using X3dToPython.xslt stylesheet to create a new Python-language string.toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX_ITE(String sourceSceneName) Serialize scene graph using STYLESHEET_X3DOM (with appropriate parameters) to create a new X_ITE html page as a string.toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.Serialize scene graph using STYLESHEET_X3DOM to create a new X3DOM html page as a string.Produce diagnostics for X3D scene using STYLESHEET_X3DSCHEMATRON, providing output as a string.Produce alternate cleaned-up X3D scene using STYLESHEET_X3DTIDY, providing output as a string.Provide XML string serialization of this model subgraph, utilizing X3D XML encoding and conforming to X3D Canonical Form.toStringXML(int indentLevel) Provide XML string serialization of this model subgraph, utilizing X3D XML encoding and conforming to X3D Canonical Form.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.Provide thorough X3DJSAIL validation results for this X3D model.Methods inherited from class X3DConcreteStatement
isNode, isStatementModifier and TypeMethodDescriptionstatic final booleanisNode()Utility method to indicate whether this element is an X3D Graphics node (implementing X3DConcreteNode), returns false.static final booleanUtility method to indicate whether this element is an X3D Graphics statement (implementing X3DConcreteStatement), returns true.Methods inherited from class X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getCssClassDefault, getCssStyleDefault, getHtmlIdDefault, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlId, setParent, toStringClassicVRML, toStringVRML97, toStringX3DModifier and TypeMethodDescriptionDebug support: adding empty comment as CommentsBlock to children field has no effect.voidPackage-protected internal method to clear local reference to parent object, if any.findAncestorElementByName(String ancestorElementName) Find object reference to ancestor element (i.e. node or statement), if this object is an attached child.Find object reference to ancestor ProtoBody, if this node or statement is a child.Find object reference to ancestor Scene element, assumes this object is an attached child.Find object reference to ancestor X3D element, if this node or statement is part of an X3D object.static final StringPublic SFString accessor for field named class for CSS has default value equal to an empty string.static final StringPublic SFString accessor for field named style for CSS has default value equal to an empty string.static final StringPublic SFString accessor for field named id for html has default value equal to an empty string.static StringgetPackageName(String className) Provide fully qualified package for a given element object, including className.Provide object reference to parent X3D node or statement, if any.Get output of results from prior validation, if anybooleanhasAncestorElementByName(String ancestorElementName) Determine whether ancestor element (i.e. node or statement) is found, meaning this object is an attached child.booleanDetermine whether ancestor ProtoBody element is found, meaning this object is an attached child.booleanDetermine whether ancestor Scene element is found, meaning this object is an attached child.booleanDetermine whether ancestor X3D element is found, meaning this object is an attached child.booleanWhether parent object exists.booleanisValid()Recursive method to determine whether this element is valid.protected voidsetConcreteCssClass(String newValue) Protected internal superclass method to keep cssClass private, scene authors should use method setCssClass(newValue) instead.protected voidsetConcreteCssStyle(String newValue) Protected internal superclass method to keep cssStyles private, scene authors should use method setCssStyle(newValue) instead.protected voidsetConcreteHtmlId(String newValue) Protected internal superclass method to keep HTML id private, scene authors should use method setHtmlId(newValue) instead.voidsetParent(X3DConcreteElement newParentObject) Package-internal method to set parent object reference.Recursive method to provide ClassicVRML string serialization.Recursive method to provide VRML97 string serialization.Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
-
Field Details
-
X3DJSAIL_VERSION_DATE
Version date when the current X3DJSAIL library was created. For latest library information see- See Also:
-
XML_HEADER
XML declaration appears on first line of an XML document.
<?xml version="1.0" encoding="UTF-8"?>- See Also:
-
XML_DOCTYPE_X3D_4_1
XML document type declaration. DOCTYPE supports element/attribute structural validation and follows the initial XML declaration, before the first element in an XML document.
<?DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 4.1//EN" "https://www.web3d.org/specifications/x3d-4.1.dtd">- See Also:
-
XML_DOCTYPE_X3D_4_0
XML document type declaration. DOCTYPE supports element/attribute structural validation and follows the initial XML declaration, before the first element in an XML document. <?DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 4.0//EN" "https://www.web3d.org/specifications/x3d-4.0.dtd">- See Also:
-
XML_DOCTYPE_X3D_3_3
XML document type declaration. DOCTYPE supports element/attribute structural validation and follows the initial XML declaration, before the first element in an XML document.
<?DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.3//EN" "https://www.web3d.org/specifications/x3d-3.3.dtd">- See Also:
-
XML_DOCTYPE_X3D_3_2
XML document type declaration. DOCTYPE supports element/attribute structural validation and follows the initial XML declaration, before the first element in an XML document.
<?DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.2//EN" "https://www.web3d.org/specifications/x3d-3.2.dtd">- See Also:
-
XML_DOCTYPE_X3D_3_1
XML document type declaration. DOCTYPE supports element/attribute structural validation and follows the initial XML declaration, before the first element in an XML document.
<?DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.1//EN" "https://www.web3d.org/specifications/x3d-3.1.dtd">- See Also:
-
XML_DOCTYPE_X3D_3_0
XML document type declaration. DOCTYPE supports element/attribute structural validation and follows the initial XML declaration, before the first element in an XML document.
<?DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.0//EN" "https://www.web3d.org/specifications/x3d-3.0.dtd">- See Also:
-
X3D_XML_SCHEMA_3_0_ATTRIBUTES
XML Schema attributes for X3D element.
xmlns:xsd='https://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-3.0.xsd'- See Also:
-
X3D_XML_SCHEMA_3_1_ATTRIBUTES
XML Schema attributes for X3D element.
xmlns:xsd='https://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-3.1.xsd'- See Also:
-
X3D_XML_SCHEMA_3_2_ATTRIBUTES
XML Schema attributes for X3D element.
xmlns:xsd='https://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-3.2.xsd'- See Also:
-
X3D_XML_SCHEMA_3_3_ATTRIBUTES
XML Schema attributes for X3D element.
xmlns:xsd='https://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-3.3.xsd'- See Also:
-
X3D_XML_SCHEMA_4_0_ATTRIBUTES
XML Schema attributes for X3D element.
xmlns:xsd='https://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-4.0.xsd'- See Also:
-
X3D_XML_SCHEMA_4_1_ATTRIBUTES
XML Schema attributes for X3D element.
xmlns:xsd='https://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-4.1.xsd'- See Also:
-
GLOSSARY_CAD
-
GLOSSARY_HSV
-
GLOSSARY_JPEG
-
GLOSSARY_MIDI
MIDI: Musical Instrument Digital Interface. A standard for digital music representation.- See Also:
-
GLOSSARY_MIME
-
GLOSSARY_MF
-
GLOSSARY_MPEG
-
GLOSSARY_PNG
PNG: Portable Network Graphics. A specification for representing two-dimensional images in files.- See Also:
-
GLOSSARY_RGB
-
GLOSSARY_RURL
-
GLOSSARY_SAI
-
GLOSSARY_SF
-
GLOSSARY_UCS
-
GLOSSARY_URI
-
GLOSSARY_URL
-
GLOSSARY_URN
-
GLOSSARY_UTF8
UTF-8: variable-length 8-bit Universal multiple-octet coded character set Transformation Format- See Also:
-
GLOSSARY_ACTIVATE
activate: cause a sensorNode to generate an isActive event- See Also:
-
GLOSSARY_ANCESTOR
ancestor: node which is an antecedent of another node in the transformationHierarchy- See Also:
-
GLOSSARY_AUDIOGRAPH
AudioGraph: structured collection of nodes that process audio inputs and outputs- See Also:
-
GLOSSARY_AUTHOR
author: person or agent that creates an X3DFile- See Also:
-
GLOSSARY_AUTHORINGTOOL
-
GLOSSARY_AVATAR
avatar: abstract representation of the user in an X3D world- See Also:
-
GLOSSARY_BEARING
bearing: straight line passing through the pointer location in the direction of the pointer- See Also:
-
GLOSSARY_BINDABLENODE
BindableNode: node that may have many instances in a sceneGraph but only one instance may be active at any instant of time- See Also:
-
GLOSSARY_BROWSER
browser: computer program that interprets 3X3DFiles, presents their content to a user on a displayDevice, and allows the user to interact with worlds defined by X3D files by means of a user interface- See Also:
-
GLOSSARY_BROWSEREXTENSION
BrowserExtension: nodes defined using the prototyping mechanism that are understood only by certain browsers- See Also:
-
GLOSSARY_BUILTINNODE
BuiltInNode: node of a type explicitly defined in this document- See Also:
-
GLOSSARY_CALLBACK
callback: function defined in a scriptingLanguage to which events are passed- See Also:
-
GLOSSARY_CHILD
-
GLOSSARY_CHILDRENNODE
ChildrenNode: one of a set of nodeTypes, instances of which can be collected in a group to share specific properties dependent on the type of the GroupingNode- See Also:
-
GLOSSARY_CLIENTSYSTEM
ClientSystem: computer system, attached to a network, that relies on another computer (the server) for essential processing functions- See Also:
-
GLOSSARY_COLLISIONPROXY
CollisionProxy: node used as a substitute for all of a Collision node's children during collision detection- See Also:
-
GLOSSARY_COLOURMODEL
ColourModel: characterization of a colour space in terms of explicit parameters- See Also:
-
GLOSSARY_CULLING
culling: process of identifying objects or parts of objects which do not need to be processed further by the browser in order to produce the desired view of a world- See Also:
-
GLOSSARY_DESCENDANT
descendant: node which descends from another node in the transformationHierarchy (a ChildrenNode)- See Also:
-
GLOSSARY_DISPLAYDEVICE
DisplayDevice: graphics device on which X3D worlds may be rendered- See Also:
-
GLOSSARY_DRAGSENSOR
DragSensor: pointingDeviceSensor that causes events to be generated in response to sensor-dependent pointer motions- See Also:
-
GLOSSARY_ENVIRONMENTALSENSOR
EnvironmentalSensor: sensor node that generates events based on the location of the viewpoint in the world or in relation to objects in the world- See Also:
-
GLOSSARY_EVENT
event: message sent from one node to another as defined by a ROUTE- See Also:
-
GLOSSARY_EVENTCASCADE
EventCascade: sequence of @events initiated by a script or sensor event and propagated from node to node along one or more routes all of which are considered to have occurred simultaneously- See Also:
-
GLOSSARY_EXECUTIONMODEL
ExecutionModel: rules governing how events are processed by browsers and scripts- See Also:
-
GLOSSARY_EXTERNAPROTOTYPE
ExternaPrototype: prototype defined in an external file and referenced by a URL- See Also:
-
GLOSSARY_FIELD
-
GLOSSARY_FIELDNAME
-
GLOSSARY_FRAME
frame: single rendering of a world on a displayDevice or a single time-step in a simulation- See Also:
-
GLOSSARY_GENERATOR
generator: computer program which creates X3DFiles- See Also:
-
GLOSSARY_GEOMETRICPROPERTYNODE
GeometricPropertyNode: node defining the properties of a specific geometry node- See Also:
-
GLOSSARY_GEOMETRYNODE
GeometryNode: node containing mathematical descriptions of points, lines, surfaces, text strings and solids- See Also:
-
GLOSSARY_GRAB
grab: receive events from activated pointingDevices- See Also:
-
GLOSSARY_GROUPINGNODE
GroupingNode: one of a set of nodeTypes which include a list of nodes, referred to as its ChildrenNodes- See Also:
-
GLOSSARY_HOSTAPPLICATION
HostApplication: client application with which the browser communicates using the SAI- See Also:
-
GLOSSARY_IMAGE
image: two-dimensional (2D) rectangular array of pixel values- See Also:
-
GLOSSARY_IMMERSIVE
immersive: creating the illusion of being inside a computer-generated scene- See Also:
-
GLOSSARY_INLINING
Inlining: mechanism by which one X3DFile is hierarchically included in another- See Also:
-
GLOSSARY_INSTANCE
instance: the node created by an instantiation- See Also:
-
GLOSSARY_INSTANTIATION
instantiation: the creation of a node based on its nodeType- See Also:
-
GLOSSARY_INTERPOLATORNODE
InterpolatorNode: node that defines a piece-wise or smoothly continuous interpolation- See Also:
-
GLOSSARY_INTRANET
intranet: private network that uses the same protocols and standards as the Internet- See Also:
-
GLOSSARY_LEVELOFDETAIL
LevelOfDetail: amount of detail or complexity which is displayed at any particular time for any particular object- See Also:
-
GLOSSARY_LINETERMINATOR
LineTerminator: linefeed character (0x0A) and/or carriage return character (0x0D)- See Also:
-
GLOSSARY_LOOP
loop: sequence of events which would result in a specific event generator sending more than one event with the same timestamp- See Also:
-
GLOSSARY_MULTIMEDIA
multimedia: integrated presentation, typically on a computer, of content of various types, such as computer graphics, audio, and videon- See Also:
-
GLOSSARY_NETWORK
-
GLOSSARY_NODE
node: fundamental component of a sceneGraph that defines model information, such as graph structure, geometry, animation, interaction, object metadata, rendering, or display- See Also:
-
GLOSSARY_NODETYPE
nodeType: characteristic of each node that describes, in general, its particular semantics- See Also:
-
GLOSSARY_OBJECT
object: collection of data and procedures, packaged according to the rules and syntax defined in this document. NOTE This term is usually synonymous with node.- See Also:
-
GLOSSARY_ORDEROFPREFERENCE
orderOfPreference: order (specified by the user) in which a list of field values is processed by the browser- See Also:
-
GLOSSARY_PANORAMA
panorama: background texture that is placed behind all geometry in the scene and in front of the ground and sky- See Also:
-
GLOSSARY_PARENT
parent: node which is an instance of a GroupingNode- See Also:
-
GLOSSARY_PIXEL
pixel: one element of an image specified as a matrix of colour elements- See Also:
-
GLOSSARY_POINTER
pointer: location and direction in the virtualWorld defined by the pointingDevice with which the user is currently interacting with the virtual world- See Also:
-
GLOSSARY_POINTINGDEVICE
pointingDevice: hardware device connected to the user's computer by which the user directly controls the location and direction of the pointer- See Also:
-
GLOSSARY_POINTINGDEVICESENSOR
pointingDeviceSensor: sensor node that generates events based on user actions, such as pointingDevice motions or button activations- See Also:
-
GLOSSARY_POLYLINE
-
GLOSSARY_PROFILE
profile: named collection of criteria for functionality and conformance that defines an implementable subset of a standard- See Also:
-
GLOSSARY_PROTOTYPE
prototype: definition of a new nodeType in terms of the nodes defined in this document- See Also:
-
GLOSSARY_PROTOTYPING
prototyping: mechanism for extending the set of nodeTypes from within a X3DFile- See Also:
-
GLOSSARY_ROUTE
ROUTE: connection between a node generating an event and a node receiving the event- See Also:
-
GLOSSARY_SCENEGRAPH
sceneGraph: ordered set of nodes and statements- See Also:
-
GLOSSARY_SCRIPT
script: set of procedural functions normally executed as part of an eventCascade- See Also:
-
GLOSSARY_SCRIPTING
scripting: process of creating or referring to a script- See Also:
-
GLOSSARY_SENSORNODE
sensorNode: node that enables the user to interact with the world in the scene graph hierarchy- See Also:
-
GLOSSARY_SEPARATORCHARACTER
separatorCharacter: UTF-8 character used to separate syntactical entities in an X3DFile- See Also:
-
GLOSSARY_SIBLING
sibling: node which shares a parent with other nodes- See Also:
-
GLOSSARY_SIMULATIONTICK
simulationTick: smallest time unit capable of being identified in a digital simulation of analog time- See Also:
-
GLOSSARY_SLERP
slerp: spherical linear interpolation for animating 3D rotation values- See Also:
-
GLOSSARY_SPECIALGROUPNODE
specialGroupNode: grouping node that exhibits special behaviour ( e.g., Switch or LOD)- See Also:
-
GLOSSARY_STATEMENT
statement: A statement specifies fundamental scene-related information- See Also:
-
GLOSSARY_TEXEL
-
GLOSSARY_TEXTURE
texture: image used to create visual appearance effects when applied to geometry nodes- See Also:
-
GLOSSARY_TEXTURECOORDINATES
textureCoordinates: set of coordinates used to map a texture to geometry- See Also:
-
GLOSSARY_TIME
time: monotonically increasing value generated by a node- See Also:
-
GLOSSARY_TIMESTAMP
timestamp: that part of an event that describes the time the event occurred and that caused the message to be sent- See Also:
-
GLOSSARY_TRANSFORMATIONHIERARCHY
transformationHierarchy: subset of the sceneGraph consisting of nodes that have well-defined coordinate systems- See Also:
-
GLOSSARY_TRANSPARENCYCHUNK
transparencyChunk: section of a PNG file containing transparency information (derived from ISO/IEC 15948)- See Also:
-
GLOSSARY_TRAVERSE
traverse: process the nodes in a scene graph in the correct order- See Also:
-
GLOSSARY_USER
user: person or agent who uses and interacts with X3DFiles by means of a browser- See Also:
-
GLOSSARY_VIEWER
viewer: location, direction, and viewing angle in a virtualWorld that determines the portion of the virtual world presented by the browser to the user- See Also:
-
GLOSSARY_VIRTUALWORLD
-
GLOSSARY_WHITESPACE
whiteSpace: one or more consecutive occurrences of a separatorCharacter- See Also:
-
GLOSSARY_WORLD
world: collection of one or more X3DFiles (potentially including other multimedia content) that is interpreted by an X3D browser to present an interactive experience to the user that is consistent with the intent of the author- See Also:
-
GLOSSARY_WORLDCOORDINATESPACE
worldCoordinateSpace: coordinate system in which each X3D world is defined- See Also:
-
GLOSSARY_X3DBROWSER
-
GLOSSARY_X3DDOCUMENTSERVER
X3DDocumentServer: computer program that locates and transmits X3DFiles and supporting files in response to requests from browsers- See Also:
-
GLOSSARY_X3DFILE
X3DFile: set of X3D nodes and statements as defined in this document- See Also:
-
GLOSSARY_XYPLANE
XYPlane: plane perpendicular to the Z-axis that passes through the point Z = 0.0- See Also:
-
GLOSSARY_YZPLANE
YZPlane: plane perpendicular to the X-axis that passes through the point X = 0.0- See Also:
-
GLOSSARY_ZXPLANE
ZXPlane: plane perpendicular to the Y-axis that passes through the point Y = 0.0- See Also:
-
PROFILE_CORE
Tooltip: Core Profile includes no nodes and is provided as the basis for custom componentization. Allowed X3D statements for all profiles are: connect ExternProtoDeclare EXPORT field fieldValue IMPORT IS ProtoBody ProtoDeclare ProtoInterface ProtoInstance ROUTE X3D. Allowed X3D nodes for this profile are: MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Core" (Java syntax) or Core (XML syntax).- See Also:
-
PROFILE_INTERCHANGE
Tooltip: Interchange Profile equals the minimum subset of nodes needed to display lightweight compelling content. Allowed X3D nodes for this profile are: Appearance Background Box Color ColorInterpolator ColorRGBA Cone Coordinate CoordinateInterpolator Cylinder DirectionalLight Group ImageTexture IndexedFaceSet IndexedLineSet IndexedTriangleFanSet IndexedTriangleSet IndexedTriangleStripSet LineSet Material MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString MultiTexture MultiTextureCoordinate MultiTextureTransform NavigationInfo Normal NormalInterpolator OrientationInterpolator PixelTexture PointSet PositionInterpolator ScalarInterpolator Shape Sphere TextureCoordinate TextureCoordinateGenerator TextureTransform TimeSensor Transform TriangleFanSet TriangleSet TriangleStripSet Viewpoint WorldInfo. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Interchange" (Java syntax) or Interchange (XML syntax).- See Also:
-
PROFILE_CADINTERCHANGE
Tooltip: CADInterchange Profile adds support for CADGeometry component nodes to Interchange Profile. Allowed X3D nodes for this profile are: Anchor Appearance CADAssembly CADFace CADLayer CADPart Billboard Collision Color ColorRGBA Coordinate DirectionalLight FragmentShader Group ImageTexture IndexedLineSet IndexedQuadSet IndexedTriangleFanSet IndexedTriangleSet IndexedTriangleStripSet Inline LineProperties LineSet LOD Material MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString MultiShader MultiTexture MultiTextureCoordinate MultiTextureTransform NavigationInfo Normal PixelTexture PointSet QuadSet Shader ShaderAppearance Shape TextureCoordinate TextureCoordinateGenerator TextureTransform Transform TriangleFanSet TriangleSet TriangleStripSet Viewpoint VertexShader WorldInfo. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CADInterchange" (Java syntax) or CADInterchange (XML syntax).- See Also:
-
PROFILE_INTERACTIVE
Tooltip: Interactive Profile adds interaction nodes (Anchor, KeySensor) to the minimum subset of nodes needed to display lightweight compelling content. Allowed X3D nodes for this profile are: Anchor Appearance Background BooleanFilter BooleanSequencer BooleanToggle BooleanTrigger Box Color ColorInterpolator ColorRGBA Cone Coordinate CoordinateInterpolator Cylinder CylinderSensor DirectionalLight ElevationGrid Group ImageTexture IndexedFaceSet IndexedLineSet IndexedTriangleFanSet IndexedTriangleSet IndexedTriangleStripSet Inline IntegerSequencer IntegerTrigger KeySensor LineSet Material MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString MultiTexture MultiTextureCoordinate MultiTextureTransform NavigationInfo Normal NormalInterpolator OrientationInterpolator IndexedTriangleStripSet Inline IntegerSequencer IntegerTrigger KeySensor LineSet Material MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString MultiTexture MultiTextureCoordinate MultiTextureTransform NavigationInfo Normal NormalInterpolator OrientationInterpolator PixelTexture PlaneSensor PointLight PointSet PositionInterpolator ProximitySensor ScalarInterpolator Shape Sphere SphereSensor SpotLight StringSensor Switch TextureCoordinate TextureCoordinateGenerator TextureTransform TimeSensor TimeTrigger TouchSensor Transform TriangleFanSet TriangleSet TriangleStripSet Viewpoint VisibilitySensor WorldInfo. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Interactive" (Java syntax) or Interactive (XML syntax).- See Also:
-
PROFILE_IMMERSIVE
Tooltip: Immersive Profile equals all of the nodes in the VRML97 Specification, plus various X3D node additions including KeySensor, StringSensor and Scene. Allowed X3D nodes for this profile are: Anchor Appearance AudioClip Background Billboard BooleanFilter BooleanSequencer BooleanToggle BooleanTrigger Box Collision Color ColorInterpolator ColorRGBA Cone Coordinate CoordinateInterpolator Cylinder CylinderSensor DirectionalLight ElevationGrid Extrusion Fog FontStyle Group ImageTexture IndexedFaceSet IndexedLineSet IndexedTriangleFan IndexedTriangleSet IndexedTriangleStripSet Inline IntegerSequencer IntegerTrigger KeySensor LineProperties LineSet LoadSensor LOD Material MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString MovieTexture MultiTexture MultiTextureCoordinate MultiTextureTransform NavigationInfo Normal NormalInterpolator OrientationInterpolator PixelTexture PlaneSensor PointLight PointSet Polyline2D Polypoint2D PositionInterpolator ProximitySensor Rectangle2D ScalarInterpolator Script Shape Sound Sphere SphereSensor SpotLight StringSensor Switch Text TextureCoordinate TextureCoordinateGenerator TextureTransform TimeSensor TimeTrigger TouchSensor TriangleFanSet TriangleSet TriangleSet2D TriangleStripSet Transform Viewpoint VisibilitySensor WorldInfo. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Immersive" (Java syntax) or Immersive (XML syntax).- See Also:
-
PROFILE_MEDICALINTERCHANGE
Tooltip: The MedicalInterchange profile adds support for VolumeRendering component to Interchange profile. Allowed X3D nodes for this profile are: Anchor Arc2D ArcClose2D Appearance Background Billboard BlendedVolumeStyle BooleanFilter BooleanSequencer BooleanToggle BooleanTrigger BoundaryEnhancementVolumeStyle Box CartoonVolumeStyle Circle2D ClipPlane Collision Color ColorInterpolator ColorRGBA ComposedVolumeStyle CompositeTexture3D Cone Coordinate CoordinateDouble CoordinateInterpolator Cylinder DirectionalLight Disk2D EdgeEnhancementVolumeStyle FillProperties FontStyle Group ImageTexture ImageTexture3D IndexedFaceSet IndexedLineSet IndexedTriangleFanSet IndexedTriangleSet IndexedTriangleStripSet Inline IntegerSequencer IntegerTrigger IsoSurfaceVolumeData LineProperties LineSet LOD Material MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString MultiTexture MultiTextureCoordinate MultiTextureTransform NavigationInfo Normal NormalInterpolator OctTree OpacityMapVolumeStyle OrientationInterpolator OrthoViewpoint PixelTexture PixelTexture3D PointSet Polyline2D Polypoint2D PositionInterpolator ProjectionVolumeStyle Rectangle2D ScalarInterpolator SegmentedVolumeData ShadedVolumeStyle Shape SilhouetteEnhancementVolumeStyle Sphere StaticGroup Switch Text TextureCoordinate TextureCoordinate3D TextureCoordinate4D TextureCoordinateGenerator TextureMatrixTransform TextureProperties TextureTransform TextureTransform3D TimeSensor TimeTrigger ToneMappedVolumeStyle Transform TriangleFanSet TriangleSet TriangleStripSet Viewpoint ViewpointGroup VolumeData WorldInfo. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MedicalInterchange" (Java syntax) or MedicalInterchange (XML syntax).- See Also:
-
PROFILE_MPEG4INTERACTIVE
Tooltip: MPEGInteractive Profile defines base interoperability with MPEG4 standards to a small subset of nodes needed to display lightweight compelling content. Allowed X3D nodes for this profile are: Anchor Appearance Background Box Color ColorInterpolator ColorRGBA Cone Coordinate CoordinateInterpolator Cylinder CylinderSensor DirectionalLight ElevationGrid Group ImageTexture IndexedFaceSet IndexedLineSet Inline LineSet Material MetadataBoolean MetadataDouble MetadataFloat MetadataInteger MetadataSet MetadataString NavigationInfo NormalInterpolator OrientationInterpolator PixelTexture PlaneSensor PointLight PointSet PositionInterpolator ProximitySensor ScalarInterpolator Shape Sphere SphereSensor SpotLight Switch TextureCoordinate TextureTransform TimeSensor TouchSensor Transform Viewpoint WorldInfo. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MPEG4Interactive" (Java syntax) or MPEG4Interactive (XML syntax).- See Also:
-
PROFILE_FULL
Tooltip: The Full Profile corresponds to all Immersive X3D nodes plus all approved/implemented extensions. All X3D nodes and statements are allowed in this profile. SFString field named profile with X3DUOM simpleType profileNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Full" (Java syntax) or Full (XML syntax).- See Also:
-
VERSION_3_0
Tooltip: X3D version 3.0 approved by ISO in 2004. SFString field named version with X3DUOM simpleType x3dVersionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "3.0" (Java syntax) or 3.0 (XML syntax).- See Also:
-
VERSION_3_1
Tooltip: X3D version 3.1 Amendment 1 approved by ISO in 2005. Backwards compatibility maintained with version 3.0. SFString field named version with X3DUOM simpleType x3dVersionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "3.1" (Java syntax) or 3.1 (XML syntax).- See Also:
-
VERSION_3_2
Tooltip: X3D version 3.2 Amendment 2 approved by ISO in 2007. Backwards compatibility maintained with versions 3.0 and 3.1. SFString field named version with X3DUOM simpleType x3dVersionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "3.2" (Java syntax) or 3.2 (XML syntax).- See Also:
-
VERSION_3_3
Tooltip: X3D version 3.3 approved by ISO in 2013 as International Standard (IS). Backwards compatibility maintained with versions 3.0, 3.1 and 3.2. SFString field named version with X3DUOM simpleType x3dVersionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "3.3" (Java syntax) or 3.3 (XML syntax).- See Also:
-
VERSION_4_0
Tooltip: X3D version 4.0 approved by ISO in 2023 as International Standard (IS). Backwards compatibility maintained with versions 3.0, 3.1, 3.2 and 3.3. SFString field named version with X3DUOM simpleType x3dVersionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "4.0" (Java syntax) or 4.0 (XML syntax).- See Also:
-
VERSION_4_1
Tooltip: X3D version 4.1 under development by Web3D Consortium. Backwards compatibility maintained with versions 3.0, 3.1, 3.2, 3.3 and 4.0. SFString field named version with X3DUOM simpleType x3dVersionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "4.1" (Java syntax) or 4.1 (XML syntax).- See Also:
-
NAME
-
COMPONENT
String constant COMPONENT defines X3D component for the X3D element: Core- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Core component level for this element: 1- See Also:
-
HEAD_DEFAULT_VALUE
SFNode field named head has default value null (Java syntax) or NULL (XML syntax). -
PROFILE_DEFAULT_VALUE
SFString field named profile has default value "Full" (Java syntax) or Full (XML syntax).- See Also:
-
SCENE_DEFAULT_VALUE
SFNode field named Scene has default value null (Java syntax) or NULL (XML syntax). -
VERSION_DEFAULT_VALUE
SFString field named version has default value "4.0" (Java syntax) or 4.0 (XML syntax).- See Also:
-
FILE_EXTENSION_X3D
File extension for X3D XML Encoding, with dot prepended: .x3d- See Also:
-
FILE_EXTENSION_CLASSICVRML
File extension for X3D ClassicVRML Encoding, with dot prepended: .x3dv- See Also:
-
FILE_EXTENSION_X3DB
File extension for X3D Compressed Binary Encoding, with dot prepended: .x3db- See Also:
-
FILE_EXTENSION_VRML97
File extension for VRML97 Encoding, with dot prepended: .wrl- See Also:
-
FILE_EXTENSION_XML
File extension for Extensible Markup Language, with dot prepended: .xml- See Also:
-
FILE_EXTENSION_SVG
File extension for Scalable Vector Graphics (SVG), with dot prepended: .svg- See Also:
-
FILE_EXTENSION_HTML
File extension for HTML Encoding, with dot prepended: .html- See Also:
-
FILE_EXTENSION_MARKDOWN
File extension for markdown encoding, with dot prepended: .md- See Also:
-
FILE_EXTENSION_MIDI
File extension for MIDI encoding, with dot prepended: .midi- See Also:
-
FILE_EXTENSION_PLY
File extension for PLY file format (Polygon File Format, or Stanford Triangle Format) with dot prepended: .ply.- See Also:
-
FILE_EXTENSION_STL
File extension for STL (stereolithography) file format with dot prepended: .stl- See Also:
-
FILE_EXTENSION_XHTML
File extension for XHTML Encoding, with dot prepended: .xhtml- See Also:
-
FILE_EXTENSION_TEXT
File extension for text files, with dot prepended: .txt- See Also:
-
FILE_EXTENSION_SVRL
File extension for Schematron Validation Report Language (SVRL) text files, produced by X3dSchematron xslt spreadsheet, with dot prepended: .txt- See Also:
-
FILE_EXTENSION_GIF
File extension for Graphics Interchange Format (GIF) image format, with dot prepended: .gif- See Also:
-
FILE_EXTENSION_JPG
File extension for Joint Photographic Experts Group (JPEG) image format, with dot prepended: .jpg- See Also:
-
FILE_EXTENSION_JPEG
File extension for Joint Photographic Experts Group (JPEG) image format, with dot prepended: .jpeg- See Also:
-
FILE_EXTENSION_PNG
File extension for Portable Network Graphics (PNG) image format, with dot prepended: .png- See Also:
-
FILE_EXTENSION_JAVA
File extension for Java source code, with dot prepended: .java- See Also:
-
FILE_EXTENSION_JAVASCRIPT
File extension for JavaScript source code, with dot prepended: .js- See Also:
-
FILE_EXTENSION_JSON
File extension for JavaScript Object Notation (JSON) source data, with dot prepended: .json- See Also:
-
FILE_EXTENSION_X3DJ
File extension alternative to .json for JavaScript Object Notation (JSON) source data, with dot prepended: .x3dj- See Also:
-
FILE_EXTENSION_PYTHON
File extension for Python programming-language source code, with dot prepended: .py- See Also:
-
FILE_EXTENSION_EXI
File extension for Efficient XML Interchange (EXI) compressed XML file, with dot prepended: .exi- See Also:
-
FILE_EXTENSION_GZIP
File extension for GZIP compressed file, with dot prepended: .gz- See Also:
-
FILE_EXTENSION_ZIP
File extension for ZIP compressed file, with dot prepended: .zip- See Also:
-
-
Constructor Details
-
X3D
public X3D()Constructor for X3D to initialize member variables with default values. -
X3D
Constructor for X3D object to load model from file.- Parameters:
x3dFile- X3D model to be loaded
-
X3D
-
X3D
Constructor for X3D object to load model from file.- Parameters:
fileName- name of model file that replaces current X3DObject
-
-
Method Details
-
getElementName
Provides name of this element: X3D- Specified by:
getElementNamein classX3DConcreteElement- Returns:
- name of this element
-
getComponent
Defines X3D component for the X3D element: Core- Specified by:
getComponentin classX3DConcreteElement- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevelin classX3DConcreteElement- Returns:
- default X3D component level for this element
-
getHeadDefault
Public accessor for encapsulated SFNode default value null, returned as head.- Returns:
- default value
-
getProfileDefault
Public accessor for encapsulated SFString default value "Full", returned as String.- Returns:
- default value
-
getSceneDefault
Public accessor for encapsulated SFNode default value null, returned as Scene.- Returns:
- default value
-
getVersionDefault
Public accessor for encapsulated SFString default value "4.0", returned as String.- Returns:
- default value
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldTypein classX3DConcreteElement- Parameters:
fieldName- name of field in this X3D statement- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessTypein classX3DConcreteElement- Parameters:
fieldName- name of field in this X3D statement- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initializein classX3DConcreteStatement
-
toStringXML
Provide XML string serialization of this model subgraph, utilizing X3D XML encoding and conforming to X3D Canonical Form.- Returns:
- X3D string
- See Also:
-
toStringXML
Provide XML string serialization of this model subgraph, utilizing X3D XML encoding and conforming to X3D Canonical Form.- Parameters:
indentLevel- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toFileXML
Serialize scene graph using toStringX3D() to create a new XML-encoding X3D file with extension x3d or xml.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .x3d- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
isFileNameNMTOKEN
Check whether fileName is satisfactory NMTOKEN, ignoring prior path (if any).- Parameters:
fileName- name of file to check- Returns:
- whether fileName is satisfactory NMTOKEN
- See Also:
-
fileNameMeetsX3dNamingConventions
Check whether fileName ending in .x3d meets X3D naming conventions, ignoring prior path (if any). Not observing these conventions can cause errors when converting to a Java file name.- Parameters:
fileName- name of file to check- Returns:
- whether fileName ending in .x3d is satisfactory NMTOKEN
- See Also:
-
toFileX3D
Serialize scene graph using toStringX3D() to create a new XML-encoding X3D file with extension x3d or xml.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .x3d- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileClassicVRML
Serialize scene graph using toStringClassicVRML() to create a new X3D file with extension x3dv.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .x3dv- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileVRML97
Serialize scene graph using toStringVRML97() to create a new X3D file with extension wrl.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .wrl- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileStylesheetConversion
Utility method for toFileStylesheetConversion() with no stylesheet parameters.- Parameters:
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")- Returns:
- File containing result (if operation succeeds), null otherwise
-
toFileStylesheetConversion
public File toFileStylesheetConversion(String stylesheetName, String fileName, String parameterName1, String parameterValue1) Utility method for toFileStylesheetConversion() with a single stylesheet name=value parameter pair.- Parameters:
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 value- Returns:
- File containing result (if operation succeeds), null otherwise
-
toFileStylesheetConversion
public File toFileStylesheetConversion(String stylesheetName, String fileName, String parameterName1, String parameterValue1, String parameterName2, String parameterValue2) Serialize current X3D scene graph using toFileX3D() and then create a new file with corresponding filename extension (e.g. .html) using an embedded stylesheet.- Parameters:
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 value- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileHtmlDocumentation
Serialize scene graph using toFileX3D() and then create a new pretty-print HTML file with extension .html, suitable for documentation purposes. Also create SVG output file (with same base name) for Extrusion crossSection, if found.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .html- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
getTempFileFromX3dJsailJar
Return a file found within X3DJSAIL jar- Parameters:
internalPath- is relative path to file from top of jarfileName- is fileName of interest to retrieve- Returns:
- resulting temporary File object that is deleted when program invocation ends
-
toStringJSON
Serialize scene graph using X3dToJson.xslt stylesheet to create a new JSON-encoding string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringPython
Serialize scene graph using X3dToPython.xslt stylesheet to create a new Python-language string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringJava
Serialize scene graph using toFileJava() to create new Java source as a string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringJavaScript
Serialize scene graph using NodeSerializer.js to create a JavaScript string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toFileJavaScript
Serialize scene graph using NodeSerializer.js to create a JavaScript file.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .js- Returns:
- File containing result (if operation succeeds), empty otherwise
- See Also:
-
toFileJavaScript
Serialize scene graph using NodeSerializer.js to create a JavaScript file, with boolean indicating whether to include open-source license.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .jsincludeWeb3dLicense- whether to include license- Returns:
- File containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringHtmlDocumentation
Serialize scene graph using STYLESHEET_HTML_DOCUMENTATION to create a new X3DOM html page as a string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringModelMetaMarkdown
Produce model meta information as `name`=`value` pairs, providing markdown output as a string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringX3dTidy
Produce alternate cleaned-up X3D scene using STYLESHEET_X3DTIDY, providing output as a string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringX3dSchematronReport
Produce diagnostics for X3D scene using STYLESHEET_X3DSCHEMATRON, providing output as a string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringX3DOM
Serialize scene graph using STYLESHEET_X3DOM to create a new X3DOM html page as a string.- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toStringX_ITE
Serialize scene graph using STYLESHEET_X3DOM (with appropriate parameters) to create a new X_ITE html page as a string.- Parameters:
sourceSceneName- X3D file to load and view- Returns:
- String containing result (if operation succeeds), empty otherwise
- See Also:
-
toFileJSON
Serialize scene graph using X3dToJson.xslt stylesheet to create a new JSON-encoding X3D file with extension json.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .html- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFilePython
Serialize scene graph using X3dToPython.xslt stylesheet to create a new Python-language X3D file with extension py.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .html- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileJava
Serialize scene graph using X3dToJava.xslt stylesheet to create a new Java source file with extension java, no default license included.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .html- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileJava
Serialize scene graph using X3dToJava.xslt stylesheet to create a new Java source file with extension java.- Parameters:
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 file- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
setIncludeSubdirectoryPaths
public void setIncludeSubdirectoryPaths(boolean value) Set whether to include subdirectory paths when creating markdown (default is true)- Parameters:
value- whether to omit subdirectory paths when creating markdown (default is true)- See Also:
-
toFileModelMetaMarkdown
Create model meta information as `name`=`value` pairs, providing markdown output as an output file having extension .md.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .html- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileX3dSchematronReport
Create alternate cleaned-up X3D scene using STYLESHEET_X3DSCHEMATRON within an output file having extension .x3d.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .txt- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileX3dTidy
Create alternate cleaned-up X3D scene using STYLESHEET_X3DTIDY within an output file having extension .x3d.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .html- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileX3DOM
Create displayable scene page rendered with X3DOM, using STYLESHEET_X3DOM by serializing XML syntax within an XHTML file having extension .xhtml.- Parameters:
fileName- name of file to create and save, can include local directory path, must end with .xhtml (preferred) or .html- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileX_ITE
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.- Parameters:
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 .xhtml- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
toFileCobweb
Deprecated.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.- Parameters:
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 .xhtml- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
fromFileZIP
Load new model from a zip file, using unzip to extract the model plus any associated files into the same path location.- Parameters:
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 .xml- Returns:
- boolean if operation succeeds in creating this X3DObject, false otherwise
- See Also:
-
fromFileZIP
Load new model from a zip file, using unzip to extract the model plus any associated files into the same path location.
Warning: If nomodelFileNameis provided, then the first.x3dmodel encountered in the zip file is returned (if any).
Warning: this method overwrites any previously existing file versions when decompressing.- Parameters:
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 .x3d- Returns:
- boolean if operation succeeds in creating this X3DObject, false otherwise
- See Also:
-
fromFileGZIP
Load new model from a gz gzip file, using ungzip to extract the model into the same path location.
Warning: this method overwrites any previously existing file versions when decompressing.- Parameters:
gzipFileName- name of file to load, can include local directory path, must end with .exi- Returns:
- boolean if operation succeeds in creating this X3DObject, false otherwise
- See Also:
-
fromFileEXI
Load new model from an EXI file, using unzip to extract the model plus any associated files into the same path location.
Warning: this method overwrites any previously existing file versions when decompressing.- Parameters:
exiFileName- name of file to load, can include local directory path, must end with .exi- Returns:
- boolean if operation succeeds in creating this X3DObject, false otherwise
- See Also:
-
isEmpty
public boolean isEmpty()Determine if this X3D model is empty and no content is present.- Returns:
- true if no head and no Scene found, otherwise false
-
loadModelFromFileX3D
Load X3D model from file to initialize or replace contents of this X3D object. Supports .x3d or .xml file encodings.- Parameters:
fileName- name of model file that replaces current X3DObject- Returns:
- true if replacement successful, false otherwise
-
loadModelFromFileX3D
Load X3D model from file to initialize or replace contents of this X3D object. Supports .x3d or .xml file encodings.- Parameters:
path- directory path to file of interestfileName- name of model file that replaces current X3DObject- Returns:
- true if replacement successful, false otherwise
-
loadModelFromFileX3D
Load X3D model from file to initialize or replace contents of this X3D object. Supports .x3d or .xml file encodings.- Parameters:
x3dFile- model file that replaces current X3DObject- Returns:
- true if replacement successful, false otherwise
-
replace
Replaces current X3D object with new X3D object.- Parameters:
newX3DObject- replaces current X3DObject- Returns:
- true if replacement successful, false otherwise
-
toFileEXI
-
toFileGZIP
-
toFileZIP
Save current model as a ZIP file.- Parameters:
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 archive- Returns:
- File containing result (if operation succeeds), null otherwise
- See Also:
-
validationReport
Provide thorough X3DJSAIL validation results for this X3D model.- Returns:
- "success" or validation results plus exception information (if any)
-
handleArguments
Utility method for standalone programs that get created with stylesheet X3dToJava.xslt, also sets loaded X3D model fileInputStream global CommandLine to this X3D object. Invocation switches are listed in CommandLine.USAGE help.- Parameters:
args- command-line arguments- See Also:
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClassin classX3DConcreteElement- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Parameters:
newValue- is new value for the class field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String).- Parameters:
newValue- is new value for the class field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHead
Provide head instance (using a properly typed node) from inputOutput SFNode field head.
Tooltip: Include a head element to contain component, unit or meta statements for this X3D model. *- Returns:
- value of head field
-
setHead
Accessor method to assign head instance (using a properly typed node) to inputOutput SFNode field head.
Tooltip: Include a head element to contain component, unit or meta statements for this X3D model. *- Parameters:
newValue- is new value for the head field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearHead
-
hasHead
public boolean hasHead()Indicate whether an object is available for inputOutput SFNode field head.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
-
getHtmlId
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlIdin classX3DConcreteElement- Returns:
- value of id field
- See Also:
-
setHtmlId
Accessor method to assign String value to inputOutput SFString field named id.- Parameters:
newValue- is new value for the id field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setHtmlId
Assign typed object value to SFString HtmlId field, similar tosetHtmlId(String).- Parameters:
newValue- is new value for the id field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getProfile
Provide String enumeration value (baseType xs:NMTOKEN) ["Core" | "Interchange" | "CADInterchange" | "Interactive" | "Immersive" | "MedicalInterchange" | "MPEG4Interactive" | "Full"] from inputOutput SFString field named profile.
Tooltip: profile attribute is required and defines the player or tool support needed for this model.- Hint: Core profile corresponds to minimalist extensible profile with Metadata* nodes, useful for defining custom scene capabilities via addition of individual component statements. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/coreprofile.html
- Hint: Interchange profile corresponds to minimum lightweight subset of nodes needed to display (or import/export) compelling 3D content. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/interchange.html
- Hint: Interactive profile corresponds to Interchange geometry plus simple user interaction. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/interactive.html
- Hint: Immersive profile is common and approximately matches VRML97 with Script and Prototypes. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/immersive.html
- Hint: CADInterchange profile (X3D version 3.1 or later) corresponds to Interchange geometry plus distillation of computer-aided design (CAD) models. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/CADInterchange.html
- Hint: MedicalInterchange profile (X3D version 3.3 or later) adds support for VolumeRendering component to Interchange profile. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/MedicalInterchange.html
- Hint: Full profile contains all nodes defined in X3D specification. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/fullProfile.html
- Warning: PROFILE is capitalized and is a separate statement in the ClassicVRML Encoding.
- Hint: X3D Architecture 7.2.5.3 PROFILE statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#PROFILEStatement
Available enumeration values for string comparison:CORE,INTERCHANGE,CADINTERCHANGE,INTERACTIVE,IMMERSIVE,MEDICALINTERCHANGE,MPEG4INTERACTIVE,FULL.- Returns:
- value of profile field
-
setProfile
Accessor method to assign String enumeration value ("Core" | "Interchange" | "CADInterchange" | "Interactive" | "Immersive" | "MedicalInterchange" | "MPEG4Interactive" | "Full") to inputOutput SFString field named profile.
Warning: authors can only choose from a strict list of enumeration values (CORE,INTERCHANGE,CADINTERCHANGE,INTERACTIVE,IMMERSIVE,MEDICALINTERCHANGE,MPEG4INTERACTIVE,FULL).
Tooltip: profile attribute is required and defines the player or tool support needed for this model.- Hint: Core profile corresponds to minimalist extensible profile with Metadata* nodes, useful for defining custom scene capabilities via addition of individual component statements. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/coreprofile.html
- Hint: Interchange profile corresponds to minimum lightweight subset of nodes needed to display (or import/export) compelling 3D content. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/interchange.html
- Hint: Interactive profile corresponds to Interchange geometry plus simple user interaction. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/interactive.html
- Hint: Immersive profile is common and approximately matches VRML97 with Script and Prototypes. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/immersive.html
- Hint: CADInterchange profile (X3D version 3.1 or later) corresponds to Interchange geometry plus distillation of computer-aided design (CAD) models. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/CADInterchange.html
- Hint: MedicalInterchange profile (X3D version 3.3 or later) adds support for VolumeRendering component to Interchange profile. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/MedicalInterchange.html
- Hint: Full profile contains all nodes defined in X3D specification. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/fullProfile.html
- Warning: PROFILE is capitalized and is a separate statement in the ClassicVRML Encoding.
- Hint: X3D Architecture 7.2.5.3 PROFILE statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#PROFILEStatement
- Parameters:
newValue- is new value for the profile field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setProfile
Assign typed object value to SFString profile field, similar tosetProfile(String).- Parameters:
newValue- is new value for the profile field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getScene
Provide Scene instance (using a properly typed node) from inputOutput SFNode field Scene.
Tooltip: Include a Scene element to contain scene-graph nodes for this X3D model.- Warning: Scene is a child of X3D statement, and must follow the (optional) head statement.
- Returns:
- value of Scene field
-
setScene
Accessor method to assign Scene instance (using a properly typed node) to inputOutput SFNode field Scene.
Tooltip: Include a Scene element to contain scene-graph nodes for this X3D model.- Warning: Scene is a child of X3D statement, and must follow the (optional) head statement.
- Parameters:
newValue- is new value for the Scene field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearScene
-
hasScene
public boolean hasScene()Indicate whether an object is available for inputOutput SFNode field Scene.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStylein classX3DConcreteElement- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Parameters:
newValue- is new value for the style field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String).- Parameters:
newValue- is new value for the style field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getVersion
Provide String enumeration value (baseType xs:NMTOKEN) ["3.0" | "3.1" | "3.2" | "3.3" | "4.0" | "4.1"] from inputOutput SFString field named version.
Tooltip: Default is highest value matching schema and DOCTYPE in the scene.- Hint: X3D version 3.0 standardization occurred in 2004, version 3.1 standardization occurred in 2006, version 3.2 standardization occurred in 2008, version 3.3 standardization occurred in 2012, version 4.0 successfully completed implementation, evaluatio,n and publication in 2023.
- Warning: X3D version 4.1 is experimental and not yet under development.
- Hint: X3D version 4 Overview at https://www.web3d.org/x3d4
- Hint: X3D version 4 Implementations Status at https://www.web3d.org/x3dv4-implementations
Available enumeration values for string comparison:3_0,3_1,3_2,3_3,4_0,4_1.- Returns:
- value of version field
-
setVersion
Accessor method to assign String enumeration value ("3.0" | "3.1" | "3.2" | "3.3" | "4.0" | "4.1") to inputOutput SFString field named version.
Warning: authors can only choose from a strict list of enumeration values (3_0,3_1,3_2,3_3,4_0,4_1).
Tooltip: Default is highest value matching schema and DOCTYPE in the scene.- Hint: X3D version 3.0 standardization occurred in 2004, version 3.1 standardization occurred in 2006, version 3.2 standardization occurred in 2008, version 3.3 standardization occurred in 2012, version 4.0 successfully completed implementation, evaluatio,n and publication in 2023.
- Warning: X3D version 4.1 is experimental and not yet under development.
- Hint: X3D version 4 Overview at https://www.web3d.org/x3d4
- Hint: X3D version 4 Implementations Status at https://www.web3d.org/x3dv4-implementations
- Parameters:
newValue- is new value for the version field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVersion
Assign typed object value to SFString version field, similar tosetVersion(String).- Parameters:
newValue- is new value for the version field.- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newComment- initial value- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newComments- array of comments- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newCommentsBlock- block of comments to add- Returns:
X3D- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3Din classX3DConcreteElement- Parameters:
indentLevel- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRMLin classX3DConcreteElement- Parameters:
indentLevel- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97in classX3DConcreteElement- Parameters:
indentLevel- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
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. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValuein classX3DConcreteElement- Parameters:
nameValue- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
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. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValuein classX3DConcreteElement- Parameters:
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.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
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.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEFin classX3DConcreteElement- Parameters:
DEFvalue- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
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. TODO document specific validation methods.- Specified by:
validatein classX3DConcreteElement- Returns:
- validation results (if any)
-
supportsX3dVersion
Confirm whether given version is supported by current X3D object.- Parameters:
otherVersion- other X3D version to check- Returns:
- whether current X3D version is greater than or equal to otherVersion
- Throws:
InvalidFieldValueException- if provided with illegal value
-
supportsX3dProfile
Confirm whether given profile is supported by current X3D model- Parameters:
otherProfile- different X3D profile for comparison- Returns:
- whether current X3D model supports otherProfile
- Throws:
InvalidFieldValueException- if provided with illegal value
-
supportsX3dComponent
public boolean supportsX3dComponent(String otherComponent, int minimumLevel) throws InvalidFieldValueException Confirm whether given component is supported by current X3D model, [warning] no support for level tests yet. TODO.- Parameters:
otherComponent- other component to checkminimumLevel- minimum level of component support needed- Returns:
- comparison result
- Throws:
InvalidFieldValueException- if provided with illegal value(s)
-
addMetaGeneratorX3DJSAIL
public void addMetaGeneratorX3DJSAIL()Utility method to add meta name=generator for X3DJSAIL.
-