You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/simulation-server.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ HTTP request handlers:
38
38
39
39
WebSocket request handlers:
40
40
* The `/client` request on the simulation server URL will setup a new Webots instance and return the Webots WebSocket URL.
41
-
The payload should be a JSON object named `start` containing a `url` string and optionally a `mode` string which can be either `x3d` (default value) or `mjpeg`.
41
+
The payload should be a JSON object named `start` containing a `url` string and optionally a `mode` string which can be either `w3d` (default value) or `mjpeg`.
Copy file name to clipboardExpand all lines: docs/guide/starting-webots.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ Options:
70
70
71
71
--stream[=<mode>]
72
72
Start the Webots streaming server. The <mode> argument should be either
73
-
x3d (default) or mjpeg.
73
+
w3d (default) or mjpeg.
74
74
75
75
--extern-urls
76
76
Print on stdout the URL of extern controllers that should be started.
@@ -110,7 +110,7 @@ Note that the *stderr* stream may also contain Webots error or warning messages.
110
110
111
111
The `--port` option changes the default TCP port used by Webots for serving robot windows, web streaming and extern controllers. By default, Webots sets up its TCP server on port 1234. When starting multiple Webots instances, the ports are configured with consecutive values of 1234.
112
112
113
-
The `--stream` option enables the Webots streaming server in either `x3d` (default) or `mjpeg` mode.
113
+
The `--stream` option enables the Webots streaming server in either `w3d` (default) or `mjpeg` mode.
114
114
You can get more information about web streaming in [this section](web-streaming.md).
115
115
116
116
For example, the following command will start Webots with the streaming server enabled on the TCP port '1235' in 'mjpeg' mode: `webots --port=1235 --stream=mjpeg`
Copy file name to clipboardExpand all lines: docs/guide/web-animation.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Select the `Share...` menu item and choose if you want to upload it to [webots.c
21
21
Click the `Stop HTML5 animation` to finish the recording and save the animation.
22
22
Webots will ask to playback the resulting file in the default Web browser (from the OS settings).
23
23
24
-
**Note**: The `CSS` file, the `X3D` file, the `JSON` animation file and the required textures are exported in the same directory as the target `HTML` file.
24
+
**Note**: The `CSS` file, the `W3D` file, the `JSON` animation file and the required textures are exported in the same directory as the target `HTML` file.
25
25
26
26
**Note**: The `CSS` file is meant to be used as a styling guide but can be modified/removed.
27
27
@@ -40,7 +40,7 @@ The web animation is played by a web component from the [WebotsView.js] package
40
40
41
41
The following attributes are available:
42
42
*`data-thumbnail`: the name of the .jpg file containing the thumbnail. If the `data-thumbnail` attribute is not set, a default thumbnail will be displayed during load.
43
-
*`data-scene`: the name of the .x3d file containing the 3d scene.
43
+
*`data-scene`: the name of the .w3d file containing the 3d scene.
44
44
*`data-animation`: the name of the .json file containing the animation sequence.
45
45
*`data-autoplay`: boolean to determine if the animation should be played automatically, `true` by default.
46
46
*`data-isMobileDevice`: boolean variable specifying if the application is running on a mobile device.
@@ -55,7 +55,7 @@ For more complex interaction with the web component, the following functions are
55
55
*`hasAnimation()`: return `true` if there is already a animation loaded by the web component, `false` otherwise.
56
56
*`hasView()`: return `true` if a view exist, `false` otherwise.
57
57
*`loadAnimation(scene, animation, play, mobileDevice, thumbnail, raw)`: load and play the animation.
58
-
*`scene`: name of the .x3d file.
58
+
*`scene`: name of the .w3d file.
59
59
*`animation`: name of the .json file.
60
60
*`play`: if false, the animation will be paused, otherwise it will be played.
61
61
*`mobileDevice`: boolean variable specifying if the application is running on a mobile device.
Copy file name to clipboardExpand all lines: docs/guide/web-scene.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,18 @@
1
-
## X3D and Web Scene
1
+
## W3D and Web Scene
2
2
3
3
### Description
4
4
5
5
Webots can export a world to an interactive 3D `HTML` page.
6
6
This feature is especially useful for publishing Webots-created worlds on the Web.
7
7
8
-
During the export, a [X3D](http://www.web3d.org/x3d/what-x3d) file, a `HTML5` page and a `CSS`file are generated.
8
+
During the export, a `W3D` file, a `HTML5` page and a `CSS`file are generated.
9
9
10
-
The `X3D` file contains the graphical information of the world.
11
-
`X3D` is a modern `XML`-based file format for representing 3D computer graphics.
12
-
In Webots, the `X3D` file uses a custom format that is heavily based on the `X3D` file format.
10
+
The `W3D` file contains the graphical information of the world.
11
+
`W3D` is a Webots custom `XML`-based file format for representing 3D computer graphics.
13
12
14
13
The `CSS` file is used to style the following `HTML5` page.
15
14
16
-
The `HTML5` page contains a Webots player which displays the `X3D` file as shown in the [figure below](#screenshot-of-a-web-scene-page-generated-by-webots).
15
+
The `HTML5` page contains a Webots player which displays the `W3D` file as shown in the [figure below](#screenshot-of-a-web-scene-page-generated-by-webots).
17
16
It can be open in any recent Web browser as documented in the [section below](#remarks-on-the-used-technologies-and-their-limitations).
18
17
The 3D navigation in the player is possible using the mouse or the touch screen, similarly to the Webots navigation.
19
18
@@ -28,7 +27,7 @@ The 3D navigation in the player is possible using the mouse or the touch screen,
28
27
Select the `Share...` menu item, choose if you want to upload it to [webots.cloud](https://webots.cloud) or to save it locally, then click the `Export scene` button.
29
28
When the export is completed, Webots will ask to playback the resulting file in the default Web browser.
30
29
31
-
**Note**: The `CSS` file, the `X3D` file and the required textures are exported in the same directory as the target `HTML` file.
30
+
**Note**: The `CSS` file, the `W3D` file and the required textures are exported in the same directory as the target `HTML` file.
32
31
33
32
**Note**: The `CSS` file is meant to be used as a styling guide but can be modified/removed.
34
33
@@ -48,13 +47,13 @@ The web scene is displayed by a web component from the [WebotsView.js] package c
48
47
49
48
The following attributes are available:
50
49
*`data-thumbnail`: the name of the .jpg file containing the thumbnail. If the `data-thumbnail` attribute is not set, a default thumbnail will be displayed during load.
51
-
*`data-scene`: the name of the .x3d file containing the 3d scene. It is evaluated only once: when the page is loaded. If the `data-scene` attribute is set, the `webots-view` web-component will automatically try to load the web scene .
50
+
*`data-scene`: the name of the .w3d file containing the 3d scene. It is evaluated only once: when the page is loaded. If the `data-scene` attribute is set, the `webots-view` web-component will automatically try to load the web scene .
52
51
53
52
For more complex interaction with the web component, the following functions are available:
54
53
*`close()`: close the current scene. Note that if the `webots-view` element is removed from the HTML page or `loadScene`, `loadAnimation` or `connect` is called, `close` will be automatically called.
55
54
*`onready()`: a function that can be overridden. It will be called once the scene is loaded.
56
55
*`loadScene(scene, mobileDevice, thumbnail)`: load and display the scene.
57
-
*`scene`: name of the .x3d file.
56
+
*`scene`: name of the .w3d file.
58
57
*`mobileDevice`: boolean variable specifying if the application is running on a mobile device.
59
58
*`thumbnail`: the URL of the scene thumbnail.
60
59
*`setAmbientOcclusion(level)`: change the intensity of the ambient occlusion to the given level.
@@ -85,7 +84,7 @@ It may occur that the rendering in the Webots application and in the exported We
85
84
}
86
85
document.body.appendChild(webotsView);
87
86
88
-
webotsView.loadScene("scene.x3d");
87
+
webotsView.loadScene("scene.w3d");
89
88
}
90
89
91
90
function remove() {
@@ -101,7 +100,7 @@ The Webots player is using internally the `WRENJS` library (based on `WebGL 2`).
101
100
Unfortunately it is not yet supported by Safari (see details on the [deployment of WebGL 2](https://caniuse.com/webgl2)).
102
101
In case of related issues, make sure that `WebGL 2` is enabled in your Web browser settings.
103
102
104
-
Some web browsers (for example Chrome and Firefox 68 or later) cannot open local files using the `file` protocol by default, while this is required by the Webots player to open the `X3D` file and the textures.
103
+
Some web browsers (for example Chrome and Firefox 68 or later) cannot open local files using the `file` protocol by default, while this is required by the Webots player to open the `W3D` file and the textures.
105
104
Here are some workarounds:
106
105
- run a local HTTP server in the directory containing the exported files, and launch the scene or animation through the server by navigating to the `HTML` file.
Copy file name to clipboardExpand all lines: docs/guide/web-streaming.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@ Webots can be used as a Web streaming server, i.e., to stream a simulation to se
6
6
In this mode the user can watch an already running simulation and navigate into the scene but cannot interact with the simulation, i.e. controlling the execution of the simulation and modifying the robot controller program.
7
7
8
8
Two different streaming modes are available:
9
-
-`x3d` (default): the simulation is streamed using a mechanism similar to the [web animation export](web-animation.md) except that the `X3D` file and the animation are sent on the fly to the web browser clients.
9
+
-`w3d` (default): the simulation is streamed using a mechanism similar to the [web animation export](web-animation.md) except that the `W3D` file and the animation are sent on the fly to the web browser clients.
10
10
-`mjpeg`: the Webots scene rendered on the server is directly sent as an `MJPEG` image to the web browser client.
11
-
You should choose between the `x3d` and `mjpeg` depending on the type of application you are developing.
11
+
You should choose between the `w3d` and `mjpeg` depending on the type of application you are developing.
12
12
The following table summarizes the advantages (`+`) and disadvantages (`-`) of the the two modes:
13
13
14
-
| feature / mode |`x3d`|`mjpeg`|
14
+
| feature / mode |`w3d`|`mjpeg`|
15
15
|:-----------------------:|:-----:|:-------:|
16
16
| high resolution images | + | - |
17
17
| 3D navigation latency | + | - |
@@ -81,8 +81,8 @@ This is the API of the `webots-streaming` web component:
81
81
*`server`: The URL of the server. Different URL formats are supported:
82
82
* URL to a session server: "https://webots.cloud/ajax/server/session.php?url=https://github.com/cyberbotics/webots/projects/languages/python/worlds/example.wbt"
83
83
* WebSocket URL (i.e. "ws://localhost:1234"): this format is used for web broadcast streaming.
84
-
* URL to a X3D file (i.e. "file.x3d"): this format is used for showing a [web scene](web-scene.md) or a [web animation](web-animation.md).
85
-
*`mode`: `x3d` or `mjpeg`.
84
+
* URL to a W3D file (i.e. "file.w3d"): this format is used for showing a [web scene](web-scene.md) or a [web animation](web-animation.md).
85
+
*`mode`: `w3d` or `mjpeg`.
86
86
*`broadcast`: boolean variable enabling or not the broadcast.
87
87
*`isMobileDevice`: boolean variable specifying if the application is running on a mobile device.
88
88
*`timeout`: the time (in seconds) after which the simulation will be automatically paused (until the play button is pressed again). By default, no timeout is set.
@@ -107,7 +107,7 @@ This is the API of the `webots-streaming` web component:
107
107
108
108
Moreover, the following attributes are available:
109
109
*`data-server`: URL of the server.
110
-
*`data-mode`: `x3d` or `mjpeg`.
110
+
*`data-mode`: `w3d` or `mjpeg`.
111
111
*`data-broadcast`: boolean variable enabling or not the broadcast.
112
112
*`data-isMobileDevice`: boolean variable specifying if the application is running on a mobile device.
113
113
*`data-thumbnail`: the name of the .jpg file containing the thumbnail. If the `data-thumbnail` attribute is not set, a default thumbnail will be displayed during load.
Copy file name to clipboardExpand all lines: docs/guide/webots-cloud.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Webots features a "share" button that allows you to upload a 3D [Web Scene](web-
10
10
This is useful to show models of robots, sensors, actuators, objects, environments or simulation play-back to colleagues or to the wide public.
11
11
Once your scene or animation is uploaded, you get a link (web URL) pointing to your upload, which you can share.
12
12
Anyone with this link can view your 3D scene or animation with a simple mouse click.
13
-
Scenes and animations can also be uploaded on webots.cloud by clicking the "Add a new scene/animation" button, and uploading locally saved `X3D`, `JSON`, thumbnail and texture files.
13
+
Scenes and animations can also be uploaded on webots.cloud by clicking the "Add a new scene/animation" button, and uploading locally saved `W3D`, `JSON`, thumbnail and texture files.
0 commit comments