Skip to content

Latest commit

 

History

History
134 lines (91 loc) · 9.29 KB

README.md

File metadata and controls

134 lines (91 loc) · 9.29 KB

Scalable GIS Renderer for the 3D ArcGIS Maps SDK for JavaScript

SaGIS synchronizes the camera and other application state between a set of browser instances to create a single, large view of multiple displays. This open source project is a template for custom applications.

For collaborative settings, such as control rooms and presentations, rendering high resolution 3D maps on a large display provides both context and detail for a large group. This type of setup cannot be realized in a single web browser, due to performance and memory constraints.

SaGIS solves this problem by rendering using a distributed cluster, where each display is driven by a separate browser instance, typically on a separate computer. The display is then controlled by a viewer instance on a desktop, laptop or mobile device. One central websocket server synchronizes the viewer and display instances.

Read our Blog Post

Overview 3x3 tiled display wall at the Visualization and Multimedia Laboratory, University of Zurich, rendering a webscene at 7680x4320 pixels

Requirements

  • Experience in developing applications using the ArcGIS Maps SDK for JavaScript
  • Basic understanding on managing a rendering cluster for a tiled display wall

Setup

  1. npm install installs all dependencies.
  2. npm run start starts the webserver and websocket server. The webserver provides the client and viewer applications. The websocket server will synchronize all clients. It maintains the overall display layout, as well as the last state seen to initialize late-joining display clients.
  3. The next step is to configure and launch all display clients: Launch one full-screen web browser on each computer, load and configure the tile for each display: http://webserver:42000/client.html?server=wssmachine&row=1&column=1. Replace webserver with the hostname running the web server. Replace wssmachine with the hostname running the websocket server. The row and column parameter are relative the bottom right corner of the screen, a 2x2 wall would have four clients with [0, 0], [1, 0], [0, 1], [1, 1] as their row/column. The server will compute the total shape of the wall from all clients.
  4. The last step is to launch the view application from the control machine by pointing a web browser to http://webserver:42000/viewer.html?server=wssmachine. As with the clients, replace webserver and wssmachine with your hostnames.

The viewer should now connect to the server, and all clients should synchronize their view with the interactions on the viewer application.

Advanced Display Layout

Square layouts, such as the one featured above, are simple to set up. For more irregular layouts it helps to understand how the server and the ArcGIS Maps SDK for JavaScript compute the camera for each tile.

The server computes the layout to fit the shorter edge on the viewer, that is, it takes the minimum of the wall width and height for the layout rows and columns parameters. Using non-square layouts would distort the view. A 1x2 wall therefore configures a 1x1 layout. The extra column can then be used to see more data than the viewer. To keep the rendering on the wall centered, use fractional -0.5 and 0.5 column parameters for the two tiles. Likewise, a 1x3 wall would use -1, 0, and 1 as columns, mirror the viewer image on the middle display and extend the view on the left and right displays.

Viewer URL parameters

  • [server=string]: The address of the websocket synchronization server. Default is "localhost".
  • [portal=string]: The ArcGIS online portal address.
  • [webscene=string]: The webscene ID on the portal.
  • [url=string]: A layer URL to load a single layer.

Client URL parameters

  • [server=string]: The address of the websocket synchronization server. Default is "localhost".
  • [column=number]: The x coordinate of the display tile. 0 is at the left. Fractional values are valid.
  • [row=number]: The y coordinate of the display tile. 0 is at the bottom. Fractional values are valid.

Given the setup from the picture above, each client ends up with the following row, column parameters:

Overview

The size of the bezels between displays, relative to the screen width or height, is 0.07 or 0.12, respectively. The "column" bezel width is bigger since the screen height is less than the width, making the relative size of the bezel larger.

We start at the lower right corner with 0, 0 for row and column, and then add 1.07 or 1.12 for rows and columns, counting the display itself (1.0) and the relative bezel width.

State Synchronization

Both the client and the viewer use the same controller implementation to synchronize their state.

The controller on the viewer sends messages to the server, which re-broadcasts this message to all clients. Only a special tile message is interpreted by the server, to keep the global display wall layout state.

Messages are one character for the message type, followed by the message payload. The payload is typically the state in JSON. The viewer and client side deserialization and serialization must match for correct operation.

This sample implementation synchronizes some default state for viewing web scenes (webscene, camera, lighting, weather, layer visiblity). Applications are expected to extend this code for their needs.

Template Commands

Start all browser instances on a 3x3 display wall including display bezel compensation:

ssh hactar01 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=2.24&column=0&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar02 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=1.12&column=0&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar03 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=0&column=0&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar04 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=2.24&column=1.07&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar05 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=1.12&column=1.07&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar06 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=0&column=1.07&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar07 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=2.24&column=2.14&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar08 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=1.12&column=2.14&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &
ssh hactar09 "DISPLAY=:0 ./Downloads/opt/google/chrome/chrome --user-data-dir=/tmp 'https://hactar10.ifi.uzh.ch:42000/client.html?row=0&column=2.14&server=hactar10' --ignore-certificate-errors --kiosk --start-fullscreen --window-size=2560,1440" &

Hide mouse cursor on all displays:

gcc -o ./src/hhpc ./src/hhpc.c -lX11
ssh hactar01 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar02 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar03 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar04 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar05 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar06 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar07 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar08 "DISPLAY=:0 $PWD/src/hhpc"&
ssh hactar09 "DISPLAY=:0 $PWD/src/hhpc"&

Kill all display clients:

ssh hactar01 killall chrome
ssh hactar02 killall chrome
ssh hactar03 killall chrome
ssh hactar04 killall chrome
ssh hactar05 killall chrome
ssh hactar06 killall chrome
ssh hactar07 killall chrome
ssh hactar08 killall chrome
ssh hactar09 killall chrome

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

Copyright 2023 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's license.txt file.