2017-01-21 17:06:19 +00:00
|
|
|
"use strict";
|
|
|
|
|
|
|
|
// npm modules
|
|
|
|
window.EventEmitter = require("event-emitter-es6");
|
|
|
|
window.FaviconNotification = require("favicon-notification");
|
2017-02-04 21:26:48 +00:00
|
|
|
window.panzoom = require("pan-zoom");
|
2017-01-21 17:06:19 +00:00
|
|
|
|
|
|
|
// Our files
|
|
|
|
import RippleLink from './RippleLink';
|
2017-02-19 11:38:08 +00:00
|
|
|
import ViewportSyncer from './ViewportSyncer';
|
2017-02-21 20:34:18 +00:00
|
|
|
import OtherClient from './OtherClient';
|
2017-04-15 15:20:30 +00:00
|
|
|
import Pencil from './Pencil';
|
2017-01-21 17:06:19 +00:00
|
|
|
import { get } from './Utilities';
|
2017-04-15 12:13:07 +00:00
|
|
|
import Keyboard from './Utilities/Keyboard';
|
2017-01-21 17:06:19 +00:00
|
|
|
|
|
|
|
class BoardWindow extends EventEmitter
|
|
|
|
{
|
|
|
|
constructor(canvas)
|
|
|
|
{
|
|
|
|
super(); // Run the parent constructor
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
// The maximum target fps.
|
2017-01-22 13:05:59 +00:00
|
|
|
this.maxFps = 60;
|
2017-03-02 20:36:27 +00:00
|
|
|
// The target fps at which we should send cursor updates.
|
2017-02-07 21:29:17 +00:00
|
|
|
this.cursorUpdateFrequency = 5;
|
2017-02-19 15:55:22 +00:00
|
|
|
|
|
|
|
// The radius of other clients' cursors.
|
|
|
|
this.otherCursorRadius = 10;
|
|
|
|
// The width of the lines in other clients' cursors.
|
|
|
|
this.otherCursorWidth = 2;
|
|
|
|
|
2017-04-24 19:12:14 +00:00
|
|
|
this.currentPlaneName = "(You haven't landed yet!)";
|
|
|
|
// Whether to display the chunk grid or not
|
|
|
|
this.displayGrid = false;
|
|
|
|
|
|
|
|
this.gridLineWidth = 2;
|
|
|
|
this.gridLineColour = "rgba(22, 123, 228, 0.53)";
|
2017-04-24 20:42:31 +00:00
|
|
|
this.primaryGridLineWidth = 4;
|
|
|
|
this.primaryGridLineColour = "rgba(31, 223, 4, 0.68)";
|
2017-04-24 19:12:14 +00:00
|
|
|
|
2017-02-19 15:55:22 +00:00
|
|
|
// --~~~--
|
|
|
|
|
2017-02-07 21:29:17 +00:00
|
|
|
// Setup the fps indicator in the top right corner
|
2017-01-22 13:05:59 +00:00
|
|
|
this.renderTimeIndicator = document.createElement("span");
|
|
|
|
this.renderTimeIndicator.innerHTML = "0ms";
|
|
|
|
document.querySelector(".fps").appendChild(this.renderTimeIndicator);
|
|
|
|
|
2017-02-19 13:22:35 +00:00
|
|
|
// --~~~--
|
|
|
|
|
|
|
|
// Our unique id
|
|
|
|
this.Id = -1;
|
|
|
|
// Our colour
|
|
|
|
this.Colour = "rgba(255, 255, 255, 0.3)";
|
|
|
|
|
2017-04-14 20:08:36 +00:00
|
|
|
// The current state of the viewport.
|
|
|
|
this.viewport = {
|
|
|
|
// The x coordinate of the viewport.
|
|
|
|
x: 0,
|
|
|
|
// The y coordinate of the viewport.
|
|
|
|
y: 0,
|
2017-04-24 20:42:31 +00:00
|
|
|
// The width of the viewport
|
|
|
|
get width() {
|
|
|
|
return canvas.width * 1/this.zoomLevel
|
|
|
|
},
|
|
|
|
// The height of the viewport
|
|
|
|
get height() {
|
|
|
|
return canvas.height * 1/this.zoomLevel
|
|
|
|
},
|
2017-04-14 20:08:36 +00:00
|
|
|
// The zoom level of the viewport. 1 = normal.
|
|
|
|
zoomLevel: 1
|
|
|
|
};
|
2017-04-24 19:12:14 +00:00
|
|
|
|
|
|
|
// The current grid size
|
|
|
|
this.gridSize = -1;
|
2017-04-14 20:08:36 +00:00
|
|
|
|
2017-02-19 13:22:35 +00:00
|
|
|
// --~~~--
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
// Setup the canvas
|
2017-01-21 17:06:19 +00:00
|
|
|
this.canvas = canvas;
|
|
|
|
this.context = canvas.getContext("2d");
|
2017-02-04 21:26:48 +00:00
|
|
|
|
2017-02-19 13:22:35 +00:00
|
|
|
// Grab a reference to the sidebar
|
|
|
|
this.sidebar = document.getElementById("sidebar");
|
|
|
|
|
2017-02-19 15:55:22 +00:00
|
|
|
// Create a map to store information about other clients in
|
|
|
|
this.otherClients = new Map();
|
|
|
|
|
2017-04-24 19:12:14 +00:00
|
|
|
/**
|
|
|
|
* The currents tate of the keyboard.
|
|
|
|
* @type {Keyboard}
|
|
|
|
*/
|
|
|
|
this.keyboard = new Keyboard();
|
|
|
|
// Toggle the grid display when the g key is released
|
|
|
|
this.keyboard.on("keyup-g", (function(event) {
|
|
|
|
this.displayGrid = this.displayGrid ? false : true;
|
|
|
|
console.info(`[BoardWindow/KeyboardHandler] Grid display set to ${this.displayGrid ? "on" : "off"}`);
|
|
|
|
}).bind(this))
|
2017-04-15 12:13:07 +00:00
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
// --~~~--
|
|
|
|
|
|
|
|
// Setup the favicon thingy
|
|
|
|
|
2017-01-21 17:06:19 +00:00
|
|
|
FaviconNotification.init({
|
|
|
|
color: '#ff6333'
|
|
|
|
});
|
|
|
|
FaviconNotification.add();
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
// Setup the input controls
|
|
|
|
window.panzoom(canvas, this.handleCanvasMovement.bind(this));
|
|
|
|
|
2017-02-19 11:57:42 +00:00
|
|
|
// --~~~--
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
// Fetch the RippleLink connection information and other settings from
|
|
|
|
// the server
|
2017-01-21 17:06:19 +00:00
|
|
|
get("/Settings.json").then(JSON.parse).then((function(settings) {
|
2017-01-21 18:38:52 +00:00
|
|
|
console.info("[setup]", "Obtained settings from server:", settings);
|
2017-01-21 17:06:19 +00:00
|
|
|
this.settings = settings;
|
|
|
|
this.setup();
|
|
|
|
}).bind(this), function(errorMessage) {
|
|
|
|
console.error(`Error: Failed to fetch settings from server! Response: ${errorMessage}`);
|
|
|
|
});
|
|
|
|
|
2017-02-19 11:57:42 +00:00
|
|
|
// --~~~--
|
|
|
|
|
|
|
|
// Setup a bunch of event listeners
|
|
|
|
// The ones that depend on the RippleLink will get setup later
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
// Make the canvas track the window size
|
2017-01-21 17:06:19 +00:00
|
|
|
this.trackWindowSize();
|
|
|
|
}
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
/**
|
|
|
|
* Setup ready for user input.
|
|
|
|
* This mainly consists of establishing the RippleLink connection to the server.
|
|
|
|
*/
|
2017-01-21 18:38:52 +00:00
|
|
|
setup() {
|
|
|
|
this.rippleLink = new RippleLink(this.settings.WebsocketUri, this);
|
2017-02-04 21:26:48 +00:00
|
|
|
this.rippleLink.on("connect", (function(event) {
|
|
|
|
// Send the handshake request
|
|
|
|
this.rippleLink.send({
|
2017-02-19 13:22:35 +00:00
|
|
|
Event: "HandshakeRequest",
|
2017-02-04 21:26:48 +00:00
|
|
|
InitialViewport: { // TODO: Add support for persisting this between sessions
|
|
|
|
X: 0,
|
|
|
|
Y: 0,
|
|
|
|
Width: window.innerWidth,
|
|
|
|
Height: window.innerHeight
|
|
|
|
},
|
|
|
|
InitialAbsCursorPosition: this.cursorPosition
|
|
|
|
});
|
|
|
|
}).bind(this));
|
|
|
|
|
2017-02-19 11:57:42 +00:00
|
|
|
// Keep the server up to date on our viewport and cursor position
|
2017-02-19 11:38:08 +00:00
|
|
|
this.viewportSyncer = new ViewportSyncer(this.rippleLink, this.cursorUpdateFrequency)
|
2017-02-07 21:29:17 +00:00
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
// RippleLink message bindings
|
|
|
|
|
2017-02-19 13:22:35 +00:00
|
|
|
// Handle the HandshakeResponse when it comes in
|
|
|
|
this.rippleLink.on("HandshakeResponse", this.handleHandshakeResponse.bind(this));
|
2017-02-19 11:57:42 +00:00
|
|
|
// Handle other clients' state updates
|
|
|
|
this.rippleLink.on("ClientStates", this.handlePeerUpdates.bind(this));
|
2017-04-24 19:12:14 +00:00
|
|
|
// Handle the plane change confirmations
|
|
|
|
this.rippleLink.on("PlaneChangeOk", this.handlePlaneChangeOk.bind(this));
|
2017-01-21 18:38:52 +00:00
|
|
|
}
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
/**
|
|
|
|
* Renders the next frame.
|
|
|
|
*/
|
2017-01-21 17:06:19 +00:00
|
|
|
nextFrame()
|
|
|
|
{
|
2017-01-22 13:05:59 +00:00
|
|
|
// The time at which the current frame started rendering.
|
|
|
|
let frameStart = +new Date();
|
|
|
|
|
|
|
|
if(frameStart - this.lastFrameStart >= (1 / this.maxFps) * 1000)
|
|
|
|
{
|
|
|
|
this.update();
|
|
|
|
this.render(this.canvas, this.context);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Update the time the last frame started rendering
|
|
|
|
this.lastFrameStart = frameStart;
|
|
|
|
// Update the time we took rendering the last frame
|
|
|
|
this.lastFrameTime = +new Date() - frameStart;
|
|
|
|
|
|
|
|
this.renderTimeIndicator.innerHTML = `${this.lastFrameTime}ms`;
|
|
|
|
|
|
|
|
// Limit the maximum fps
|
2017-01-21 17:06:19 +00:00
|
|
|
requestAnimationFrame(this.nextFrame.bind(this));
|
|
|
|
}
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
/**
|
|
|
|
* Updates everything ready for the next frame to be rendered.
|
|
|
|
*/
|
2017-01-21 17:06:19 +00:00
|
|
|
update()
|
|
|
|
{
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2017-02-04 21:26:48 +00:00
|
|
|
/**
|
|
|
|
* Renders the next frame.
|
|
|
|
*/
|
2017-01-21 17:06:19 +00:00
|
|
|
render(canvas, context)
|
|
|
|
{
|
|
|
|
context.clearRect(0, 0, canvas.width, canvas.height);
|
|
|
|
|
2017-04-24 19:12:14 +00:00
|
|
|
context.save();
|
|
|
|
|
|
|
|
// Draw the grid if it's enabled
|
|
|
|
if(this.displayGrid)
|
|
|
|
this.renderGrid(canvas, context);
|
|
|
|
|
2017-02-19 15:55:22 +00:00
|
|
|
this.renderOthers(canvas, context);
|
2017-04-16 15:18:45 +00:00
|
|
|
// Render the currently active line
|
|
|
|
if(typeof this.pencil !== "undefined")
|
|
|
|
this.pencil.render(canvas, context);
|
2017-04-24 19:12:14 +00:00
|
|
|
|
|
|
|
context.restore();
|
|
|
|
}
|
|
|
|
|
|
|
|
renderGrid(canvas, context)
|
|
|
|
{
|
|
|
|
context.save();
|
|
|
|
context.scale(this.viewport.zoomLevel, this.viewport.zoomLevel);
|
|
|
|
|
2017-04-24 20:42:31 +00:00
|
|
|
|
|
|
|
for(let ax = (this.viewport.x + (this.gridSize - (this.viewport.x % this.gridSize))) - this.gridSize; ax < (this.viewport.x + this.viewport.width); ax += this.gridSize)
|
2017-04-24 19:12:14 +00:00
|
|
|
{
|
2017-04-24 20:42:31 +00:00
|
|
|
context.beginPath();
|
2017-04-24 19:12:14 +00:00
|
|
|
context.moveTo(ax - this.viewport.x, 0);
|
2017-04-24 20:42:31 +00:00
|
|
|
context.lineTo(ax - this.viewport.x, this.viewport.height);
|
|
|
|
|
|
|
|
if(Math.round(ax) == 0) {
|
|
|
|
context.lineWidth = this.primaryGridLineWidth;
|
|
|
|
context.strokeStyle = this.primaryGridLineColour;
|
|
|
|
} else {
|
|
|
|
context.lineWidth = this.gridLineWidth;
|
|
|
|
context.strokeStyle = this.gridLineColour;
|
|
|
|
}
|
|
|
|
context.stroke();
|
2017-04-24 19:12:14 +00:00
|
|
|
}
|
2017-04-24 20:42:31 +00:00
|
|
|
for(let ay = (this.viewport.y + (this.gridSize - (this.viewport.y % this.gridSize))) - this.gridSize; ay < (this.viewport.y + this.viewport.height); ay += this.gridSize)
|
2017-04-24 19:12:14 +00:00
|
|
|
{
|
2017-04-24 20:42:31 +00:00
|
|
|
context.beginPath();
|
2017-04-24 19:12:14 +00:00
|
|
|
context.moveTo(0, ay - this.viewport.y);
|
2017-04-24 20:42:31 +00:00
|
|
|
context.lineTo(this.viewport.width, ay - this.viewport.y);
|
|
|
|
|
|
|
|
if(Math.round(ay) == 0) {
|
|
|
|
context.lineWidth = this.primaryGridLineWidth;
|
|
|
|
context.strokeStyle = this.primaryGridLineColour;
|
|
|
|
} else {
|
|
|
|
context.lineWidth = this.gridLineWidth;
|
|
|
|
context.strokeStyle = this.gridLineColour;
|
|
|
|
}
|
|
|
|
context.stroke();
|
2017-04-24 19:12:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
context.restore();
|
2017-02-19 15:55:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
renderOthers(canvas, context)
|
|
|
|
{
|
|
|
|
context.save();
|
|
|
|
|
2017-02-21 20:34:18 +00:00
|
|
|
for (let [otherClientId, otherClient] of this.otherClients)
|
2017-02-19 15:55:22 +00:00
|
|
|
{
|
|
|
|
// TODO: Filter rendering by working out if this client is actually inside our viewport or not here
|
|
|
|
context.save();
|
2017-02-21 20:34:18 +00:00
|
|
|
context.translate(otherClient.CursorPosition.x, otherClient.CursorPosition.y);
|
2017-02-19 15:55:22 +00:00
|
|
|
|
|
|
|
context.beginPath();
|
|
|
|
// Horizontal line
|
|
|
|
context.moveTo(-this.otherCursorRadius, 0);
|
|
|
|
context.lineTo(this.otherCursorRadius, 0);
|
|
|
|
// Vertical line
|
|
|
|
context.moveTo(0, -this.otherCursorRadius);
|
|
|
|
context.lineTo(0, this.otherCursorRadius);
|
|
|
|
|
2017-02-21 20:34:18 +00:00
|
|
|
context.strokeStyle = otherClient.Colour;
|
2017-02-19 15:55:22 +00:00
|
|
|
context.lineWidth = this.otherCursorWidth
|
|
|
|
context.stroke();
|
|
|
|
|
|
|
|
context.restore();
|
|
|
|
}
|
|
|
|
|
|
|
|
context.restore();
|
2017-01-21 17:06:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Updates the canvas size to match the current viewport size.
|
|
|
|
*/
|
|
|
|
matchWindowSize() {
|
|
|
|
this.canvas.width = window.innerWidth;
|
|
|
|
this.canvas.height = window.innerHeight;
|
|
|
|
|
|
|
|
this.render(this.canvas, this.context);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Makes the canvas size track the window size.
|
|
|
|
*/
|
|
|
|
trackWindowSize() {
|
|
|
|
this.matchWindowSize();
|
|
|
|
window.addEventListener("resize", this.matchWindowSize.bind(this));
|
|
|
|
}
|
2017-02-04 21:26:48 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Handles events generated by pan-zoom, the package that handles the
|
|
|
|
* dragging and zooming of the whiteboard.
|
|
|
|
*/
|
|
|
|
handleCanvasMovement(event) {
|
2017-04-15 12:13:07 +00:00
|
|
|
// Don't bother processing it if it's a mouse / touch interaction and
|
|
|
|
// the control key isn't pressed
|
2017-04-16 15:51:52 +00:00
|
|
|
if([ "mouse", "touch" ].includes(event.type) && !this.keyboard.DownKeys.includes(17))
|
2017-04-15 12:13:07 +00:00
|
|
|
return;
|
2017-04-14 19:22:01 +00:00
|
|
|
// Store the viewport information for later
|
|
|
|
this.viewportState = event;
|
2017-04-14 20:08:36 +00:00
|
|
|
|
2017-04-24 20:43:52 +00:00
|
|
|
this.viewport.x -= event.dx * 1/this.viewport.zoomLevel;
|
|
|
|
this.viewport.y -= event.dy * 1/this.viewport.zoomLevel;
|
2017-04-24 20:42:31 +00:00
|
|
|
this.viewport.zoomLevel += event.dz / 1000;
|
|
|
|
console.debug(`Viewport now at (${this.viewport.x}, ${this.viewport.y}) @ ${this.viewport.zoomLevel}x zoom`);
|
2017-02-04 21:26:48 +00:00
|
|
|
}
|
2017-02-19 11:57:42 +00:00
|
|
|
|
2017-04-15 15:20:30 +00:00
|
|
|
/**
|
|
|
|
* Handles the server's response to our handshake request
|
|
|
|
* @param {object} message The server's response to our handshake request.
|
|
|
|
*/
|
2017-02-19 13:22:35 +00:00
|
|
|
handleHandshakeResponse(message) {
|
|
|
|
console.log("Received handshake response");
|
|
|
|
|
|
|
|
// Store the information send by the server
|
|
|
|
this.Id = message.Id;
|
|
|
|
this.Colour = message.Colour;
|
|
|
|
|
2017-04-25 18:34:03 +00:00
|
|
|
this.sidebar.querySelector(".name").style.borderTopColor = this.Colour;
|
|
|
|
this.sidebar.querySelector(".connection-indicator").dataset.connected = "yes";
|
2017-04-15 15:20:30 +00:00
|
|
|
|
|
|
|
// The pencil that draws the lines
|
2017-04-16 15:10:27 +00:00
|
|
|
this.pencil = new Pencil(this.rippleLink, this, this.canvas);
|
2017-04-23 16:40:41 +00:00
|
|
|
|
|
|
|
// Land on a default plane
|
|
|
|
// future ask the user which plane they want to join
|
|
|
|
this.rippleLink.send({
|
|
|
|
"Event": "PlaneChange",
|
|
|
|
"NewPlaneName": "default-plane"
|
|
|
|
});
|
2017-02-19 13:22:35 +00:00
|
|
|
}
|
|
|
|
|
2017-04-24 19:12:14 +00:00
|
|
|
/**
|
|
|
|
* Store the details about the new plane we've landed on that the server
|
|
|
|
* sends us.
|
|
|
|
* @param {object} message The plane change confirmation message to handle.
|
|
|
|
*/
|
|
|
|
handlePlaneChangeOk(message) {
|
|
|
|
this.currentPlaneName = message.NewPlaneName;
|
|
|
|
this.gridSize = message.GridSize;
|
|
|
|
console.info(`Plane changed to ${this.currentPlaneName} with a grid size of ${this.gridSize} successfully.`);
|
|
|
|
}
|
|
|
|
|
2017-02-21 20:34:18 +00:00
|
|
|
/**
|
|
|
|
* Handles peer update messages recieved from the server via the RippleLink.
|
|
|
|
*/
|
2017-02-19 11:57:42 +00:00
|
|
|
handlePeerUpdates(message) {
|
|
|
|
// Update our knowledge about other clients
|
2017-02-19 12:07:42 +00:00
|
|
|
for (let otherClient of message.ClientStates) {
|
2017-02-19 11:57:42 +00:00
|
|
|
// If this client is new, emit an event about it
|
2017-02-21 20:34:18 +00:00
|
|
|
if(!this.otherClients.has(otherClient.Id)) {
|
2017-02-19 11:57:42 +00:00
|
|
|
this.emit("OtherClientConnect", otherClient);
|
2017-02-21 20:34:18 +00:00
|
|
|
|
|
|
|
// Convert the raw object into a class instance
|
|
|
|
let otherClientObj = new OtherClient();
|
|
|
|
otherClientObj.Id = otherClient.Id;
|
|
|
|
}
|
|
|
|
else { // If not, emit a normal update message about it
|
2017-02-19 11:57:42 +00:00
|
|
|
this.emit("OtherClientUpdate", otherClient);
|
2017-02-21 20:34:18 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Get the OtherClient instance to pull in the rest of the data
|
|
|
|
this.otherClients.get(otherClient.Id).update(otherClient);
|
2017-02-19 11:57:42 +00:00
|
|
|
}
|
|
|
|
}
|
2017-01-21 17:06:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
export default BoardWindow;
|