x_ite 8.11.7 → 8.11.9

package/docs/_posts/accessing-the-external-browser.md

@@ -1,312 +0,0 @@
----
-title: Accessing the External Browser
-date: 2022-11-28
-nav: main
-categories: []
-tags: [Accessing, External, Browser]
----
-
-## Overview
-
-X_ITE is designed to provide access to the internal X3D browser and its contained scene graph via JavaScript, either within an internal X3D Script node or an external HTML script.
-
-If you want combine DOM access with X3D access in your JavaScript functions then you probably want to access the external browser object if you want include an external JavaScript file in your HTML page and you don't wanna do it directly a in Script node.
-
-## Introduction
-
-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<void> X3D ([callback[, errorCallback]]);
-```
-
-The callback function is called when the browser is available. The callback function takes no arguments. The error callback is called if an error occurred, it has one argument *error.*
-
-```js
-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 \<x3d-canvas\> element on your page, you can omit the selector argument:
-
-```html
-<script>
-
-X3D (function ()
-{
-  // Now, X3D is ready. We can get access to the browser object.
-
-  const Browser = X3D .getBrowser ();
-
-  Browser .loadURL (new X3D .MFNode ("/path/to/your/world.x3dv"),
-                    new X3D .MFNode ());
-});
-
-</script>
-```
-
-If something went wrong, the error callback is called:
-
-```html
-<script>
-
-X3D (function ()
-{
-  const
-    Browser      = X3D .getBrowser (),                         // X3DBrowser object
-    currentScene = Browser .currentScene,                      // X3DScene object
-    header       = currentScene .getNamedNode ("HeaderText");  // Text node
-
-  // Set string field of Text node to new value.
-  header .string [0] = "Welcome to X_ITE!";
-
-  ...
-},
-function (error)
-{
-  // Error callback, no browser.
-  console .error (error);
-});
-
-</script>
-```
-
-### Async use of X3D object
-
-```js
-async function foo (url)
-{
-  await X3D ();
-
-  const Browser = X3D .getBrowser ();
-
-  await Browser .loadURL (new MFString (url));
-
-  console .log (`Done loading scene '${Browser .currentScene .worldURL}'.`);
-}
-```
-
-## X3D Object
-
-### Functions
-
-#### X3D **noConflict** ()
-
-In X_ITE's case, the `X3D` function object is the main entry function. If you need to use another JavaScript library alongside X_ITE, return control of the `X3D` function object back to the other library with a call to `X3D .noConflict ()`. Old references of `X3D` function object are saved during X_ITE initialization; `X3D .noConflict ()` simply restores them. The return value is the `X3D` function object itself.
-
-If for some reason two versions of X_ITE are loaded (which is not recommended), calling `X3D .noConflict ()` from the second version will return the globally scoped `X3D` object to those of the first version.
-
-```html
-<script src="other_lib.js"></script>
-<script src="x_ite.js"></script>
-<script>
-const X_ITE_X3D = X3D .noConflict ();
-// Code that uses other library's X3D can follow here.
-</script>
-```
-
-The following services can be used to establish a session and obtain the X3DBrowser object.
-
-#### 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, »x3d-canvas« is used as selector string. The return value is the appropriate X3DBrowser object.
-
-```js
-// Obtain X3DBrowser object of first x3d-canvas element.
-const Browser = X3D .getBrowser ();
-```
-
-#### X3DBrowser **getBrowser** (*element : Object*)
-
-Given a DOM element that represents a x3d-canvas element, the getBrowser function returns the appropriate X3DBrowser object.
-
-```js
-// Query all x3d-canvas elements within the HTML page.
-const canvases = document .querySelectorAll ("x3d-canvas");
-
-for (const canvas of canvases)
-{
-  // Obtain X3DBrowser object of element i.
-  const Browser = X3D .getBrowser (canvas);
-  ...
-}
-```
-
-#### Object **createBrowser** ()
-
-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 x3d-canvas element.
-   const canvas = X3D .createBrowser ();
-
-   canvas .setAttribute ("src", "/my/world.x3d");
-
-   parent .appendChild (canvas);
-}
-```
-
-### Objects
-
-The X3D object has several properties, you can use any of the properties below.
-
-#### **X3DConstants**
-
-The X3DConstants object defines values that can be useful for scripting. See also [Constants Services](reference/constants-services).
-
-```js
-function foo (node)
-{
-  // Get node type array.
-
-  const types = node .getNodeType () .reverse ();
-
-  // Iterate over node type array in reverse order with
-  // concrete node types as first and abstract node
-  // types as last index.
-
-  for (const type of types)
-  {
-    switch (type)
-    {
-      case X3D .X3DConstants .Transform:
-        // node is of type Transform.
-        ...
-        break;
-      case X3D .X3DConstants .X3DLightNode:
-        //  node is at least of type X3DLightNode.
-        ...
-        break;
-    }
-  }
-}
-```
-
-#### **X3DFields**
-
-All X3DFields (SFColor, ..., MFBool, MFColor, and so on). The fields can be created using the object as constructor. See also [Field Services and Objects](reference/field-services-and-objects).
-
->**Note:** Scalar objects like SFBool, SFDouble, SFFloat, SFInt32, SFString, and SFTime have no constructor, just use the built-in JavaScript types Boolean, Number, and String.
-{: .prompt-info }
-
-```js
-// Create a new translation vector and
-// determine the length of this vector.
-
-const
-  translation = new X3D .SFVec3f (4, 2, 0),
-  length      = translation .length ();
-```
-
-## Function Reference
-
-A complete function reference for the X3DBrowser object and all other X3D JavaScript objects can be found in [ECMAScript Object and Function Definitions](reference/ecmascript-object-and-function-definitions).
-
-## Example
-
-<iframe src="https://create3000.github.io/media/x_ite/external-browser/adrenaline.html"></iframe>
-
-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
-
-```html
-<script>
-function init ()
-{
-  const
-    Browser = X3D .getBrowser (".browser"),               // Get the browser instance.
-    scene   = Browser .currentScene,                      // Get the scene.
-    timer   = scene .getNamedNode ("SpinAnimationTimer"); // Get box TouchSensor node.
-
-  // Add field callback to get informed when cycleTime is fired. "time" is an arbitrary
-  // string to identify the callback, for instance if you later want to remove the callback.
-  timer .addFieldCallback ("cycleTime", "time", function (value)
-  {
-    console .log ("cycleTime: " + value);
-  });
-
-  changeStyle ();
-  changeBackground ();
-}
-
-function center ()
-{
-  const Browser = X3D .getBrowser (".browser"); // Get the browser instance.
-
-  Browser .changeViewpoint ("Viewpoint");
-}
-
-function changeStyle ()
-{
-  const
-    Browser    = X3D .getBrowser (".browser"),            // Get the browser instance.
-    scene      = Browser .currentScene,                   // Get the scene.
-    switchNode = scene .getNamedNode ("Adrenaline");      // Get Switch node.
-
-  // Change styles.
-
-  switchNode .whichChoice = parseInt ($("#change-style") .val ());
-}
-
-function changeBackground ()
-{
-  const
-    Browser        = X3D .getBrowser (".browser"),            // Get the browser instance.
-    scene          = Browser .currentScene,                   // Get the scene.
-    backgroundNode = scene .getNamedNode ("Background");      // Get Background node.
-
-  switch (parseInt ($("#change-background") .val ()))
-  {
-    case 0:
-      backgroundNode .skyColor [0] = new X3D .SFColor (1, 1, 1);
-      break;
-    case 1:
-      backgroundNode .skyColor [0] = new X3D .SFColor (0, 0, 0);
-     break;
-  }
-}
-
-function spin ()
-{
-  const
-    Browser = X3D .getBrowser (".browser"),               // Get the browser instance.
-    scene   = Browser .currentScene,                      // Get the scene.
-    timer   = scene .getNamedNode ("SpinAnimationTimer"); // Get TimeSensor node.
-
-  if (timer .isPaused)
-    timer .resumeTime = Date .now () / 1000;
-  else
-    timer .pauseTime = Date .now () / 1000;
-}
-</script>
-```
-
-### The HTML
-
-```html
-<x3d-canvas src="external-browser.x3d" onload="init ()"></x3d-canvas>
-
-<div class="buttons">
-  <button id="center" class="button" onclick="center ()">Center</button>
-  <select id="change-style" class="button" onchange="changeStyle ()">
-    <option value="0">Balls</option>
-    <option value="1">Sticks And Balls</option>
-    <option value="2">Sticks</option>
-    <option value="3">Line</option>
-  </select>
-  <select id="change-background" class="button" onchange="changeBackground ()">
-    <option value="0">White Background</option>
-    <option value="1">Black Background</option>
-  </select>
-  <button id="spin" class="button" onclick="spin ()">Spin</button>
-</div>
-```
-
-The init function is called when the scene is loaded and installs a field callback that is called when the models are clicked. The various callback functions first obtains the different nodes and then alter a field of the nodes.
-
-### The X3D
-
-The scene defines different named nodes with the »DEF« attribute, which can be accessed later. Download [adrenaline.x3d](https://create3000.github.io/media/x_ite/external-browser/adrenaline.x3d).

package/docs/_posts/browser-support.md

@@ -1,53 +0,0 @@
----
-title: Browser Support
-date: 2022-11-28
-nav: main
-categories: []
-tags: [Browser, Support]
----
-
-## Overview
-
-To enjoy the best and most secure experience, we recommend you keep your browser and operating system updated. X_ITE will support the current and previous major releases of:
-
-## Desktop
-
-Since April 2016 **Chrome** supports all WebGL and JavaScript ES 6 features required by X_ITE. We support the current version and the previous version of Chrome, although X_ITE also runs fine in older versions.
-<https://www.google.com/chrome>{:target="_blank"}
-
-**Firefox** as the first browser that supports everything X_ITE needs and is extensively tested since years. We have full support for Firefox.
-<https://www.mozilla.org/firefox/products/>{:target="_blank"}
-
-**Safari** has excellent support for WebGL and JavaScript ES 6 and is as much popular as other browsers especially on MacOS X. Keep your Mac up to date to have the best experience we can give.
-<https://www.apple.com/safari/>{:target="_blank"}
-
-**Opera** uses the same rendering engine used by Safari and Chrome and is therefore fully supported since April 2016. Always use the latest version of Opera to make your Internet experience more secure and enjoyable.
-<https://www.opera.com/>{:target="_blank"}
-
-Starting with Windows 10 X_ITE runs fine in **Microsoft Edge** and is fully supported. Microsoft Edge provides everything X_ITE needs to give you the best performance.
-<https://www.microsoft.com/windows/microsoft-edge>{:target="_blank"}
-
-## Mobile
-
-All stock browser on **Android** 4.0+ support WebGL and JavaScript ES 6 natively. Always keep in mind to keep your files small in size and always consider to optimize for performance.
-<https://www.android.com/>{:target="_blank"}
-
-iOS has good support since **Safari** on iOS 7+. Simplify your scenes and test them extensively to achieve the best results how you would like it to be.
-<https://www.apple.com/ios/>{:target="_blank"}
-
->**Note:** Any problem with X_ITE in the above browsers should be reported as a bug in X_ITE. See [Report a Bug](report-a-bug).
-{: .prompt-info }
-
-We do not support older browsers like Internet Explorer 6-9, Opera 12.1x or Safari 5.1+.
-
-## Unsupported Browsers
-
-While X_ITE *might* run without major issues in older browser versions, we do not actively test X_ITE in them and generally do not fix bugs that may appear in them.
-
-Similarly, X_ITE does not fix bugs in pre-release versions of browsers, such as beta or dev releases. If you find a bug with X_ITE in a pre-release of a browser, you should report the bug to the browser vendor.
-
-## About Browser Support
-
-X_ITE is constantly tested with all of its supported browsers via unit tests. However, a web page using X_ITE may not work in the same set of browsers if its own code takes advantage of (or falls prey to) browser-specific behaviors. Testing is essential to fully support a browser. The Microsoft Edge Developer site makes available [virtual machines](https://dev.windows.com/en-us/microsoft-edge/tools/vms/){:target="_blank"} for testing many different versions of Internet Explorer. Older versions of other browsers can be found at [oldversion.com](http://oldversion.com/){:target="_blank"}.
-
-Only the most current version of X_ITE is tested and updated to fix bugs or add features. Users of older versions that find a bug should upgrade to the latest released version to determine if the bug has already been fixed.

package/docs/_posts/components/CADGeometry/CADAssembly.md

@@ -1,126 +0,0 @@
----
-title: CADAssembly
-date: 2023-01-07
-nav: components-CADGeometry
-categories: [components, CADGeometry]
-tags: [CADAssembly, CADGeometry]
----
-<style>
-.post h3 {
-  word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-CADAssembly holds a set of Computer-Aided Design (CAD) assemblies or parts grouped together. CADAssembly is a Grouping node that can contain CADAssembly (subassembly), CADPart or CADFace nodes.
-
-The CADAssembly node belongs to the **CADGeometry** component and its default container field is *children.* It is available from X3D version 3.1 or higher.
-
-## Hierarchy
-
-```
-+ X3DNode
-  + X3DChildNode
-    + X3DGroupingNode
-      + CADAssembly (X3DProductStructureChildNode)*
-```
-
-<small>\* Derived from multiple interfaces.</small>
-
-## Fields
-
-### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
-
-Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
-
-#### Hint
-
-- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
-
-### SFString [in, out] **name** ""
-
-Optional *name* for this particular CAD node.
-
-#### Hints
-
-- Well-defined names can simplify design and debugging through improved author understanding.
-- [X3D Scene Authoring Hints, Naming Conventions](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions){:target="_blank"}
-
-#### Warning
-
-- *name* field is not included if this instance is a USE node, in order to avoid potential mismatches.
-
-### SFBool [in, out] **visible** TRUE
-
-Whether or not renderable content within this node is visually displayed.
-
-#### Hints
-
-- The *visible* field has no effect on animation behaviors, event passing or other non-visual characteristics.
-- Content must be *visible* to be collidable and to be pickable.
-
-### SFBool [in, out] **bboxDisplay** FALSE
-
-Whether to display bounding box for associated geometry, aligned with world coordinates.
-
-#### Hint
-
-- The bounding box is displayed regardless of whether contained content is visible.
-
-### SFVec3f [ ] **bboxSize** -1 -1 -1 <small>[0,∞) or −1 −1 −1</small>
-
-Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
-
-#### Hints
-
-- Can be useful for collision computations or inverse-kinematics (IK) engines.
-- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
-- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
-- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
-
-### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
-
-Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
-
-#### Hints
-
-- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
-- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
-- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
-
-### MFNode [in] **addChildren**
-
-Input field *addChildren*.
-
-### MFNode [in] **removeChildren**
-
-Input field *removeChildren*.
-
-### MFNode [in, out] **children** [ ] <small>[X3DProductStructureChildNode, X3DGroupingNode]</small>
-
-Grouping nodes contain an ordered list of *children* nodes.
-
-#### Hints
-
-- Each grouping node defines a coordinate space for its *children*, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
-- InputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
-- InputOnly MFNode removeChildren field can remove nodes from the *children* list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
-- [X3D Architecture 10.2.1 Grouping and *children* node types](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#GroupingAndChildrenNodes){:target="_blank"}
-
-## Advisories
-
-### Hints
-
-- Can also contain Shapes or other grouped content.
-- [Datum reference](https://en.wikipedia.org/wiki/Datum_reference){:target="_blank"}
-- [X3D for Advanced Modeling (X3D4AM) slideset](https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf){:target="_blank"}
-- ViewpointGroup and OrthoViewpoint require Navigation component level 3, which is higher than CADInterchange profile.
-
-### Warning
-
-- Requires X3D `profile='Full'` or else include `<component name='CADGeometry' level='2'/>`
-
-## See Also
-
-- [X3D Specification of CADAssembly node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/CADGeometry.html#CADAssembly){:target="_blank"}

package/docs/_posts/components/CADGeometry/CADFace.md

@@ -1,113 +0,0 @@
----
-title: CADFace
-date: 2023-01-07
-nav: components-CADGeometry
-categories: [components, CADGeometry]
-tags: [CADFace, CADGeometry]
----
-<style>
-.post h3 {
-  word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-CADFace holds geometry representing one face in a Computer-Aided Design (CAD) CADPart. CADFace can only contain a single Shape or LOD node (with `containerField='shape').`
-
-The CADFace node belongs to the **CADGeometry** component and its default container field is *children.* It is available from X3D version 3.1 or higher.
-
-## Hierarchy
-
-```
-+ X3DNode
-  + X3DChildNode
-    + X3DProductStructureChildNode
-      + CADFace (X3DBoundedObject)*
-```
-
-<small>\* Derived from multiple interfaces.</small>
-
-## Fields
-
-### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
-
-Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
-
-#### Hint
-
-- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
-
-### SFString [in, out] **name** ""
-
-Optional *name* for this particular CAD node.
-
-#### Hints
-
-- Well-defined names can simplify design and debugging through improved author understanding.
-- [X3D Scene Authoring Hints, Naming Conventions](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions){:target="_blank"}
-
-#### Warning
-
-- *name* field is not included if this instance is a USE node, in order to avoid potential mismatches.
-
-### SFBool [in, out] **visible** TRUE
-
-Whether or not renderable content within this node is visually displayed.
-
-#### Hints
-
-- The *visible* field has no effect on animation behaviors, event passing or other non-visual characteristics.
-- Content must be *visible* to be collidable and to be pickable.
-
-### SFBool [in, out] **bboxDisplay** FALSE
-
-Whether to display bounding box for associated geometry, aligned with world coordinates.
-
-#### Hint
-
-- The bounding box is displayed regardless of whether contained content is visible.
-
-### SFVec3f [ ] **bboxSize** -1 -1 -1 <small>[0,∞) or −1 −1 −1</small>
-
-Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
-
-#### Hints
-
-- Can be useful for collision computations or inverse-kinematics (IK) engines.
-- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
-- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
-- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
-
-### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
-
-Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
-
-#### Hints
-
-- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
-- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
-- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
-
-### SFNode [in, out] **shape** NULL <small>[X3DShapeNode, LOD, Transform]</small>
-
-Contained Shape for this CADPart.
-
-#### Warning
-
-- If LOD or Transform are used, only zero or one Shape child is allowed to be active at one time.
-
-## Advisories
-
-### Hint
-
-- [X3D for Advanced Modeling (X3D4AM) slideset](https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf){:target="_blank"}
-
-### Warnings
-
-- Only zero or one Shape child is allowed to be active at one time.
-- Requires X3D `profile='Full'` or else include `<component name='CADGeometry' level='2'/>`
-
-## See Also
-
-- [X3D Specification of CADFace node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/CADGeometry.html#CADFace){:target="_blank"}