== Introduction ==
Project proposed and commenced in August 2017. Goal is to produce a software component which will encourage support of X3D in commercial and open source applications, particularly for those applications that already support VRML import/export. This project will test and demonstrate the proposition that "X3D is VRML", or "VRML is X3D".

This target audience for this software component is developers, and the goal is to give them a tool to improve X3D support in their applications without the need for expertise in the X3D standard itself. This project will leverage the idea that if an application already supports VRML then the task of mapping an X3D scenegraph into the application logic has already been performed and support of X3D (XML encoding) should be straightforward. Likewise, if an application supports the XML encoding it should be straightforward to add support for VRML encoding.

It is recognized that there are already translators and conversion tools to convert ClassicVRML encoding to XML Encoding. This project is essentially a repackaging of those codes into a readily deployable library. One motivation of this project is the discussion with potential users in the medical 3D printing community, through DICOM Working Group 17. Among users who may be classified as managers and project managers:
* The structure of the X3D standard as an abstract standard with multiple encodings is a complication which does not add value for them. In their view, there are two file formats: X3D, which is the XML encoding of the X3D standared; and VRML, which can either mean the Classic VRML encoding of the X3D standard, or it can mean a file conforming to an earlier version of the VRML standard.
* There is a strong preference for native import/export of files in required formats over conversions of existing or created files.

=== Project Vision ===

For any commercial or open source application which currently supports either VRML or X3D import and export, the deliverable from this project will allow the application's developers to easily upgrade so that
* To the extent allowed by an application's support of a X3D Profiles and version, content can be imported into the application through both ClassicVRML encoding and XML Encodings.
* The application can export to both ClassicVRML encoding and the XML Encoding
* Pre X3D standard versions of the VRML standard are supported as possible. The hope is to at least support Interchange Profile content, with well defined and documented failure modes to encourage developers to upgrade their applications support for X3D scenegraph

=== Platform and Language ===
Propose that making the first deliverable a Windows DLL, readily integrated into a Windows .NET application, will offer the most impactful release. The DLL will offer text stream to text-stream conversion functions with a simple C-language interface. The implementation language of this project should be transparent to the user/developer; but the final product should be deployable with a small number of DLLs with sensible footprint.

=== Resources ===
==== For XML Encoding to ClassicVRML ====

* X3dToX3dvClassicVrmlEncoding.xslt, which depends, by xslt import, on X3dToVrml97.xslt; in Sourceforge at https://svn.code.sf.net/p/x3d/code/www.web3d.org/x3d/stylesheets
* Performing XSLT Transformations in Windows .NET framework : https://docs.microsoft.com/en-us/dotnet/standard/data/xml/xslt-transformations

==== For VRML to X3D (XML Encoding) ====
The intention is to support in some way all versions/dialects of VRML, with recognition that conversion may be incomplete or error prone for VRML prior to VRML97.

* Meshlab open source project https://github.com/cnr-isti-vclab/meshlab
** C++ codebase
** License GPL v3
** VRML parsing in directory : /src/meshlabplugins/io_x3d/vrml

*

==== Additional Encoding support ====
These resources are being saved for extensions supporting additional encdings
* XIOT: https://github.com/Supporting/xiot
** Supports XML binary encodings
** C++ codebase
** License LGPL v 2.1

X3D Is VRML Dll

2017-08-30T12:26:37Z

Vmarchetti:

X3D Is VRML Dll

2017-08-30T11:52:07Z

Vmarchetti: Initial Import

Design Printing and Scanning Working Group

2017-07-26T21:11:04Z

Vmarchetti: corrected misspelling

On July 25, 2017 the Board of Directors of the Web3D Consortium approved the name change of the former CAD Working Group to Design Printing and Scanning Working Group. This name change reflects the growing interest in promoting use of the X3D standard in the fields of 3D Scanning and 3D Printing.

The text and links in this public wiki still reflect the original name of the working group, and the original main page of the wiki still serves as the main entry point for this working group's publlcally accessible resources

[[X3D_CAD | CAD Wiki Main Page]]

Design Printing and Scanning Working Group

2017-07-26T21:10:03Z

Vmarchetti: Created page with "On July 25, 2017 the Board of Directors of the Web3D Consortium approved the name change of the former CAD Working Group to Design Printing and Scanning Working Group, along w..."

On July 25, 2017 the Board of Directors of the Web3D Consortium approved the name change of the former CAD Working Group to Design Printing and Scanning Working Group, along with a revised charter. This name change reflects the growing interest in promoting use of the X3D standard in the fields of 3D Scanning and 3D Printing.

The text and links in this public wiki still reflect the original name of the working group, and the original main page of the wiki still serves as the main entry point for this working group's publcally accessible resources

[[X3D_CAD | CAD Wiki Main Page]]

DICOM CD workflow

2016-10-28T13:14:19Z

Vmarchetti: Defined 3 step workflow and defined some of the links

A description of the workflow to produce the medical image rendered in X3DOM [http://www.kshell.com/pages/MedDICOMDemo20161018/index.xhtml here], from the CD containing results of MRI scans.

[http://www.kshell.com/pages/MedDICOMDemo20161018/index.xhtml Complete Image Set]
[http://www.kshell.com/pages/MedDICOMDemo20161018/index2.xhtml Truncated Image Set]

==Workflow==
The workflow to prepare an X3DOM volume rendering from a set of DICOM images contains these steps:

===1. Selection of Images===
From the set of DICOM images select a set of images which represent a sequence of parallel slices taken at uniform spacing through the imaged volume. Each image in the set should have compatible (equivalent) imaging characteristics and image size.

===2. Generating 3D Texture===
* [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#VolumeData VolumeData] node. The geometric size of the rendered volume is defined in the dimensions attribute of this node. This node combines volumetric data represented by a 3D texture (abstract node [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html#X3DTexture3DNode X3DTexture3DNode]) and volume rendering style information as an abstract [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#X3DVolumeRenderStyleNode X3DVolumeRenderStyleNode]
* [http://doc.x3dom.org/author/Texturing/ImageTextureAtlas.html ImageTextureAtlas] is an X3DOM extension node. It is not part of the X3D v 3.3 standard but has the attributes required to be considered a descendand node of X3DTexture3DNode. This node contains an attribute url which is a link to a standard 2D image which through tiling contains a sequence of the 2D slices.
===3. Creating X3DOM web content===

===Software===
*[http://www.python.org Python 2.7] , with additional libraries
**[http://www.numpy.org NumPy] - numerical analysis library
**[http://www.scipy.org SciPy] - companion to NumPy with additional analysis functions
**[http://www.pythonware.com/products/pil PIL] - Python Imaging Library
**[http://pydicom.readthedocs.io/en/latest/getting_started.html pydicom] A python library for reading DICOM files.

*[http://www.osirix-viewer.com/download_form/download_form.php Osirix-Lite] : This free demo version of the [http://www.osirix-viewer.com/ Osirix] software for viewing DICOM image files, for Mac OS. Similar [http://technologyadvice.com/blog/healthcare/5-dicom-viewers/ DICOM viewers] are available for Windows OS

==Scans==
The original data set was flat collection of DICOM files as provided on CD by a hospital. The contents of this folder were imported into the Osirix Lite viewing software. The viewing software organized the file set by patient name (there was only one patient) and into three series of scans. The thumbnail images for one such series is shown:
[[File:DWI_NEW_NOGOP_1.jpg | 1080px | center | MRI scan series from DICOM folder generated by Osirix software]]

DICOM CD workflow

2016-10-24T16:13:56Z

Vmarchetti:

DICOM CD workflow

2016-10-24T15:26:50Z

Vmarchetti:

X3D CAD Systems

2016-05-04T20:59:31Z

Vmarchetti:

How-To instructions for preparing X3D files from the commercial CAD systems.

==Argon==
Commercial 3D CAD application by Ashlar-Vellum [http://www.ashlar.com/3d-modeling/3d-modeling-argon.html]

# From the Argon document, use the "File > Export..." menu command to export as a "*.WRL" file; use the VRML V 2.0 option, save the file with .wrl extension.
# Use X3D-Edit application "Import as X3D > Import VRML97 Scene" command to convert VRML scene to XML encoded X3D.

* If the original Argon model contains a single ACIS_Solid object, it will be converted to a single IndexedTriangleSet node.
* If the original model is a collection of surfaces, they will be converted to a collection of IndexedTriangleSet nodes, and the coloring of individual faces will be preserved in the X3D model. Argon allows breaking up a solid into a collection of its faces as a "Change Object Type" operation.

==Blender==
Blender [https://www.blender.org] is free, GPL open source 3D modeling software. At version 2.77 it offers X3D import and export options in the base distribution.
# Import : File > Import menu offers import of X3D content directly into blender
# export: File > Export offers direct export of X3D content from Blender
See also:
* [https://savage.nps.edu/X3D-Edit/BlenderExportToX3d.html Tutorial on Blender export to X3d] including correcting model and adding meta-tags
* [http://www.bitmanagement.de/en/download Blender Exporter] Free software from BS-Contact.

==OnShape==
OnShape [https://www.onshape.com] is collaborative 3D CAD system that works in a web browser. Parts and assemblies created in OnShape can be converted to X3D files by exporting a STEP file from OnShape and then performing a STEP->X3D translation.
# In OnShape the Export action is performed using a pop-up menu from the Document tab. Use the OnShape "Help" feature, search on 'export files', for user-interface assistance.
## The file will be exported as AP 214 (automotive design). An OnShape assembly will be exported to a STEP exchange file in which the assembly tree is preserved.

==Tinkercad==
Tinkercad [https://www.tinkercad.com] is an online 3D CAD system aimed at 3D printing users. It offers direct export as X3D files.
# Click the "Download for 3D Printing" button and choose the ".X3D Colors" option
## Downloaded file is in the "Interchange" profile and will have a single IndexedFaceSet node with color-by-triangle coloring.

==Clara.io==
Clara.io [https://https://clara.io] is an online 3D modeller with a "lookl and feel" similar to Blender. It offers direct export to X3D files.
# Choose the "Web eXtensible 3D" option for "Export All " or "Export Selected" menu items under the "File" menu
## Downloaded file is in the "Immersive" profile.

X3D CAD Systems

2016-05-02T00:42:42Z

Vmarchetti:

How-To instructions for preparing X3D files from the commercial CAD systems.

==Ashlar-Vellum Argon==

===Export===
# From the Argon document, use the "File > Export..." menu command to export as a "*.WRL" file; use the VRML V 2.0 option, save the file with .wrl extension.
# Use X3D-Edit application "Import as X3D > Import VRML97 Scene" command to convert VRML scene to XML encoded X3D.

* If the original Argon model contains a single ACIS_Solid object, it will be converted to a single IndexedTriangleSet node.
* If the original model is a collection of surfaces, they will be converted to a collection of IndexedTriangleSet nodes, and the coloring of individual faces will be preserved in the X3D model. Argon allows breaking up a solid into a collection of its faces as a "Change Object Type" operation.

==OnShape==
OnShape [https://www.onshape.com] is collaborative 3D CAD system that works in a web browser. Parts and assemblies created in OnShape can be converted to X3D files by exporting a STEP file from OnShape and then performing a STEP->X3D translation.
# In OnShape the Export action is performed using a pop-up menu from the Document tab. Use the OnShape "Help" feature, search on 'export files', for user-interface assistance.
## The file will be exported as AP 214 (automotive design). An OnShape assembly will be exported to a STEP exchange file in which the assembly tree is preserved.

==Tinkercad==
Tinkercad [https://www.tinkercad.com] is an online 3D CAD system aimed at 3D printing users. It offers direct export as X3D files.
# Click the "Download for 3D Printing" button and choose the ".X3D Colors" option
## Downloaded file is in the "Interchange" profile and will have a single IndexedFaceSet node with color-by-triangle coloring.

==Clara.io==
Clara.io [https://https://clara.io] is an online 3D modeller with a "lookl and feel" similar to Blender. It offers direct export to X3D files.
# Choose the "Web eXtensible 3D" option for "Export All " or "Export Selected" menu items under the "File" menu
## Downloaded file is in the "Immersive" profile.

2015-12-02T17:15:38Z

Vmarchetti: initial submission

Extrusion Edge Cases

2015-08-20T13:11:50Z

Vmarchetti:

The [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geometry3D.html#Extrusion Extrusion] node specification has ambiguities [http://web3d.org/pipermail/x3d-public_web3d.org/2015-June/subject.html#3434]

== Coincident Spine Points ==

Extrusion Edge Cases

2015-08-20T13:05:51Z

Vmarchetti: Created page with "The [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geometry3D.html#Extrusion Extrusion] node specification has ambiguities [http://web3d.org/pip..."

X3D NURBS

2013-08-16T00:12:40Z

Vmarchetti:

These are references useful for implementors and users of the [http://www.web3d.org/files/specifications/19775-1/V3.3/Part01/components/nurbs.html X3D NURBS component].

A primary reference for NURBS curves and surfaces is: L Peigl and W Tiller, The NURBS Book, Springer-Verlag 2nd Ed. 1997. See the [http://www.smlib.com Solid Modeling Solutions] site for further information on this resource.

NURBS example X3D models
* [http://www.web3d.org/x3d/content/examples/Basic/NURBS/ Basic X3D Examples Archive - NURBS] and [http://www.web3d.org/x3d/content/examples/Basic/NURBS/images support screenshots]
* [http://www.kshell.com/pages/nurbs_surface_demo NURBS Patch Surface] demonstration scenes and explanations for implementations by Vincent Marchetti
* [http://www.kshell.com/pages/trimmed_nurbs_demo NURBS Trimmed Surface] shows examples of NurbsTrimmedSurface node with internal trimming curves by Vincent Marchetti

[http://castle-engine.sourceforge.net/x3d_implementation_nurbs.php NURBS component ] by MIchalis Kamburelis discusses the support for NURBS in the [http://castle-engine.sourceforge.net Castle Game Engine]. Of particular importance is the discussion of [http://castle-engine.sourceforge.net/x3d_implementation_nurbs.php#section_homogeneous_coordinates weights and control points] in X3D.

The X3D terminology is different from the terminology used in the STEP standard. As specified in Part 42 of the STEP (ISO 10303) the "control points" attribute of a b-spline (including nurbs) entity contains the coordinates a point in real, not homogeneous, space. See the standards document ISO 10303-42:1998(E) section 4.4.70

[http://www.web3d.org/x3d/wiki/images/1/17/X3D_Browser_NURBS_Evaluation.pdf X3D Browser Evaluation] PDF, Oct 2012: A summary of the state of X3D browsers' rendering of NurbsPatchSurface and NurbsTrimmedSurface nodes.

[https://sourceforge.net/projects/jgeom jGeom] is an open-source java geometry graphics library using NURBS.

X3D NURBS

2013-08-16T00:06:17Z

Vmarchetti:

These are references useful for implementors and users of the [http://www.web3d.org/files/specifications/19775-1/V3.3/Part01/components/nurbs.html X3D NURBS component].

A primary reference for NURBS curves and surfaces is: L Peigl and W Tiller, The NURBS Book, Springer-Verlag 2nd Ed. 1997. See the [http://www.smlib.com Solid Modeling Solutions] site for further information on this resource.

NURBS example X3D models
* [http://www.web3d.org/x3d/content/examples/Basic/NURBS/ Basic X3D Examples Archive - NURBS] and [http://www.web3d.org/x3d/content/examples/Basic/NURBS/images support screenshots]
* [http://www.kshell.com/pages/nurbs_surface_demo NURBS Patch Surface] demonstration scenes and explanations for implementations by Vincent Marchetti
* [http://www.kshell.com/pages/trimmed_nurbs_demo NURBS Trimmed Surface] shows examples of NurbsTrimmedSurface node with internal trimming curves by Vincent Marchetti

[http://castle-engine.sourceforge.net/x3d_implementation_nurbs.php NURBS component ] by MIchalis Kamburelis discusses the support for NURBS in the [http://castle-engine.sourceforge.net Castle Game Engine]. Of particular importance is the discussion of [http://castle-engine.sourceforge.net/x3d_implementation_nurbs.php#section_homogeneous_coordinates weights and control points] in X3D.

The X3D terminology is different from the terminology used in the STEP standard. As specified in Part 42 of the STEP (ISO 10303) the "control points" attribute of a b-spline (including nurbs) entity contains the coordinates a point in real, not homogeneous, space. See the standards document ISO 10303-42:1998(E) section 4.4.70

[http://www.web3d.org/x3d/wiki/images/1/17/X3D_Browser_NURBS_Evaluation.pdf X3D Browser Evaluation] PDF, Oct 2012: A summary of the state of X3D browsers' rendering of NurbsPatchSurface and NurbsTrimmedSurface nodes.

* [https://sourceforge.net/projects/jgeom jGeom] is an open-source java geometry graphics library using NURBS that might be useful.

X3D NURBS

2013-08-16T00:02:40Z

Vmarchetti:

These are references useful for implementors and users of the [http://www.web3d.org/files/specifications/19775-1/V3.3/Part01/components/nurbs.html X3D NURBS component].

A primary reference for NURBS curves and surfaces is: L Peigl and W Tiller, The NURBS Book, Springer-Verlag 2nd Ed. 1997. See the [http://www.smlib.com Solid Modeling Solutions] site for further information on this resource.

NURBS example X3D models
* [http://www.web3d.org/x3d/content/examples/Basic/NURBS/ Basic X3D Examples Archive - NURBS] and [http://www.web3d.org/x3d/content/examples/Basic/NURBS/images support screenshots]
* [http://www.kshell.com/pages/nurbs_surface_demo NURBS Patch Surface] demonstration scenes and explanations for implementations by Vincent Marchetti
* [http://www.kshell.com/pages/trimmed_nurbs_demo NURBS Trimmed Surface] shows examples of NurbsTrimmedSurface node with internal trimming curves by Vincent Marchetti
* [http://castle-engine.sourceforge.net/x3d_implementation_nurbs.php NURBS component ] by MIchalis Kamburelis discusses the support for NURBS in the [http://castle-engine.sourceforge.net Castle Game Engine]. Of particular importance is the discussion of [http://castle-engine.sourceforge.net/x3d_implementation_nurbs.php#section_homogeneous_coordinates weights and control points] in X3D.

* The X3D terminology is different from the terminology used in the STEP standard. As specified in Part 42 of the STEP (ISO 10303) the "control points" attribute of a b-spline (including nurbs) entity contains the coordinates a point in real, not homogeneous, space. See the standards document ISO 10303-42:1998(E) section 4.4.70

* [http://www.web3d.org/x3d/wiki/images/1/17/X3D_Browser_NURBS_Evaluation.pdf X3D Browser Evaluation] PDF, Oct 2012: A summary of the state of X3D browsers' rendering of NurbsPatchSurface and NurbsTrimmedSurface nodes.

* [https://sourceforge.net/projects/jgeom jGeom] is an open-source java geometry graphics library using NURBS that might be useful.

X3DOM CAD

2013-03-29T20:04:40Z

Vmarchetti:

== Overview: X3DOM and CAD support ==
Resources and Issues related to using the CADGeometry component in models incorporated into HTML5 web pages and rendered in a browser pages using X3DOM implemented with Javascript+WebGL or Flash Player

[http://www.x3dom.org X3DOM] is one way to integrate an X3D model into into an HTML5 web document (see [[X3D_and_HTML5]] ). The X3DOM implementation is a library of Javascript classes and functions which, after an HTML5 document is loaded, search the Document Object Model (DOM) tree of the document for X3D elements and renders the content in an HTML5 canvas element using WebGL calls or else Flash Player, on browsers that do not suport WebGL. The Javascript code is open source and available in a [http://github.com/x3dom/x3dom Github project]. The Javascript code can also be loaded from a single minimized script at URL http://www.x3dom.org/x3dom/example/x3dom.js . X3DOM offers a partial but expanding coverage of X3D nodes; the nodes which can be rendered using X3DOM in an HTML5 page is documented in the [http://x3dom.org/x3dom/test/functional/dumpNodeTypeTree.html Node Type Tree]. The X3DOM classes themselves do not implement any of the nodes in the CADGeometry component. (As of version 1.4; March 2013)
The coverage of X3D nodes can be extended through additional Javascript code which extends the X3DOM classes (see [http://x3dom.org/docs/dev/components.html X3DOM Components])

[http://www.web3d.org/x3d/stylesheets/X3dToX3dom.xslt X3dToX3dom.xslt] is an XSLT 2 stylesheet which will generate an HTML5 document embedding an X3D input model. This stylesheet can be run using a stand-alone XSLT2 engine or from within the [https://savage.nps.eduX3D-Edit/ X3D-Edit] tool.

[http://www.kshell.com/pages/x3dom/x3dom_cad/scripts/CADGeometry.js CADGeometry.js] Javascript code implementing the CADLayer, CADAssembly, CADFace, and CADPart nodes of the X3D [http://www.web3d.org/files/specifications/19775-1/V3.2/Part01/components/CADGeometry.html CADGeometry] component. This Javascript should be loaded by a webpage '''''after''''' the core components of the X3DOM Javascript have been loaded. Example:
<code>
<script type="text/javascript" src="<nowiki>http://www.x3dom.org/x3dom/example/x3dom.js</nowiki>"/>
<script type="text/javascript" src="<nowiki>http://www.kshell.com/pages/x3dom/x3dom_cad/scripts/CADGeometry.js</nowiki>"/>
</code>

==X3D Models==
* [http://www.kshell.com/pages/x3dom/x3dom_cad/laser_assembly.x3d laser_assembly] Converted from a [http://gicl.cs.drexel.edu/repository/data/Assemblies/laser__top.stp STEP file] in the [http://www.designrepository.org/ National Design Repository].

* [http://www.kshell.com/pages/x3dom/x3dom_cad/CadTeapot.x3d CadTeapot] Copied from the Web3D Basic Examples [http://www.web3d.org/x3d/content/examples/Basic/CAD/_pages/page08.html CadTeapot] model but modified so that each of the Appearance nodes for the 4 parts of the teapot is independently defined.

==X3DOM Pages==
These pages were generated using a modification of the X3dToX3dom.xslt script (modified XSLT stylesheet [http://www.kshell.com/pages/x3dom/x3dom_cad/X3dToX3dom.xslt here]). These pages load the CADGeometry extension to X3DOM after loading the X3DOM core classes.

* [http://www.kshell.com/pages/x3dom/x3dom_cad/no_cad/laser_assembly.xhtml laser_assembly page] The laser_assembly model embedded in a web page rendered with X3DOM.
* [http://www.kshell.com/pages/x3dom/x3dom_cad/no_cad/CadTeapot.xhtml CadTeapot page] The CadTeapot model embedded in a web page rendered with X3DOM.

==X3DOM -- Product structure pages==
* [http://www.kshell.com/pages/x3dom/x3dom_cad/transparency/laser_assembly.xhtml laser_assembly product structure] The laser_assembly model in a page, with additional linked HTML/Javascript elements to display the assembly tree.
* [http://www.kshell.com/pages/x3dom/x3dom_cad/transparency/CadTeapot.xhtml CadTeapot product structure] The laser_assembly model in a page, with additional linked HTML/Javascript elements to display the assembly tree.
* [http://www.kshell.com/pages/x3dom/x3dom_cad/transparency/retention_clip.xhtml retention_clip] A product structure containing nested assemblies.

==XDOM -- Javascript programming==

The loaded X3D model is part of the document DOM (Document Object Model) and can be searched and manipulated by Javascript code. To ensure that the X3D model is completely loaded and initialized, the X3DOM framework allows the page script to assign a function to the variable x3dom.runtime.ready. This function will be run after the X3DOM code has resolved all external URL's in the X3D model and the rendering objects have been initialized. For example, the following javascript defines a function which searches the DOM tree for CADPart nodes and prints the X3D field 'name' to the browser console.

<code language="javascript">
<pre>
<nowiki>
/*
Javascript code to implement manipulating the DOM elements which
are associated with the CADGeometry component implementation of x3dom.

Vincent Marchetti 2012
Licensed in same way as X3DOM release 1.5 : http://x3dom.org

Dual licensed under the MIT and GPL.
http://x3dom.org/download/dev/docs/html/license.html
*/

(function(){
// save any existing value of the
// x3dom.runtime.ready, so it can
// be executed along with our code
var existing_ready = x3dom.runtime.ready;

function print_part_names(){
// locate X3D nodes in the DOM tree with standard
// Javascript DOM API
var parts=x3dElem.getElementsByTagName("CADPart");
for (var j=0; j<parts.length; ++j)
// get the X3D field value from the CADPart
// node using the .getattribute member function
console.log( parts[j].getAttribute('name'));
}

// according to X3DOM documentation, setting or overriding
// this function is how you perform a desired action just before
// the X3D scene to to be rendered, so the X3DOM objects have all been
// constructed
x3dom.runtime.ready=function(){
// Be courteous, let any previously existing function
// go first
if (existing_ready !== undefined) existing_ready();
// then run our code
print_part_names();
}
})();
</nowiki>
</pre>
</code>

==To Do==
* Incorporate the product structure display (on the HTML page) as an option in the X3dToX3dom stylesheet.
* Setup a SourceForge project for ProductStructure, other scripts useful
* Prepare a x3dom folder with examples and scripts to be included ( with local URL references from .xhtml to .js scripts) to be placed in the Examples/Basic/CAD/X3DOM folder on web3d.org

X3DOM CAD

2013-03-29T19:46:48Z

Vmarchetti:

X3DOM CAD

2013-03-29T17:30:18Z

Vmarchetti:

X3DOM CAD

2013-03-29T17:22:49Z

Vmarchetti:

== Overview: X3DOM and CAD support ==
Resources and Issues related to using the CADGeometry component in models incorporated into HTML5 web pages and rendered in a browser pages using X3DOM implemented with Javascript+WebGL or Flash Player

[http://www.x3dom.org X3DOM] is one way to integrate an X3D model into into an HTML5 web document (see [[X3D_and_HTML5]] ). The X3DOM implementation is a library of Javascript classes and functions which, after an HTML5 document is loaded, search the Document Object Model (DOM) tree of the document for X3D elements and renders the content in an HTML5 canvas element using WebGL calls or else Flash Player, on browsers that do not suport WebGL. The Javascript code is open source and available in a [http://github.com/x3dom/x3dom Github project]. The Javascript code can also be loaded from a single minimized script at URL http://www.x3dom.org/x3dom/example/x3dom.js . X3DOM offers a partial but expanding coverage of X3D nodes; the nodes which can be rendered using X3DOM in an HTML5 page is documented in the [http://x3dom.org/x3dom/test/functional/dumpNodeTypeTree.html Node Type Tree]. The X3DOM classes themselves do not implement any of the nodes in the CADGeometry component. (As of version 1.4; March 2013)
The coverage of X3D nodes can be extended through additional Javascript code which extends the X3DOM classes (see [http://x3dom.org/docs/dev/components.html X3DOM Components])

[http://www.web3d.org/x3d/stylesheets/X3dToX3dom.xslt X3dToX3dom.xslt] is an XSLT 2 stylesheet which will generate an HTML5 document embedding an X3D input model. This stylesheet can be run using a stand-alone XSLT2 engine or from within the [https://savage.nps.eduX3D-Edit/ X3D-Edit] tool.

[http://www.kshell.com/pages/x3dom/x3dom_cad/scripts/CADGeometry.js CADGeometry.js] Javascript code implementing the CADLayer, CADAssembly, CADFace, and CADPart nodes of the X3D [http://www.web3d.org/files/specifications/19775-1/V3.2/Part01/components/CADGeometry.html CADGeometry] component. This Javascript should be loaded by a webpage '''''after''''' the core components of the X3DOM Javascript have been loaded. Example:
<code>
<script type="text/javascript" src="<nowiki>http://www.x3dom.org/x3dom/example/x3dom.js</nowiki>"/>
<script type="text/javascript" src="<nowiki>http://www.kshell.com/pages/x3dom/x3dom_cad/scripts/CADGeometry.js</nowiki>"/>
</code>

==X3D Models==
* [http://www.kshell.com/pages/x3dom/x3dom_cad/laser_assembly.x3d laser_assembly] Converted from a [http://gicl.cs.drexel.edu/repository/data/Assemblies/laser__top.stp STEP file] in the [http://www.designrepository.org/ National Design Repository].

* [http://www.kshell.com/pages/x3dom/x3dom_cad/CadTeapot.x3d CadTeapot] Copied from the Web3D Basic Examples [http://www.web3d.org/x3d/content/examples/Basic/CAD/_pages/page08.html CadTeapot] model but modified so that each of the Appearance nodes for the 4 parts of the teapot is independently defined.

==X3DOM Pages==
These pages were generated using a modification of the X3dToX3dom.xslt script (modified XSLT stylesheet [http://www.kshell.com/pages/x3dom/x3dom_cad/X3dToX3dom.xslt here]). These pages load the CADGeometry extension to X3DOM after loading the X3DOM core classes.

* [http://www.kshell.com/pages/x3dom/x3dom_cad/no_cad/laser_assembly.xhtml laser_assembly page] The laser_assembly model embedded in a web page rendered with X3DOM.
* [http://www.kshell.com/pages/x3dom/x3dom_cad/no_cad/CadTeapot.xhtml CadTeapot page] The CadTeapot model embedded in a web page rendered with X3DOM.

==X3DOM -- Product structure pages==
* [http://www.kshell.com/pages/x3dom/x3dom_cad/transparency/laser_assembly.xhtml laser_assembly product structure] The laser_assembly model in a page, with additional linked HTML/Javascript elements to display the assembly tree.
* [http://www.kshell.com/pages/x3dom/x3dom_cad/transparency/CadTeapot.xhtml CadTeapot product structure] The laser_assembly model in a page, with additional linked HTML/Javascript elements to display the assembly tree.
* [http://www.kshell.com/pages/x3dom/x3dom_cad/transparency/retention_clip.xhtml retention_clip] A product structure containing nested assemblies.

==XDOM -- Javascript programming==

The loaded X3D model is part of the document DOM (Document Object Model) and can be searched and manipulated by Javascript code. To ensure that the X3D model is completely loaded and initialized, the X3DOM framework allows the page script to assign a function to the variable x3dom.runtime.ready. This function will be run after the X3DOM code has resolved all external URL's in the X3D model and the rendering objects have been initialized. For example, the following javascript defines a function which searches the DOM tree for CADPart nodes and prints the X3D field 'name' to the browser console.

<code language="javascript">
/*
Javascript code to implement manipulating the DOM elements which
are associated with the CADGeometry component implementation of x3dom.

Vincent Marchetti 2012
Licensed in same way as X3DOM release 1.5 : http://x3dom.org

Dual licensed under the MIT and GPL.
http://x3dom.org/download/dev/docs/html/license.html
*/

(function(){
// save any existing value of the
// x3dom.runtime.ready, so it can
// be executed along with our code
var existing_ready = x3dom.runtime.ready;

function print_part_names(){
// locate X3D nodes in the DOM tree with standard
// Javascript DOM API
var parts=x3dElem.getElementsByTagName("CADPart");
for (var j=0; j<parts.length; ++j)
// get the X3D field value from the CADPart
// node using the .getattribute member function
console.log( parts[j].getAttribute('name'));
}

// according to X3DOM documentation, setting or overriding
// this function is how you perform a desired action just before
// the X3D scene to to be rendered, so the X3DOM objects have all been
// constructed
x3dom.runtime.ready=function(){
// Be courteous, let any previously existing function
// go first
if (existing_ready !== undefined) existing_ready();
// then run our code
print_part_names();
}
})();
</code>