x_ite 8.4.3 → 8.5.3

package/docs/_posts/reference/browser-services.md

@@ -3,7 +3,7 @@ title: Browser Services
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [browser, services]
+tags: [Browser, Services]
 ---
 ## Browser Object
 
@@ -49,37 +49,37 @@ The real type of this class is dependent on whether the user code is inside a pr
 
 ### Methods
 
-#### void **replaceWorld** (*X3DScene*)
+#### Promise\<void\> **replaceWorld** (*X3DScene*)
 
-Replace the current world with this new scene that has been loaded or constructed from somewhere.
+Replace the current world with this new scene that has been loaded or constructed from somewhere. A Promise is returned that will be resolved when the scene is completely loaded.
 
 #### X3DScene **createX3DFromString** (*String x3dSyntax*)
 
 The string may be any valid X3D content in any language supported by the browser implementation. If the browser does not support the content encoding the appropriate exception will be thrown.
 
-#### void|X3DScene **createX3DFromURL** (*MFString url [, Node node, String event]*)
+#### void|Promise\<X3DScene\> **createX3DFromURL** (*MFString url [, Node node, String event]*)
 
 Parse the passed URL into a X3D scene. When complete send the passed event to the passed node. The event is a string with the name of an MFNode inputOnly field of the passed node.
 
-If event and node are omitted a X3DScene object is returned.
+If event and node are omitted a Promise that resolves to a X3DScene object is returned.
 
-#### Promise **loadURL** (*MFString url [, MFString parameter]*)
+#### Promise\<void\> **loadURL** (*MFString url [, MFString parameter]*)
 
 Load the passed URL, using the passed parameter string to possibly redirect it to another frame. If the destination is the frame containing the current scene, this method may never return. The return value is a Promise object, that is resolved when the new scene is loaded.
 
-#### X3DScene **importDocument** (*DOMObject dom*)
+#### Promise\<X3DScene\> **importDocument** (*DOMObject dom*)
 
-Imports a X3D XML DOM document or fragment, converts it, and returns a X3DScene object.
+Imports a X3D XML DOM document or fragment, converts it, and returns a Promise that resolves to a X3DScene object.
 
-#### X3DScene **importJS** (*Object json*)
+#### Promise\<X3DScene\> **importJS** (*Object json*)
 
-Imports a X3D JSON document or fragment, converts it, and returns a X3DScene object.
+Imports a X3D JSON document or fragment, converts it, and returns a Promise that resolves to a X3DScene object.
 
 #### String **getBrowserProperty** (*String name*)
 
 Returns a browser property with the corresponding name.
 
-#### Browser Properties
+##### Browser Properties
 
 <table>
    <thead>
@@ -137,7 +137,7 @@ Returns a browser property with the corresponding name.
 
 Returns a browser option with the corresponding name.
 
-#### Browser Options
+##### Browser Options
 
 <table>
    <thead>
@@ -181,7 +181,7 @@ Returns a browser option with the corresponding name.
       </tr>
       <tr>
          <td>PrimitiveQuality</td>
-         <td>Render quality (tesselation level) for Box, Cone, Cylinder, Sphere</td>
+         <td>Render quality (tesselation level) for Box, Cone, Cylinder, Sphere.</td>
          <td>Low, Medium, High</td>
          <td>Medium</td>
       </tr>
@@ -209,23 +209,59 @@ Returns a browser option with the corresponding name.
          <td>Low, Medium, High</td>
          <td>Medium</td>
       </tr>
+      <tr>
+         <td>Cache</td>
+         <td>Whether or not files should be cached. (non standard)</td>
+         <td>Boolean</td>
+         <td>true</td>
+      </tr>
+      <tr>
+         <td>ContentScale</td>
+         <td>Factor with which the internal canvas size should be scaled. If set to -1 window.devicePixelRatio is used. (non standard)</td>
+         <td>Float</td>
+         <td>1</td>
+      </tr>
+      <tr>
+         <td>ContextMenu</td>
+         <td>Whether or not the context menu can be displayed. (non standard)</td>
+         <td>Boolean</td>
+         <td>true</td>
+      </tr>
+      <tr>
+         <td>Debug</td>
+         <td>Whether or not debug message should be printed into the console. (non standard)</td>
+         <td>Boolean</td>
+         <td>false</td>
+      </tr>
       <tr>
          <td>Gravity</td>
          <td>Default is gravity of Earth. (non standard)</td>
-         <td>Number</td>
+         <td>Float</td>
          <td>9.80665</td>
       </tr>
       <tr>
          <td>LogarithmicDepthBuffer</td>
-         <td>Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. It is automatically enabled if a GeoViewpoint is bound. (non standard)</td>
+         <td>Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. It is automatically enabled if a GeoViewpoint is bound. (non standard).</td>
          <td>Boolean</td>
          <td>false</td>
       </tr>
+      <tr>
+         <td>Multisampling</td>
+         <td>Number of samples used for multisampling. (non standard)</td>
+         <td>Integer</td>
+         <td>4</td>
+      </tr>
+      <tr>
+         <td>Notifications</td>
+         <td>Whether or not notifications should be displayed. (non standard)</td>
+         <td>Boolean</td>
+         <td>true</td>
+      </tr>
       <tr>
          <td>StraightenHorizon</td>
          <td>Whether the Examine viewer should straighten the horizon when navigating. (non standard)</td>
          <td>Boolean</td>
-         <td>false</td>
+         <td>true</td>
       </tr>
       <tr>
          <td>Timings</td>
@@ -244,7 +280,7 @@ Sets a browser option with the corresponding *name* to the given value.
 
 Returns a rendering property with the corresponding *name*.
 
-#### Rendering Properties
+##### Rendering Properties
 
 <table>
    <thead>
@@ -276,7 +312,7 @@ Returns a rendering property with the corresponding *name*.
          <td>The maximum number of lights supported.</td>
       </tr>
       <tr>
-         <td>AntiAliased</td>
+         <td>Antialiased</td>
          <td>Boolean</td>
          <td>True or false if the rendering is currently anti-aliased or not.</td>
       </tr>
@@ -290,6 +326,26 @@ Returns a rendering property with the corresponding *name*.
          <td>Float</td>
          <td>The amount of memory in megabytes available for textures to be placed on the video card.</td>
       </tr>
+      <tr>
+         <td>ContentScale</td>
+         <td>Boolean</td>
+         <td>Currently used factor to scale content. (non standard)</td>
+      </tr>
+      <tr>
+         <td>MaxSamples</td>
+         <td>Integer</td>
+         <td>The maximum number of samples supported for doing multisampling. (non standard)</td>
+      </tr>
+      <tr>
+         <td>Multisampling</td>
+         <td>Integer</td>
+         <td>Number of samples currently used by multisampling. (non standard)</td>
+      </tr>
+      <tr>
+         <td>LogarithmicDepthBuffer</td>
+         <td>Boolean</td>
+         <td>True or false if the logarithmic depth buffer is currently enabled or not. (non standard)</td>
+      </tr>
    </tbody>
 </table>
 
@@ -307,6 +363,10 @@ Adds a browser *callback* function associated with *key,* where *key* can be of
 
 Removes a browser callback function associated with *key*.
 
+#### void **viewAll** (*[SFNode layerNode]*)
+
+Modifies the current view to show the entire visible scene. If *layerNode* is omitted, the active layer is used.
+
 #### void **nextViewpoint** (*[SFNode layerNode]*)
 
 Changes the bound viewpoint node to the next viewpoint in the list of user viewpoints of *layerNode*. If *layerNode* is omitted, the active layer is used.

package/docs/_posts/reference/constants-services.md

@@ -3,7 +3,7 @@ title: Constants Services
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [constants, services]
+tags: [Constants, Services]
 ---
 ## X3DConstants
 

package/docs/_posts/reference/ecmascript-object-and-function-definitions.md

@@ -3,7 +3,7 @@ title: ECMAScript Object and Function Definitions
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [ecmascript, object, function, definitions]
+tags: [Ecmascript, Object, Function, Definitions]
 ---
 ## Overview
 

package/docs/_posts/reference/field-services-and-objects.md

@@ -3,7 +3,7 @@ title: Field Services and Objects
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [field, services, objects]
+tags: [Field, Services, Objects]
 ---
 ## X3DFieldDefinition
 
@@ -411,19 +411,19 @@ Removes a field callback function associated with the parameters *name* and *key
 
 Returns the X3D VRML-encoded string that, if parsed as the value of an SFNode field, produce this node.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toXMLString** (\[options\])
 
 Returns the X3D XML-encoded string that, if parsed as the value of an SFNode field, produce this node.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toJSONString** (\[options\])
 
 Returns the X3D JSON-encoded string that, if parsed as the value of an SFNode field, produce this node.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 ## SFRotation Object
 
@@ -814,7 +814,7 @@ Returns true if the passed MF* *array* of the same type is equals to this object
 
 #### Other Array functions
 
-Common Array functions like `at`, `concat`, `entries`, `every`, `fill`, `filter`, `find`, `findIndex`, `findLast`, `findLastIndex`, `flat`, `flatMap`, `forEach`, `includes`, `indexOf`, `join`, `keys`, `lastIndexOf`, `map`, `pop`, `push`, `reduce`, `reduceRight`, `shift`, `slice`, `some`, `splice`, `unshift`, `values` are also available.
+Common Array functions like `at`, `concat`, `entries`, `every`, `fill`, `filter`, `find`, `findIndex`, `findLast`, `findLastIndex`, `flat`, `flatMap`, `forEach`, `includes`, `indexOf`, `join`, `keys`, `lastIndexOf`, `map`, `pop`, `push`, `reduce`, `reduceRight`, `reverse`, `shift`, `slice`, `some`, `sort`, `splice`, `unshift`, `values` are also available.
 
 ## MFBool Object
 
@@ -980,19 +980,19 @@ An integer containing the number of elements in the array. Assigning an integer
 
 Returns the X3D VRML-encoded string that, if parsed as the value of an MFNode field, produce this node.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toXMLString** (\[options\])
 
 Returns the X3D XML-encoded string that, if parsed as the value of an MFNode field, produce this node.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toJSONString** (\[options\])
 
 Returns the X3D JSON-encoded string that, if parsed as the value of an MFNode field, produce this node.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 ## MFRotation Object
 

package/docs/_posts/reference/prototype-services.md

@@ -3,7 +3,7 @@ title: Prototype Services
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [prototype, services]
+tags: [Prototype, Services]
 ---
 ## X3DProtoDeclaration
 
@@ -37,19 +37,19 @@ Creates a new default instance of the prototype.
 
 Returns the X3D VRML-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this prototype.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toXMLString** (\[options\])
 
 Returns the X3D XML-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this prototype.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toJSONString** (\[options\])
 
 Returns the X3D JSON-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this prototype.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 ## X3DExternProtoDeclaration
 
@@ -95,19 +95,19 @@ Triggers the load of the extern prototype. If the extern prototype is already lo
 
 Returns the X3D VRML-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this extern prototype.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toXMLString** (\[options\])
 
 Returns the X3D XML-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this extern prototype.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toJSONString** (\[options\])
 
 Returns the X3D JSON-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this extern prototype.
 
-For options see X3DScene.toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 ## ProtoDeclarationArray
 

package/docs/_posts/reference/route-services.md

@@ -3,7 +3,7 @@ title: Route Services
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [route, services]
+tags: [Route, Services]
 ---
 ## X3DRoute
 

package/docs/_posts/reference/scene-services.md

@@ -3,7 +3,7 @@ title: Scene Services
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [scene, services]
+tags: [Scene, Services]
 ---
 ## X3DExecutionContext
 
@@ -112,7 +112,7 @@ None.
 
 ### Methods
 
-#### Array<string> (*String name*)
+#### Array\<string\> **getMetaData** (*String name*)
 
 Returns the metadata values array associated with *name*.
 
@@ -120,7 +120,7 @@ Returns the metadata values array associated with *name*.
 
 Creates or updates the metadata with *name* and *value.*
 
-#### void **setMetaData** (*String name, Array<string> values*)
+#### void **setMetaData** (*String name, Array\<string\> values*)
 
 Creates or updates the metadata with *name* and *values.* There must be at least one value in *values.*
 
@@ -168,13 +168,13 @@ An object with one or more of these properties:
 
 Returns the X3D XML-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this scene.
 
-For options see toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 #### String **toJSONString** (\[options\])
 
 Returns the X3D JSON-encoded string that, if parsed as the value of createX3DFromString () of X3DBrowser, produce this scene.
 
-For options see toVRMLString.
+For options see [X3DScene.toVRMLString](scene-services#string-tovrmlstring-options).
 
 ## ProfileInfo
 

package/docs/_posts/reference/script-node-authoring-interface.md

@@ -3,7 +3,7 @@ title: Script Node Authoring Interface
 date: 2022-11-28
 nav: reference
 categories: [Reference]
-tags: [script, node, authoring, interface]
+tags: [Script, Node, Authoring, Interface]
 ---
 ## Overview
 

package/docs/_posts/report-a-bug.md

@@ -3,7 +3,7 @@ title: Report a Bug
 date: 2022-12-02
 nav: main
 categories: []
-tags: [bug, report, issue]
+tags: [Bug, Report, Issue]
 ---
 If you run into any bugs or encounter any other abnormal issues with X_ITE, let us know!
 

package/docs/_posts/setup-a-localhost-server.md

@@ -3,7 +3,7 @@ title: Setup a localhost Server
 date: 2022-12-02
 nav: main
 categories: []
-tags: [setup, localhost, server, xhr]
+tags: [Setup, Localhost, Server, XHR]
 ---
 ## Overview
 
@@ -11,6 +11,10 @@ X_ITE makes use of the XMLHttpRequest object to load files and there's no way ro
 
 To work around this problem you must set up a localhost server, then you can access your local files under the web address http://**localhost**/...
 
+### Using a Browser Extension
+
+You can use this [Browser Extension](https://webextension.org/listing/access-control.html) to unlock the CORS restrictions imposed by your browser. This is useful if you are in development mode and is easy to use.
+
 ## Using an Application
 
 There are several applications on the Internet which can make a localhost server. Here I would like to recommend you two of them: