x_ite 4.2.17 → 4.7.7

package/docs/reference/Browser-Services.md

@@ -0,0 +1,361 @@
+# Browser Services
+
+## Browser Object
+
+This section lists the methods available in the *browser* object, which allows scripts to get and set browser information.
+
+### Instance Creation Method\(s\)
+
+None. This object cannot be instantiated by the user. One global instance of the object is available. The name of the instance is Browser.
+
+### Properties
+
+#### **name**
+
+A browser-implementation specific string describing the browser.
+
+#### **version**
+
+A browser-implementation specific string describing the browser version.
+
+#### **currentSpeed**
+
+The current speed of the avatar in m/s.
+
+#### **currentFrameRate**
+
+The current frame rate in frames per second.
+
+#### **description**
+
+A user-defined string which can be read and written.
+
+#### **supportedComponents**
+
+The property value cannot be changed, but the properties of the ComponentInfoArray can be.
+
+#### **supportedProfiles**
+
+The property value cannot be changed, but the properties of the ProfileInfoArray can be.
+
+#### **currentScene**
+
+The real type of this class is dependent on whether the user code is inside a prototype instance or not. If the user code is inside a prototype instance the property represent a X3DExecutionContext otherwise it represent a X3DScene.
+
+### Methods
+
+#### void **replaceWorld** (*X3DScene*)
+
+Replace the current world with this new scene that has been loaded or constructed from somewhere.
+
+#### 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\]*)
+
+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.
+
+#### Promise **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*)
+
+Imports a X3D XML DOM document or fragment, converts it, and returns a X3DScene object.
+
+#### X3DScene **importJS** (*Object json*)
+
+Imports a X3D JSON document or fragment, converts it, and returns a X3DScene object.
+
+#### String **getBrowserProperty** (*String name*)
+
+Returns a browser property with the corresponding name.
+
+#### Browser Properties
+
+<table class=" table">
+   <thead>
+      <tr>
+         <th>Name</th>
+         <th>Type</th>
+         <th>Description</th>
+      </tr>
+   </thead>
+   <tbody>
+      <tr>
+         <td>ABSTRACT_NODES</td>
+         <td>Boolean</td>
+         <td>The browser implementation supports the ability to describe each node type with interfaces that correspond to the abstract node types as defined in ISO/IEC 19775-1 in addition to the basic requirement to support the X3DBaseNode abstract type. This indicates that the browser supports at least Conformance Level 2.</td>
+      </tr>
+      <tr>
+         <td>CONCRETE_NODES</td>
+         <td>Boolean</td>
+         <td>The browser implementation supports the ability to describe each node type with interfaces that correspond to the concrete node types as defined in ISO/IEC 19775-1 in addition to the requirement to support all of the abstract types. This indicates that the browser supports at least Conformance Level 3.</td>
+      </tr>
+      <tr>
+         <td>EXTERNAL_INTERACTIONS</td>
+         <td>Boolean</td>
+         <td>This browser supports the additional services required by external interfaces. A browser provided to user code in internal interactions does not set this property.</td>
+      </tr>
+      <tr>
+         <td>PROTOTYPE_CREATE</td>
+         <td>Boolean</td>
+         <td>The browser implementation supports the ability to dynamically create PROTO and EXTERNPROTO representations through service requests. The basic service capability only allows the ability to create instances of predefined PROTO structures read from a file format.</td>
+      </tr>
+      <tr>
+         <td>DOM_IMPORT</td>
+         <td>Boolean</td>
+         <td>The browser implementation supports the importDocument service request.</td>
+      </tr>
+      <tr>
+         <td>XML_ENCODING</td>
+         <td>Boolean</td>
+         <td>The browser supports XML as a file format encoding.</td>
+      </tr>
+      <tr>
+         <td>CLASSIC_VRML_ENCODING</td>
+         <td>Boolean</td>
+         <td>The browser supports the Classic VRML encoding.</td>
+      </tr>
+      <tr>
+         <td>BINARY_ENCODING</td>
+         <td>Boolean</td>
+         <td>The browser supports the binary file format encoding.</td>
+      </tr>
+   </tbody>
+</table>
+
+#### String **getBrowserOption** (*String name*)
+
+Returns a browser option with the corresponding name.
+
+#### Browser Options
+
+<table class=" table">
+   <thead>
+      <tr>
+         <th>Name</th>
+         <th>Description</th>
+         <th>Type / valid range</th>
+         <th>Default</th>
+      </tr>
+   </thead>
+   <tbody>
+      <tr>
+         <td>Antialiased</td>
+         <td>Render using hardware antialiasing if available.</td>
+         <td>Boolean</td>
+         <td>false</td>
+      </tr>
+      <tr>
+         <td>Dashboard</td>
+         <td>Display browser navigation user interface.</td>
+         <td>Boolean</td>
+         <td>true</td>
+      </tr>
+      <tr>
+         <td>Rubberband</td>
+         <td>Display a rubberband line when walk or fly.</td>
+         <td>Boolean</td>
+         <td>true</td>
+      </tr>
+      <tr>
+         <td>EnableInlineViewpoints</td>
+         <td>Viewpoints from Inline nodes are included in list of viewpoints if made available by the Inline node.</td>
+         <td>Boolean</td>
+         <td>true</td>
+      </tr>
+      <tr>
+         <td>MotionBlur</td>
+         <td>Render animations with motion blur.</td>
+         <td>Boolean</td>
+         <td>false</td>
+      </tr>
+      <tr>
+         <td>PrimitiveQuality</td>
+         <td>Render quality (tesselation level) for Box, Cone, Cylinder, Sphere</td>
+         <td>Low, Medium, High</td>
+         <td>Medium</td>
+      </tr>
+      <tr>
+         <td>QualityWhenMoving</td>
+         <td>Render quality while camera is moving.</td>
+         <td>Low, Medium, High, Same (as while stationary)</td>
+         <td>Same</td>
+      </tr>
+      <tr>
+         <td>Shading</td>
+         <td>Specify shading mode for all objects.</td>
+         <td>Wireframe, Flat, Gouraud, Phong</td>
+         <td>Gouraud</td>
+      </tr>
+      <tr>
+         <td>SplashScreen</td>
+         <td>Display browser splash screen on startup.</td>
+         <td>Boolean</td>
+         <td>true</td>
+      </tr>
+      <tr>
+         <td>TextureQuality</td>
+         <td>Quality of texture map display.</td>
+         <td>Low, Medium, High</td>
+         <td>Medium</td>
+      </tr>
+      <tr>
+         <td>Gravity</td>
+         <td>Default is gravity of Earth. (non standard)</td>
+         <td>Number</td>
+         <td>9.80665</td>
+      </tr>
+      <tr>
+         <td>LogarithmicDepthBuffer</td>
+         <td>Whether to use a logarithmic depth buffer. It may be neccesary to use this if dealing with huge differences in scale in a single scene. (non standard)</td>
+         <td>Boolean</td>
+         <td>false</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>
+      </tr>
+      <tr>
+         <td>Timings</td>
+         <td>Whether browser timings should be displayed.</td>
+         <td>Boolean</td>
+         <td>false</td>
+      </tr>
+   </tbody>
+</table>
+
+#### void **setBrowserOption** (*String name, Object value*)
+
+Sets a browser option with the corresponding *name* to the given value.
+
+#### String **getRenderingProperty** (*String name*)
+
+Returns a rendering property with the corresponding *name*.
+
+#### Rendering Properties
+
+<table class=" table">
+   <thead>
+      <tr>
+         <th>Name</th>
+         <th>Type</th>
+         <th>Description</th>
+      </tr>
+   </thead>
+   <tbody>
+      <tr>
+         <td>Shading</td>
+         <td>String</td>
+         <td>The type of shading algorithm in use. Typical values are Flat, Gouraud, Phong, Wireframe.</td>
+      </tr>
+      <tr>
+         <td>MaxTextureSize</td>
+         <td>Integer</td>
+         <td>The maximum texture size supported.</td>
+      </tr>
+      <tr>
+         <td>TextureUnits</td>
+         <td>Integer</td>
+         <td>The number of texture units supported for doing multitexture.</td>
+      </tr>
+      <tr>
+         <td>MaxLights</td>
+         <td>Integer</td>
+         <td>The maximum number of lights supported.</td>
+      </tr>
+      <tr>
+         <td>AntiAliased</td>
+         <td>Boolean</td>
+         <td>True or false if the rendering is currently anti-aliased or not.</td>
+      </tr>
+      <tr>
+         <td>ColorDepth</td>
+         <td>Integer</td>
+         <td>The number of bits of color depth supported by the screen. Allows for optimized selection of textures, particularly for lower color depth screen capabilities.</td>
+      </tr>
+      <tr>
+         <td>TextureMemory</td>
+         <td>Float</td>
+         <td>The amount of memory in megabytes available for textures to be placed on the video card.</td>
+      </tr>
+   </tbody>
+</table>
+
+#### void **addBrowserCallback** (*Any key, Function callback*)
+
+Adds a browser *callback* function associated with *key,* where *key* can be of any type. The callback function is called when a browser event has been occurred. The signature of the callback function is *function (browserEvent)*, where browserEvent can be any value listed below:
+
+- X3DConstants .CONNECTION_ERROR
+- X3DConstants .BROWSER_EVENT
+- X3DConstants .INITIALIZED_EVENT
+- X3DConstants .SHUTDOWN_EVENT
+- X3DConstants .INITIALIZED_ERROR
+
+#### void **removeBrowserCallback** (*Any key*)
+
+Removes a browser callback function associated with *key*.
+
+#### 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.
+
+#### void **previousViewpoint** (*[SFNode layerNode]*)
+
+Changes the bound viewpoint node to the previous viewpoint in the list of user viewpoints of *layerNode*. If *layerNode* is omitted, the active layer is used.
+
+#### void **firstViewpoint** (*[SFNode layerNode]*)
+
+Changes the bound viewpoint node to the first viewpoint in the list of user viewpoints of *layerNode*. If *layerNode* is omitted, the active layer is used.
+
+#### void **lastViewpoint** (*[SFNode layerNode]*)
+
+Changes the bound viewpoint node to the last viewpoint in the list of user viewpoints of *layerNode*. If *layerNode* is omitted, the active layer is used.
+
+#### void **changeViewpoint** (*[SFNode layerNode,] name String*)
+
+Changes the bound viewpoint node to the viewpoint named name. The viewpoint must be available in *layerNode*. If *layerNode* is omitted, the active layer is used.
+
+#### void **print** (*Object object*)
+
+Prints *object* to the browser's console without a newline character. Successive calls to this function append the descriptions on the same line. The output is the implicit call to the object's `toString ()` function.
+
+#### void **println** (*Object object*)
+
+Prints *object* to the browser's console, inserting a newline character after the output. Successive calls to this function will result in each output presented on separate lines. The output is the implicit call to the object's `toString ()` function.
+
+### VRML Methods
+
+#### String **getName** ()
+
+#### String **getVersion** ()
+
+#### Number **getCurrentSpeed** ()
+
+#### Number **getCurrentFrameRate** ()
+
+#### String **getWorldURL** ()
+
+#### void **replaceWorld** (*MFNode nodes*)
+
+#### MFNode **createVrmlFromString** (*String vrmlSyntax*)
+
+#### void **createVrmlFromURL** (*MFString url, SFNode node, String event*)
+
+#### void **addRoute** (*SFNode sourceNode, String sourceField, SFNode destinationNode, String destinationField*)
+
+Add a route from the passed *sourceField* to the passed *destinationField*.
+
+#### void **deleteRoute** (*SFNode sourceNode, String sourceField, SFNode destinationNode, String destinationField*)
+
+Remove the route between the passed *sourceField* and passed *destinationField*, if one exists.
+
+#### void **loadURL** (*MFString url \[, MFString parameter\]*)
+
+#### void **setDescription** (*String description*)