[OpenLayers-Commits] r12418 - in sandbox/mpriour/temporal_map/openlayers/lib/OpenLayers: . TimeAgent

[commits-20090109 at openlayers.org]

Author: mpriour
Date: 2011-09-27 07:52:43 -0700 (Tue, 27 Sep 2011)
New Revision: 12418

Added:
   sandbox/mpriour/temporal_map/openlayers/lib/OpenLayers/TimeAgent/
   sandbox/mpriour/temporal_map/openlayers/lib/OpenLayers/TimeAgent/WMS.js
Log:
Rename TimeHandlers to TimeAgents

Added: sandbox/mpriour/temporal_map/openlayers/lib/OpenLayers/TimeAgent/WMS.js
===================================================================
--- sandbox/mpriour/temporal_map/openlayers/lib/OpenLayers/TimeAgent/WMS.js	                        (rev 0)
+++ sandbox/mpriour/temporal_map/openlayers/lib/OpenLayers/TimeAgent/WMS.js	2011-09-27 14:52:43 UTC (rev 12418)
@@ -0,0 +1,151 @@
+/* Copyright (c) 2006-2011 by OpenLayers Contributors (see authors.txt for 
+ * full list of contributors). Published under the Clear BSD license.  
+ * See http://svn.openlayers.org/trunk/openlayers/license.txt for the
+ * full text of the license. */
+
+
+/**
+ * @requires OpenLayers/TimeAgent.js
+ */
+
+/**
+ * Class: OpenLayers.TimeAgent.WMS
+ * Class to display and animate WMS layers across time.
+ * This class is created by {OpenLayers.Control.TimeManager} instances
+ *
+ * Inherits From:
+ *  - <OpenLayers.TimeAgent>
+ */
+OpenLayers.TimeAgent.WMS = OpenLayers.Class(OpenLayers.TimeAgent,{
+    /**
+	 * APIProperty: intervalMode
+	 * {String} If a wms layer has distinct valid time intervals,
+	 *     then this property will control if and how the animation time is
+	 *     translated into a valid time instance for the layer
+	 *     Must be one of:
+	 *     "lastValid" - continue to display it using the last valid time within
+	 *         the overall control time range
+     *     "nearest" - (Default) use the nearest valid time within the overall
+     *         control time range.
+     *     "exact" - only display the layer when there's an exact match (to the 
+     *         grainularity of the step unit) in the control time and an interval
+	 */
+	intervalMode:'nearest',
+
+    /**
+     * APIProperty: rangeMode
+     * {String} This property will control if and how the animation time is
+     *     translated into a time range to display on each tick
+     *     Must be one of:
+     *      false - set to false to only use single value time parameters (Default)
+     *      "range" - use a value range for time
+     *      "cumulative" - use a range from the start time to the current time
+     */    
+    rangeMode:false,
+    
+    /**
+     * APIProperty: rangeInterval
+     * {Number} Number of units to add or subtract of the current time to build
+     *      a time range to display with each tick. 
+     *      ONLY used if intervalMode is 'range'
+     */
+    rangeInterval:null,
+	
+	/**
+     * Constructor: OpenLayers.Control.TimeManager.WMS
+     * Create a new time manager control for temporal WMS layers.
+     *
+     * Parameters:
+     * options - {Object} Optional object whose properties will be set on the
+     *     control.
+     */
+	initialize:function(options){
+		OpenLayers.TimeAgent.prototype.initialize.call(this,options);
+        //add layer loadend listeners
+        if (this.layers) {
+            for (var i = 0, len = this.layers.length; i < len; i++) {
+                this.layers[i].events.on({
+                    'loadend': this.onLayerLoadEnd,
+                    'loadstart': this.onLayerLoadStart,
+                    scope: this
+                })
+            }
+        }
+	},
+	
+    addLayer:function(layer){
+        OpenLayers.TimeAgent.prototype.addLayer.call(this,layer);
+        layer.events.on({
+            'loadend': this.onLayerLoadEnd,
+            'loadstart': this.onLayerLoadStart,
+            scope: this
+        })
+    },
+    removeLayer:function(layer){
+        OpenLayers.TimeAgent.prototype.removeLayer.call(this,layer);
+        layer.events.un({
+            'loadend': this.onLayerLoadEnd,
+            'loadstart': this.onLayerLoadStart,
+            scope: this
+        })
+    },
+    destroy:function(){
+        for (var i = 0, len = this.layers.length; i < len; i++) {
+            this.layers[i].events.un({
+                'loadend': this.onLayerLoadEnd,
+                'loadstart': this.onLayerLoadStart,
+                scope: this
+            })
+        }
+        OpenLayers.TimeAgent.prototype.destroy.call(this);
+    },
+    
+	onTick:function(evt){
+		this.currentTime = evt.currentTime || this.timeManager.currentTime;
+        console.log('CurrentTime:'+this.currentTime.toTimeString());
+		var inrange = this.currentTime <= this.range[1] && this.currentTime >= this.range[0];
+        if (inrange) {
+            this.loadQueue = OpenLayers.Array.filter(this.layers, function(lyr){return lyr.visibility}).length;
+            this.canTick = !this.loadQueue;
+            console.debug('canTick:FALSE\nQueueCount:' + this.loadQueue)
+        }
+        for (var i = 0, len = this.layers.length; i < len; i++) {
+            if (inrange) {
+                this.applyTime(this.layers[i], this.currentTime);
+            }
+            else {
+                this.layers[i].setVisibility(false);
+            }
+        }
+	},
+	
+	applyTime:function(layer,time){
+		var isotime,minTime;
+        if(this.rangeMode && layer.metadata.allowRange!==false){
+            if(this.rangeMode=='range'){
+                minTime = new Date(time.getTime())
+                minTime['setUTC'+this.timeManager.units](time['getUTC'+this.timeManager.units]()+this.rangeInterval);
+            }else{
+                minTime = this.range[0]
+            }
+            isotime=OpenLayers.Date.toISOString(minTime)+'/'+OpenLayers.Date.toISOString(time)
+        }
+        else if(layer.metadata.timeInterval.length>2 && this.intervalMode != "exact"){
+			//TODO implement special case handling
+		}else{
+			//format time in ISO:8601 format
+			isotime = OpenLayers.Date.toISOString(time);
+		}
+        layer.mergeNewParams({time:isotime});
+	},
+	
+    onLayerLoadEnd: function(){
+        this.loadQueue--;
+        console.debug('QueueCount:'+this.loadQueue)
+        if (this.loadQueue <= 0) {this.canTick = true; console.debug('canTick:TRUE')}
+    },
+    onLayerLoadStart: function(){
+        //this.loadQueue=(!this.loadQueue && this.loadQueue!==0)?0:this.loadQueue++
+    },
+	CLASS_NAME:'OpenLayers.TimeAgent.WMS'
+});
\ No newline at end of file