[Plugins] Bring over timeline, clock plugins

WTD-1239

platform/features/timeline/src/controllers/TimelineZoomController.js

@@ -0,0 +1,109 @@
+/*global define*/
+define(
+    ['../TimelineFormatter'],
+    function (TimelineFormatter) {
+        "use strict";
+
+
+        var FORMATTER = new TimelineFormatter();
+
+        /**
+         * Controls the pan-zoom state of a timeline view.
+         * @constructor
+         */
+        function TimelineZoomController($scope, ZOOM_CONFIGURATION) {
+            // Prefer to start with the middle index
+            var zoomLevels = ZOOM_CONFIGURATION.levels || [ 1000 ],
+                zoomIndex = Math.floor(zoomLevels.length / 2),
+                tickWidth = ZOOM_CONFIGURATION.width || 200,
+                duration = 86400000; // Default duration in view
+
+            // Round a duration to a larger value, to ensure space for editing
+            function roundDuration(value) {
+                // Ensure there's always an extra day or so
+                var sz = zoomLevels[zoomLevels.length - 1];
+                value *= 1.25; // Add 25% padding to start
+                return Math.ceil(value / sz) * sz;
+            }
+
+            // Get/set zoom level
+            function setZoomLevel(level) {
+                if (!isNaN(level)) {
+                    // Modify zoom level, keeping it in range
+                    zoomIndex = Math.min(
+                        Math.max(level, 0),
+                        zoomLevels.length - 1
+                    );
+                }
+            }
+
+            // Persist current zoom level
+            function storeZoom() {
+                var isEditMode = $scope.commit &&
+                    $scope.domainObject &&
+                    $scope.domainObject.hasCapability('editor');
+                if (isEditMode) {
+                    $scope.configuration = $scope.configuration || {};
+                    $scope.configuration.zoomLevel = zoomIndex;
+                    $scope.commit();
+                }
+            }
+
+            $scope.$watch("configuration.zoomLevel", setZoomLevel);
+
+            return {
+                /**
+                 * Increase or decrease the current zoom level by a given
+                 * number of steps. Positive steps zoom in, negative steps
+                 * zoom out.
+                 * If called with no arguments, this returns the current
+                 * zoom level, expressed as the number of milliseconds
+                 * associated with a given tick mark.
+                 * @param {number} steps how many steps to zoom in
+                 * @returns {number} current zoom level (as the size of a
+                 *          major tick mark, in pixels)
+                 */
+                zoom: function (amount) {
+                    // Update the zoom level if called with an argument
+                    if (arguments.length > 0 && !isNaN(amount)) {
+                        setZoomLevel(zoomIndex + amount);
+                        storeZoom(zoomIndex);
+                    }
+                    return zoomLevels[zoomIndex];
+                },
+                /**
+                 * Get the width, in pixels, of a specific time duration at
+                 * the current zoom level.
+                 * @returns {number} the number of pixels
+                 */
+                toPixels: function (millis) {
+                    return tickWidth * millis / zoomLevels[zoomIndex];
+                },
+                /**
+                 * Get the time duration, in milliseconds, occupied by the
+                 * width (specified in pixels) at the current zoom level.
+                 * @returns {number} the number of pixels
+                 */
+                toMillis: function (pixels) {
+                    return (pixels / tickWidth) * zoomLevels[zoomIndex];
+                },
+                /**
+                 * Get or set the current displayed duration. If used as a
+                 * setter, this will typically be rounded up to ensure extra
+                 * space is available at the right.
+                 * @returns {number} duration, in milliseconds
+                 */
+                duration: function (value) {
+                    var prior = duration;
+                    if (arguments.length > 0) {
+                        duration = roundDuration(value);
+                    }
+                    return duration;
+                }
+            };
+        }
+
+        return TimelineZoomController;
+
+    }
+);