Add scale function, use bounding div for main display element, such that the display...
[guacamole-common-js.git] / src / main / resources / guacamole.js
index 51ed16c..43bd165 100644 (file)
@@ -67,6 +67,31 @@ Guacamole.Client = function(tunnel) {
 
     var displayWidth = 0;
     var displayHeight = 0;
+    var displayScale = 1;
+
+    /**
+     * Translation from Guacamole protocol line caps to Layer line caps.
+     */
+    var lineCap = {
+        0: "butt",
+        1: "round",
+        2: "square"
+    };
+
+    /**
+     * Translation from Guacamole protocol line caps to Layer line caps.
+     */
+    var lineJoin = {
+        0: "bevel",
+        1: "miter",
+        2: "round"
+    };
+
+    // Create bounding div 
+    var bounds = document.createElement("div");
+    bounds.style.position = "relative";
+    bounds.style.width = (displayWidth*displayScale) + "px";
+    bounds.style.height = (displayHeight*displayScale) + "px";
 
     // Create display
     var display = document.createElement("div");
@@ -74,6 +99,14 @@ Guacamole.Client = function(tunnel) {
     display.style.width = displayWidth + "px";
     display.style.height = displayHeight + "px";
 
+    // Ensure transformations on display originate at 0,0
+    display.style.transformOrigin =
+    display.style.webkitTransformOrigin =
+    display.style.MozTransformOrigin =
+    display.style.OTransformOrigin =
+    display.style.msTransformOrigin =
+        "0 0";
+
     // Create default layer
     var default_layer_container = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
 
@@ -82,6 +115,7 @@ Guacamole.Client = function(tunnel) {
     default_layer_container_element.style.position = "absolute";
     default_layer_container_element.style.left = "0px";
     default_layer_container_element.style.top  = "0px";
+    default_layer_container_element.style.overflow = "hidden";
 
     // Create cursor layer
     var cursor = new Guacamole.Client.LayerContainer(0, 0);
@@ -97,6 +131,9 @@ Guacamole.Client = function(tunnel) {
     display.appendChild(default_layer_container.getElement());
     display.appendChild(cursor.getElement());
 
+    // Add display to bounds
+    bounds.appendChild(display);
+
     // Initially, only default layer exists
     var layers =  [default_layer_container];
 
@@ -129,11 +166,8 @@ Guacamole.Client = function(tunnel) {
 
     function moveCursor(x, y) {
 
-        var element = cursor.getElement();
-
-        // Update rect
-        element.style.left = (x - cursorHotspotX) + "px";
-        element.style.top  = (y - cursorHotspotY) + "px";
+        // Move cursor layer
+        cursor.translate(x - cursorHotspotX, y - cursorHotspotY);
 
         // Update stored position
         cursorX = x;
@@ -142,7 +176,7 @@ Guacamole.Client = function(tunnel) {
     }
 
     guac_client.getDisplay = function() {
-        return display;
+        return bounds;
     };
 
     guac_client.sendKeyEvent = function(pressed, keysym) {
@@ -223,6 +257,7 @@ Guacamole.Client = function(tunnel) {
             layer_element.style.position = "absolute";
             layer_element.style.left = "0px";
             layer_element.style.top = "0px";
+            layer_element.style.overflow = "hidden";
 
             // Add to default layer container
             default_layer_container.getElement().appendChild(layer_element);
@@ -244,75 +279,156 @@ Guacamole.Client = function(tunnel) {
 
     }
 
+    /**
+     * Handlers for all defined layer properties.
+     */
+    var layerPropertyHandlers = {
+
+        "miter-limit": function(layer, value) {
+            layer.setMiterLimit(parseFloat(value));
+        }
+
+    };
+    
+    /**
+     * Handlers for all instruction opcodes receivable by a Guacamole protocol
+     * client.
+     */
     var instructionHandlers = {
 
-        "error": function(parameters) {
-            if (guac_client.onerror) guac_client.onerror(parameters[0]);
-            guac_client.disconnect();
+        "arc": function(parameters) {
+
+            var layer = getLayer(parseInt(parameters[0]));
+            var x = parseInt(parameters[1]);
+            var y = parseInt(parameters[2]);
+            var radius = parseInt(parameters[3]);
+            var startAngle = parseFloat(parameters[4]);
+            var endAngle = parseFloat(parameters[5]);
+            var negative = parseInt(parameters[6]);
+
+            layer.arc(x, y, radius, startAngle, endAngle, negative != 0);
+
         },
 
-        "name": function(parameters) {
-            if (guac_client.onname) guac_client.onname(parameters[0]);
+        "cfill": function(parameters) {
+
+            var channelMask = parseInt(parameters[0]);
+            var layer = getLayer(parseInt(parameters[1]));
+            var r = parseInt(parameters[2]);
+            var g = parseInt(parameters[3]);
+            var b = parseInt(parameters[4]);
+            var a = parseInt(parameters[5]);
+
+            layer.setChannelMask(channelMask);
+
+            layer.fillColor(r, g, b, a);
+
+        },
+
+        "clip": function(parameters) {
+
+            var layer = getLayer(parseInt(parameters[0]));
+
+            layer.clip();
+
         },
 
         "clipboard": function(parameters) {
             if (guac_client.onclipboard) guac_client.onclipboard(parameters[0]);
         },
 
-        "size": function(parameters) {
+        "close": function(parameters) {
 
-            var layer_index = parseInt(parameters[0]);
-            var width = parseInt(parameters[1]);
-            var height = parseInt(parameters[2]);
+            var layer = getLayer(parseInt(parameters[0]));
 
-            // Only valid for layers (buffers auto-resize)
-            if (layer_index >= 0) {
+            layer.close();
 
-                // Resize layer
-                var layer_container = getLayerContainer(layer_index);
-                layer_container.resize(width, height);
+        },
 
-                // If layer is default, resize display
-                if (layer_index == 0) {
+        "copy": function(parameters) {
 
-                    displayWidth = width;
-                    displayHeight = height;
+            var srcL = getLayer(parseInt(parameters[0]));
+            var srcX = parseInt(parameters[1]);
+            var srcY = parseInt(parameters[2]);
+            var srcWidth = parseInt(parameters[3]);
+            var srcHeight = parseInt(parameters[4]);
+            var channelMask = parseInt(parameters[5]);
+            var dstL = getLayer(parseInt(parameters[6]));
+            var dstX = parseInt(parameters[7]);
+            var dstY = parseInt(parameters[8]);
 
-                    // Update (set) display size
-                    display.style.width = displayWidth + "px";
-                    display.style.height = displayHeight + "px";
+            dstL.setChannelMask(channelMask);
 
-                }
+            dstL.copy(
+                srcL,
+                srcX,
+                srcY,
+                srcWidth, 
+                srcHeight, 
+                dstX,
+                dstY 
+            );
+
+        },
 
-            } // end if layer (not buffer)
+        "cstroke": function(parameters) {
+
+            var channelMask = parseInt(parameters[0]);
+            var layer = getLayer(parseInt(parameters[1]));
+            var cap = lineCap[parseInt(parameters[2])];
+            var join = lineJoin[parseInt(parameters[3])];
+            var thickness = parseInt(parameters[4]);
+            var r = parseInt(parameters[5]);
+            var g = parseInt(parameters[6]);
+            var b = parseInt(parameters[7]);
+            var a = parseInt(parameters[8]);
+
+            layer.setChannelMask(channelMask);
+
+            layer.strokeColor(cap, join, thickness, r, g, b, a);
 
         },
 
-        "move": function(parameters) {
-            
-            var layer_index = parseInt(parameters[0]);
-            var parent_index = parseInt(parameters[1]);
-            var x = parseInt(parameters[2]);
-            var y = parseInt(parameters[3]);
-            var z = parseInt(parameters[4]);
+        "cursor": function(parameters) {
 
-            // Only valid for non-default layers
-            if (layer_index > 0 && parent_index >= 0) {
+            cursorHotspotX = parseInt(parameters[0]);
+            cursorHotspotY = parseInt(parameters[1]);
+            var srcL = getLayer(parseInt(parameters[2]));
+            var srcX = parseInt(parameters[3]);
+            var srcY = parseInt(parameters[4]);
+            var srcWidth = parseInt(parameters[5]);
+            var srcHeight = parseInt(parameters[6]);
 
-                // Get container element
-                var layer_container = getLayerContainer(layer_index).getElement();
-                var parent = getLayerContainer(parent_index).getElement();
+            // Reset cursor size
+            cursor.resize(srcWidth, srcHeight);
 
-                // Set parent if necessary
-                if (!(layer_container.parentNode === parent))
-                    parent.appendChild(layer_container);
+            // Draw cursor to cursor layer
+            cursor.getLayer().copy(
+                srcL,
+                srcX,
+                srcY,
+                srcWidth, 
+                srcHeight, 
+                0,
+                0 
+            );
 
-                // Move layer
-                layer_container.style.left   = x + "px";
-                layer_container.style.top    = y + "px";
-                layer_container.style.zIndex = z;
+            // Update cursor position (hotspot may have changed)
+            moveCursor(cursorX, cursorY);
 
-            }
+        },
+
+        "curve": function(parameters) {
+
+            var layer = getLayer(parseInt(parameters[0]));
+            var cp1x = parseInt(parameters[1]);
+            var cp1y = parseInt(parameters[2]);
+            var cp2x = parseInt(parameters[3]);
+            var cp2y = parseInt(parameters[4]);
+            var x = parseInt(parameters[5]);
+            var y = parseInt(parameters[6]);
+
+            layer.curveTo(cp1x, cp1y, cp2x, cp2y, x, y);
 
         },
 
@@ -342,6 +458,108 @@ Guacamole.Client = function(tunnel) {
 
         },
 
+        "distort": function(parameters) {
+
+            var layer_index = parseInt(parameters[0]);
+            var a = parseFloat(parameters[1]);
+            var b = parseFloat(parameters[2]);
+            var c = parseFloat(parameters[3]);
+            var d = parseFloat(parameters[4]);
+            var e = parseFloat(parameters[5]);
+            var f = parseFloat(parameters[6]);
+
+            // Only valid for visible layers (not buffers)
+            if (layer_index >= 0) {
+
+                // Get container element
+                var layer_container = getLayerContainer(layer_index).getElement();
+
+                // Set layer transform 
+                layer_container.transform(a, b, c, d, e, f);
+
+             }
+
+        },
+        "error": function(parameters) {
+            if (guac_client.onerror) guac_client.onerror(parameters[0]);
+            guac_client.disconnect();
+        },
+
+        "identity": function(parameters) {
+
+            var layer = getLayer(parseInt(parameters[0]));
+
+            layer.setTransform(1, 0, 0, 1, 0, 0);
+
+        },
+
+        "lfill": function(parameters) {
+
+            var channelMask = parseInt(parameters[0]);
+            var layer = getLayer(parseInt(parameters[1]));
+            var srcLayer = getLayer(parseInt(parameters[2]));
+
+            layer.setChannelMask(channelMask);
+
+            layer.fillLayer(srcLayer);
+
+        },
+
+        "line": function(parameters) {
+
+            var layer = getLayer(parseInt(parameters[0]));
+            var x = parseInt(parameters[1]);
+            var y = parseInt(parameters[2]);
+
+            layer.lineTo(x, y);
+
+        },
+
+        "lstroke": function(parameters) {
+
+            var channelMask = parseInt(parameters[0]);
+            var layer = getLayer(parseInt(parameters[1]));
+            var srcLayer = getLayer(parseInt(parameters[2]));
+
+            layer.setChannelMask(channelMask);
+
+            layer.strokeLayer(srcLayer);
+
+        },
+
+        "move": function(parameters) {
+            
+            var layer_index = parseInt(parameters[0]);
+            var parent_index = parseInt(parameters[1]);
+            var x = parseInt(parameters[2]);
+            var y = parseInt(parameters[3]);
+            var z = parseInt(parameters[4]);
+
+            // Only valid for non-default layers
+            if (layer_index > 0 && parent_index >= 0) {
+
+                // Get container element
+                var layer_container = getLayerContainer(layer_index);
+                var layer_container_element = layer_container.getElement();
+                var parent = getLayerContainer(parent_index).getElement();
+
+                // Set parent if necessary
+                if (!(layer_container_element.parentNode === parent))
+                    parent.appendChild(layer_container_element);
+
+                // Move layer
+                layer_container.translate(x, y);
+                layer_container_element.style.zIndex = z;
+
+            }
+
+        },
+
+        "name": function(parameters) {
+            if (guac_client.onname) guac_client.onname(parameters[0]);
+        },
+
         "png": function(parameters) {
 
             var channelMask = parseInt(parameters[0]);
@@ -364,57 +582,22 @@ Guacamole.Client = function(tunnel) {
 
         },
 
-        "copy": function(parameters) {
-
-            var srcL = getLayer(parseInt(parameters[0]));
-            var srcX = parseInt(parameters[1]);
-            var srcY = parseInt(parameters[2]);
-            var srcWidth = parseInt(parameters[3]);
-            var srcHeight = parseInt(parameters[4]);
-            var channelMask = parseInt(parameters[5]);
-            var dstL = getLayer(parseInt(parameters[6]));
-            var dstX = parseInt(parameters[7]);
-            var dstY = parseInt(parameters[8]);
+        "pop": function(parameters) {
 
-            dstL.setChannelMask(channelMask);
+            var layer = getLayer(parseInt(parameters[0]));
 
-            dstL.copy(
-                srcL,
-                srcX,
-                srcY,
-                srcWidth, 
-                srcHeight, 
-                dstX,
-                dstY 
-            );
+            layer.pop();
 
         },
 
-        "transfer": function(parameters) {
+        "push": function(parameters) {
 
-            var srcL = getLayer(parseInt(parameters[0]));
-            var srcX = parseInt(parameters[1]);
-            var srcY = parseInt(parameters[2]);
-            var srcWidth = parseInt(parameters[3]);
-            var srcHeight = parseInt(parameters[4]);
-            var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
-            var dstL = getLayer(parseInt(parameters[6]));
-            var dstX = parseInt(parameters[7]);
-            var dstY = parseInt(parameters[8]);
+            var layer = getLayer(parseInt(parameters[0]));
 
-            dstL.transfer(
-                srcL,
-                srcX,
-                srcY,
-                srcWidth, 
-                srcHeight, 
-                dstX,
-                dstY,
-                transferFunction
-            );
+            layer.push();
 
         },
-
         "rect": function(parameters) {
 
             var layer = getLayer(parseInt(parameters[0]));
@@ -426,56 +609,81 @@ Guacamole.Client = function(tunnel) {
             layer.rect(x, y, w, h);
 
         },
+        
+        "reset": function(parameters) {
 
-        "clip": function(parameters) {
+            var layer = getLayer(parseInt(parameters[0]));
+
+            layer.reset();
+
+        },
+        
+        "set": function(parameters) {
 
             var layer = getLayer(parseInt(parameters[0]));
+            var name = parameters[1];
+            var value = parameters[2];
 
-            layer.clip();
+            // Call property handler if defined
+            var handler = layerPropertyHandlers[name];
+            if (handler)
+                handler(layer, value);
 
         },
 
-        "cfill": function(parameters) {
+        "shade": function(parameters) {
+            
+            var layer_index = parseInt(parameters[0]);
+            var a = parseInt(parameters[1]);
 
-            var channelMask = parseInt(parameters[0]);
-            var layer = getLayer(parseInt(parameters[1]));
-            var r = getLayer(parseInt(parameters[2]));
-            var g = getLayer(parseInt(parameters[3]));
-            var b = getLayer(parseInt(parameters[4]));
-            var a = getLayer(parseInt(parameters[5]));
+            // Only valid for visible layers (not buffers)
+            if (layer_index >= 0) {
 
-            layer.setChannelMask(channelMask);
+                // Get container element
+                var layer_container = getLayerContainer(layer_index).getElement();
 
-            layer.fillColor(r, g, b, a);
+                // Set layer opacity
+                layer_container.style.opacity = a/255.0;
+
+            }
 
         },
 
-        "cursor": function(parameters) {
+        "size": function(parameters) {
 
-            cursorHotspotX = parseInt(parameters[0]);
-            cursorHotspotY = parseInt(parameters[1]);
-            var srcL = getLayer(parseInt(parameters[2]));
-            var srcX = parseInt(parameters[3]);
-            var srcY = parseInt(parameters[4]);
-            var srcWidth = parseInt(parameters[5]);
-            var srcHeight = parseInt(parameters[6]);
+            var layer_index = parseInt(parameters[0]);
+            var width = parseInt(parameters[1]);
+            var height = parseInt(parameters[2]);
 
-            // Reset cursor size
-            cursor.resize(srcWidth, srcHeight);
+            // Resize layer
+            var layer_container = getLayerContainer(layer_index);
+            layer_container.resize(width, height);
 
-            // Draw cursor to cursor layer
-            cursor.getLayer().copyRect(
-                srcL,
-                srcX,
-                srcY,
-                srcWidth, 
-                srcHeight, 
-                0,
-                0 
-            );
+            // If layer is default, resize display
+            if (layer_index == 0) {
 
-            // Update cursor position (hotspot may have changed)
-            moveCursor(cursorX, cursorY);
+                displayWidth = width;
+                displayHeight = height;
+
+                // Update (set) display size
+                display.style.width = displayWidth + "px";
+                display.style.height = displayHeight + "px";
+
+                // Update bounds size
+                bounds.style.width = (displayWidth*displayScale) + "px";
+                bounds.style.height = (displayHeight*displayScale) + "px";
+
+            }
+
+        },
+        
+        "start": function(parameters) {
+
+            var layer = getLayer(parseInt(parameters[0]));
+            var x = parseInt(parameters[1]);
+            var y = parseInt(parameters[2]);
+
+            layer.moveTo(x, y);
 
         },
 
@@ -521,6 +729,45 @@ Guacamole.Client = function(tunnel) {
                 }
             }
 
+        },
+
+        "transfer": function(parameters) {
+
+            var srcL = getLayer(parseInt(parameters[0]));
+            var srcX = parseInt(parameters[1]);
+            var srcY = parseInt(parameters[2]);
+            var srcWidth = parseInt(parameters[3]);
+            var srcHeight = parseInt(parameters[4]);
+            var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
+            var dstL = getLayer(parseInt(parameters[6]));
+            var dstX = parseInt(parameters[7]);
+            var dstY = parseInt(parameters[8]);
+
+            dstL.transfer(
+                srcL,
+                srcX,
+                srcY,
+                srcWidth, 
+                srcHeight, 
+                dstX,
+                dstY,
+                transferFunction
+            );
+
+        },
+
+        "transform": function(parameters) {
+
+            var layer = getLayer(parseInt(parameters[0]));
+            var a = parseFloat(parameters[1]);
+            var b = parseFloat(parameters[2]);
+            var c = parseFloat(parameters[3]);
+            var d = parseFloat(parameters[4]);
+            var e = parseFloat(parameters[5]);
+            var f = parseFloat(parameters[6]);
+
+            layer.transform(a, b, c, d, e, f);
+
         }
       
     };
@@ -576,6 +823,24 @@ Guacamole.Client = function(tunnel) {
         setState(STATE_WAITING);
     };
 
+    guac_client.scale = function(scale) {
+
+        display.style.transform =
+        display.style.WebkitTransform =
+        display.style.MozTransform =
+        display.style.OTransform =
+        display.style.msTransform =
+
+            "scale(" + scale + "," + scale + ")";
+
+        displayScale = scale;
+
+        // Update bounds size
+        bounds.style.width = (displayWidth*displayScale) + "px";
+        bounds.style.height = (displayHeight*displayScale) + "px";
+
+    };
+
 };
 
 
@@ -649,6 +914,75 @@ Guacamole.Client.LayerContainer = function(width, height) {
         return div;
     };
 
+    /**
+     * The translation component of this LayerContainer's transform.
+     */
+    var translate = "translate(0px, 0px)"; // (0, 0)
+
+    /**
+     * The arbitrary matrix component of this LayerContainer's transform.
+     */
+    var matrix = "matrix(1, 0, 0, 1, 0, 0)"; // Identity
+
+    /**
+     * Moves the upper-left corner of this LayerContainer to the given X and Y
+     * coordinate.
+     * 
+     * @param {Number} x The X coordinate to move to.
+     * @param {Number} y The Y coordinate to move to.
+     */
+    layer_container.translate = function(x, y) {
+
+        // Generate translation
+        translate = "translate("
+                        + x + "px,"
+                        + y + "px)";
+
+        // Set layer transform 
+        div.style.transform =
+        div.style.WebkitTransform =
+        div.style.MozTransform =
+        div.style.OTransform =
+        div.style.msTransform =
+
+            translate + " " + matrix;
+
+    };
+
+    /**
+     * Applies the given affine transform (defined with six values from the
+     * transform's matrix).
+     * 
+     * @param {Number} a The first value in the affine transform's matrix.
+     * @param {Number} b The second value in the affine transform's matrix.
+     * @param {Number} c The third value in the affine transform's matrix.
+     * @param {Number} d The fourth value in the affine transform's matrix.
+     * @param {Number} e The fifth value in the affine transform's matrix.
+     * @param {Number} f The sixth value in the affine transform's matrix.
+     */
+    layer_container.transform = function(a, b, c, d, e, f) {
+
+        // Generate matrix transformation
+        matrix =
+
+            /* a c e
+             * b d f
+             * 0 0 1
+             */
+    
+            "matrix(" + a + "," + b + "," + c + "," + d + "," + e + "," + f + ")";
+
+        // Set layer transform 
+        div.style.transform =
+        div.style.WebkitTransform =
+        div.style.MozTransform =
+        div.style.OTransform =
+        div.style.msTransform =
+
+            translate + " " + matrix;
+
+    };
+
 };
 
 /**