x_ite 5.0.3 → 6.1.0

package/docs/404.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # 404
 
 ## Page Not Found

package/docs/Accessing-the-External-Browser.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # Accessing the External Browser
 
 ## Overview
@@ -8,7 +14,7 @@ If you want combine DOM access with X3D access in your JavaScript functions then
 
 ## Introduction
 
-There is the X3D object which is always available, it expects one function handler that is called when the browsers (<X3DCanvas> elements) are ready, and a second function handler, that is called if an error occurred. These two arguments are optional. The return value of the X3D function is a Promise, which can be used instead of the arguments.
+There is the X3D object which is always available, it expects one function handler that is called when the browsers (<x3d-canvas> elements) are ready, and a second function handler, that is called if an error occurred. These two arguments are optional. The return value of the X3D function is a Promise, which can be used instead of the arguments.
 
 ```js
 Promise X3D ([callback[, errorCallback]]);
@@ -21,7 +27,7 @@ function callback ()
 function errorCallback (error)
 ```
 
-The external browser can be accessed by calling the `X3D .getBrowser (selector)` function, *selector* can be any CSS selector, if you have only one <X3DCanvas> element on your page, you can omit the selector argument:
+The external browser can be accessed by calling the `X3D .getBrowser (selector)` function, *selector* can be any CSS selector, if you have only one <x3d-canvas> element on your page, you can omit the selector argument:
 
 ```html
 <script type="text/javascript">
@@ -30,7 +36,7 @@ X3D (function ()
 {
   // Now, X3D is ready. We can get access to the browser object.
 
-  const Browser = X3D .getBrowser ("X3DCanvas.browser");
+  const Browser = X3D .getBrowser ("x3d-canvas.browser");
 
   Browser .loadURL (new X3D .MFNode ("/path/to/your/world.x3dv"),
                     new X3D .MFNode ());
@@ -103,20 +109,20 @@ The following services can be used to establish a session and obtain the X3DBrow
 
 #### X3DBrowser **getBrowser** (*\[selector : String\]*)
 
-The *selector* argument must be a string containing a valid CSS selector expression to match elements against. If no selector was given, »X3DCanvas« is used as selector string. The return value is the appropriate X3DBrowser object.
+The *selector* argument must be a string containing a valid CSS selector expression to match elements against. If no selector was given, »x3d-canvas« is used as selector string. The return value is the appropriate X3DBrowser object.
 
 ```js
-// Obtain X3DBrowser object of X3DCanvas element with id »browser«.
-const Browser = X3D .getBrowser ("X3DCanvas#browser");
+// Obtain X3DBrowser object of x3d-canvas element with id »browser«.
+const Browser = X3D .getBrowser ("x3d-canvas#browser");
 ```
 
 #### X3DBrowser **getBrowser** (*element : Object*)
 
-Given a DOM element that represents a X3DCanvas element, the getBrowser function returns the appropriate X3DBrowser object.
+Given a DOM element that represents a x3d-canvas element, the getBrowser function returns the appropriate X3DBrowser object.
 
 ```js
-// Query all X3DCanvas elements within the HTML page.
-const x3dcanvases = document .querySelectorAll ("X3DCanvas");
+// Query all x3d-canvas elements within the HTML page.
+const x3dcanvases = document .querySelectorAll ("x3d-canvas");
 
 for (const x3dcanvas of x3dcanvases)
 {
@@ -128,12 +134,12 @@ for (const x3dcanvas of x3dcanvases)
 
 #### Object **createBrowser** ()
 
-Creates a new X3DCanvas DOM element, initializes it and returns it. Throws an exception if the browser object cannot be created.
+Creates a new x3d-canvas DOM element, initializes it and returns it. Throws an exception if the browser object cannot be created.
 
 ```js
 function addBrowser (parent)
 {
-   // Create a new X3DCanvas element.
+   // Create a new x3d-canvas element.
    const x3dcanvas = X3D .createBrowser ();
 
    x3dcanvas .setAttribute ("src", "/my/world.x3d");
@@ -193,7 +199,7 @@ const
 
 ## Function Reference
 
-A complete function reference for the X3DBrowser object and all other X3D JavaScript objects can be found [here](/x_ite/reference/ECMAScript-Object-and-Function-Definitions.html).
+A complete function reference for the X3DBrowser object and all other X3D JavaScript objects can be found [here](reference/ECMAScript-Object-and-Function-Definitions.html).
 
 ## Example
 
@@ -201,7 +207,7 @@ A complete function reference for the X3DBrowser object and all other X3D JavaSc
 
 [View scene in this window.](https://create3000.github.io/media/x_ite/external-browser/external-browser.html)
 
-Adding HTML controls to your scene is no rocket science. We have added some HTML buttons below the X3DCanvas, which on click call a callback function.
+Adding HTML controls to your scene is no rocket science. We have added some HTML buttons below the x3d-canvas, which on click call a callback function.
 
 ### The JavaScript
 
@@ -210,7 +216,7 @@ Adding HTML controls to your scene is no rocket science. We have added some HTML
 function init ()
 {
   const
-    Browser = X3D .getBrowser ("X3DCanvas"),              // Get the browser instance.
+    Browser = X3D .getBrowser ("x3d-canvas"),             // Get the browser instance.
     scene   = Browser .currentScene,                      // Get the scene.
     timer   = scene .getNamedNode ("SpinAnimationTimer"); // Get box TouchSensor node.
 
@@ -280,7 +286,7 @@ function spin ()
 ### The HTML
 
 ```html
-<X3DCanvas src="external-browser.x3d" onload="init ()"></X3DCanvas>
+<x3d-canvas src="external-browser.x3d" onload="init ()"></x3d-canvas>
 
 <div class="buttons">
   <button id="center" class="button" onclick="center ()">Center</button>

package/docs/Browser-Support.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # Browser Support
 
 ## Overview

package/docs/Custom-Shaders.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # Custom Shaders
 
 ## Overview
@@ -125,7 +131,7 @@ A ComposedShader node provides the capability to define custom fields like the S
 
 ### X3D field types to GLSL data types
 
-<table class=" table">
+<table>
    <thead>
       <tr>
          <th>X3D field type</th>
@@ -355,7 +361,7 @@ A ComposedShader node provides the capability to define custom fields like the S
 
 A ComposedShader defines a number of special variables for the various shader stages. These built-in variables have special properties. They are usually for communicating with certain fixed-functionality. By convention, all predefined variables start with »x3d\_«; no user-defined variables may start with this.
 
-<table class=" table">
+<table>
    <thead>
       <tr>
          <th>Type</th>
@@ -594,6 +600,7 @@ A ComposedShader defines a number of special variables for the various shader st
 |-----------|----------------------|
 | bool      | applied              |
 | float     | linewidthScaleFactor |
+| float     | lineStippleScale     |
 | sampler2D | linetype             |
 
 ### Uniform Struct x3d\_FillPropertiesParameters
@@ -614,34 +621,20 @@ A ComposedShader defines a number of special variables for the various shader st
 
 ### ParticleSystem
 
-If the shader node is part of a ParticleSystem node the following attributes are available if ParticleSystem.*geometryType* is POINT, LINE, TRIANGLE, QUAD, or SPRITE.
-
-| Type            | Name                     | Comment                                                   |
-|-----------------|--------------------------|-----------------------------------------------------------|
-| attribute float | x3d\_ParticleId          | integer id of the particle                                |
-| attribute float | x3d\_ParticleLife        | integer number of current life cycle                      |
-| attribute float | x3d\_ParticleElapsedTime | elapsed time normalized in the range \[0, 1\]             |
-| attribute vec4  | x3d\_ParticlePosition    | center coordinate of particle, in relation to x3d\_Vertex |
-
-If the ParticleSystem.*geometryType* is GEOMETRY the following uniforms are available.
-
-| Type                            | Name          | Comment                                            |
-|---------------------------------|---------------|----------------------------------------------------|
-| uniform x3d\_ParticleParameters | x3d\_Particle | see table »Uniform Struct x3d\_ParticleParameters« |
-
-#### Uniform Struct x3d\_ParticleParameters
+If the shader node is part of a ParticleSystem node the following attributes and uniforms are available.
 
-| Type  | Name        | Comment                                       |
-|-------|-------------|-----------------------------------------------|
-| int   | id          | integer id of the particle                    |
-| int   | life        | integer number of current life cycle          |
-| float | elapsedTime | elapsed time normalized in the range \[0, 1\] |
+| Type              | Name                  | Comment                                                                |
+|------------------ |---------------------- |------------------------------------------------------------------------|
+| attribute vec4    | x3d\_Particle         | vec4 (int life, float lifetime, float elapsedTime, int texCoordIndex0) |
+| attribute mat4    | x3d\_ParticleMatrix   | particle matrix, should be multiplied with x3d\_Vertex                 |
+| uniform sampler2D | x3d\_TexCoordRamp     | texture coordinate ramp                                                |
+| build-in          | gl\_InstanceId        | available                                                              |
 
 ## Built-in Constants
 
 Some built-in variables are enumerated and have special values and meanings. The following table list all of them and their corresponding values. Note: as of version 1.27 these constant are built-in.
 
-<table class=" table">
+<table>
    <thead>
       <tr>
          <th>Variable</th>
@@ -668,7 +661,7 @@ Some built-in variables are enumerated and have special values and meanings. The
          <td></td>
          <td></td>
          <td></td>
-         <td>defined if logarithmic depth buffer is enabled in <a href="https://create3000.github.io/x_ite/reference/Browser-Services.html#string-getbrowseroption-string-name">browser options</a>.</td>
+         <td>defined if logarithmic depth buffer is enabled in <a href="reference/Browser-Services.html#string-getbrowseroption-string-name">browser options</a>.</td>
       </tr>
       <tr>
          <td colspan="5"><hr/>

package/docs/Features.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # Features
 
 ## Overview
@@ -6,7 +12,7 @@ X\_ITE is a fast, small, and feature-rich JavaScript library for displaying and
 
 X\_ITE is freely downloadable for any usage and licensed under the GPL3. You can use them for commercial and noncommercial purposes.
 
-Runs completely standalone, ie. there are no other library dependencies. You just need to include x\_ite.css and x\_ite.js into your HTML page.
+Runs completely standalone, ie. there are no other library dependencies. You just need to include x\_ite.js into your HTML page.
 
 Competitive performance for most frequently used functions and nodes. All function within X\_ITE are optimized to give your the best performance that JavaScript can offer.
 
@@ -18,17 +24,17 @@ All code is held by CREATE3000 and all contributors are selected and all contrib
 
 ## Core Features
 
-Although WebGL acts behind the scenes you do not need any special knowledge about that. There are many of ready to use [X3D nodes](/x_ite/Supported-Nodes.html) that will make life easier. X\_ITE provides comprehensive X3D support, which is complete and standard compliant.
+Although WebGL acts behind the scenes you do not need any special knowledge about that. There are many of ready to use [X3D nodes](Supported-Nodes.html) that will make life easier. X\_ITE provides comprehensive X3D support, which is complete and standard compliant.
 
 X\_ITE comes with a high performance JavaScript rendering engine, ie. developers may be completely free of worry about performance optimizations in their code.
 
-We offer full [X3D ECMAScript](/x_ite/reference/ECMAScript-Object-and-Function-Definitions.html) support to give you the best scripting tools you can get.
+We offer full [X3D ECMAScript](reference/ECMAScript-Object-and-Function-Definitions.html) support to give you the best scripting tools you can get.
 
 X3D comes with a fixed set of objects, called *nodes,* which will cover most of your needs. But it's creators have also planned ahead, knowing that you'll sometimes have to create your own objects. The prototyping feature lets you create complex objects that you can reuse, changing certain characteristics of the objects when desired.
 
 X\_ITE works seamlessly together with Titania. There is a X\_ITE Compatibility Mode in Titania that makes that everything looks equal both in Titania and X\_ITE, additionally scripts, and shaders provide the same functionality.
 
-There is excellent build in support for Gouraud and Phong shading. Gouraud and Phong shading are the most popular shading algorithm in use today. This methods were developed by Henri Gouraud and Phong Bui-Toung. If the build in shading methods are not enough for you there is support for [Custom Shaders](/x_ite/Custom-Shaders.html). Don't bother about *uniform variables, shader compilation, and texture loading.* With the Composed Shader node it is easy to write to your own shader even if you are a beginner, but it is also all there for professionals. There is a standardized shader API similar to GLSL that makes it easy to convert your existing shaders. The build in shaders support eight simultaneous local lights for each Shape node, Color node attached to a geometry is supported. There is smooth texture mapping adjustable with TextureProperties node and normals can be auto generated depending on *creaseAngle* if you wish smooth shading.
+There is excellent build in support for Gouraud and Phong shading. Gouraud and Phong shading are the most popular shading algorithm in use today. This methods were developed by Henri Gouraud and Phong Bui-Toung. If the build in shading methods are not enough for you there is support for [Custom Shaders](Custom-Shaders.html). Don't bother about *uniform variables, shader compilation, and texture loading.* With the Composed Shader node it is easy to write to your own shader even if you are a beginner, but it is also all there for professionals. There is a standardized shader API similar to GLSL that makes it easy to convert your existing shaders. The build in shaders support eight simultaneous local lights for each Shape node, Color node attached to a geometry is supported. There is smooth texture mapping adjustable with TextureProperties node and normals can be auto generated depending on *creaseAngle* if you wish smooth shading.
 
 Complex routing graphs can be created. The event model of X3D allows the creation of connections between fields (routes) and event are propagated along those connections. The behavior graph collects all of these field connections. It can be changed dynamically by rerouting, adding or breaking connections. Events are injected into the system and propagated through the behavior graph in a well defined order.
 
@@ -38,7 +44,7 @@ To add special effects and environment sound to your scenes there is support for
 
 You can create text quick and easy. Use the Text node which can load remote font files in TrueType and OpenType format but there are also build in fonts.
 
-If this is not enough for you have a look at [Supported Nodes](/x_ite/Supported-Nodes.html) there's sure to be something there for you.
+If this is not enough for you have a look at [Supported Nodes](Supported-Nodes.html) there's sure to be something there for you.
 
 ## Code Features
 

package/docs/Gemfile

@@ -0,0 +1,44 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.2.2"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+
+gem 'jekyll-paginate'
+gem 'jekyll-sitemap'
+gem 'jekyll-last-modified-at'
+gem 'jekyll-gist'
+gem 'jekyll-include-cache'
+gem 'jekyll-titles-from-headings'
+gem 'jekyll-remote-theme'
+gem 'jekyll-seo-tag'
+gem 'jekyll-relative-links'

package/docs/Gemfile.lock

@@ -0,0 +1,122 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.10)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    ffi (1.15.5)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-feed (0.16.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-gist (1.5.0)
+      octokit (~> 4.2)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-last-modified-at (1.3.0)
+      jekyll (>= 3.7, < 5.0)
+      posix-spawn (~> 0.3.9)
+    jekyll-paginate (1.1.0)
+    jekyll-relative-links (0.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-remote-theme (0.4.3)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-titles-from-headings (0.5.3)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    minima (2.5.1)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    posix-spawn (0.3.15)
+    public_suffix (5.0.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.30.0)
+    ruby2_keywords (0.0.5)
+    rubyzip (2.3.2)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  http_parser.rb (~> 0.6.0)
+  jekyll (~> 4.2.2)
+  jekyll-feed (~> 0.12)
+  jekyll-gist
+  jekyll-include-cache
+  jekyll-last-modified-at
+  jekyll-paginate
+  jekyll-relative-links
+  jekyll-remote-theme
+  jekyll-seo-tag
+  jekyll-sitemap
+  jekyll-titles-from-headings
+  minima (~> 2.5)
+  tzinfo (~> 1.2)
+  tzinfo-data
+  wdm (~> 0.1.1)
+
+BUNDLED WITH
+   1.17.2

package/docs/Glossary.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # Glossary
 
 ## Overview

package/docs/How-To-Configure-Your-Web-Server.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # How to Configure Your Web Server
 
 ## X3D MIME Types and File Extensions

package/docs/Supported-Nodes.md

@@ -1,3 +1,9 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: single
+---
 # Supported Nodes
 
 ## Overview
@@ -308,9 +314,11 @@ X\_ITE supports a limited set of nodes defined by the X3D specification. There a
 - [FillProperties](https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#FillProperties)
 - [LineProperties](https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#LineProperties)
 - [Material](https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#Material)
-- [PointProperties](https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#PointProperties)
+- [PhysicalMaterial](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/shape.html#PhysicalMaterial)
+- [PointProperties](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/shape.html#PointProperties)
 - [Shape](https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#Shape)
 - [TwoSidedMaterial](https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#TwoSidedMaterial)
+- [UnlitMaterial](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/shape.html#UnlitMaterial)
 
 ### Sound