Animated wipers for 2D cabs, see http://www.elvastower.com/forums/index.php?/topic/34604-2d-cabs-wipers-animation/

Author: Csantucci

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -183,6 +183,7 @@ public enum CABViewControlTypes
         ORTS_OVERCHARGE,
         ORTS_BATTERY,
         ORTS_POWERKEY,
+        ORTS_2DEXTERNALWIPERS,
 
         // TCS Controls
         ORTS_TCS1,
@@ -313,7 +314,8 @@ public CabViewControls(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("combinedcontrol", ()=>{ Add(new CVCDiscrete(stf, basepath)); }),
                 new STFReader.TokenProcessor("firebox", ()=>{ Add(new CVCFirebox(stf, basepath)); }),
                 new STFReader.TokenProcessor("dialclock", ()=>{ ProcessDialClock(stf, basepath);  }),
-                new STFReader.TokenProcessor("digitalclock", ()=>{ Add(new CVCDigitalClock(stf, basepath)); })
+                new STFReader.TokenProcessor("digitalclock", ()=>{ Add(new CVCDigitalClock(stf, basepath)); }),
+                new STFReader.TokenProcessor("ortsanimateddisplay", ()=>{ Add(new CVCAnimatedDisplay(stf, basepath)); })
             });
 
             //TODO Uncomment when parsed all type
@@ -1163,6 +1165,54 @@ protected int ParseNumStyle(STFReader stf)
             return style;
         }
     }
+
+    public class CVCAnimatedDisplay : CVCWithFrames
+    {
+        public List<double> MSStyles = new List<double>();
+        public float CycleTimeS;
+
+        public CVCAnimatedDisplay(STFReader stf, string basepath)
+        {
+
+            stf.MustMatch("(");
+            stf.ParseBlock(new STFReader.TokenProcessor[] {
+                new STFReader.TokenProcessor("type", ()=>{ ParseType(stf); }),
+                new STFReader.TokenProcessor("position", ()=>{ ParsePosition(stf);  }),
+                new STFReader.TokenProcessor("scalerange", ()=>{ ParseScaleRange(stf); }),
+                new STFReader.TokenProcessor("graphic", ()=>{ ParseGraphic(stf, basepath); }),
+                new STFReader.TokenProcessor("units", ()=>{ ParseUnits(stf); }),
+                new STFReader.TokenProcessor("ortscycletime", ()=>{
+                    CycleTimeS = stf.ReadFloatBlock(STFReader.UNITS.Time, null); }),
+                new STFReader.TokenProcessor("states", ()=>{
+                    stf.MustMatch("(");
+                    FramesCount = stf.ReadInt(null);
+                    FramesX = stf.ReadInt(null);
+                    FramesY = stf.ReadInt(null);
+                    stf.ParseBlock(new STFReader.TokenProcessor[] {
+                        new STFReader.TokenProcessor("state", ()=>{
+                            stf.MustMatch("(");
+                            stf.ParseBlock( new STFReader.TokenProcessor[] {
+                                new STFReader.TokenProcessor("style", ()=>{ MSStyles.Add(ParseNumStyle(stf));
+                                }),
+                                new STFReader.TokenProcessor("switchval", ()=>{ Values.Add(stf.ReadFloatBlock(STFReader.UNITS.None, null))
+                                ; }),
+                        });}),
+                    });
+                    if (Values.Count > 0) MaxValue = Values.Last();
+                    for (int i = Values.Count; i < FramesCount; i++)
+                        Values.Add(-10000);
+                }),
+            });
+        }
+        protected int ParseNumStyle(STFReader stf)
+        {
+            stf.MustMatch("(");
+            var style = stf.ReadInt(0);
+            stf.SkipRestOfBlock();
+            return style;
+        }
+    }
+
     #endregion
 
     #region other controls

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -1141,6 +1141,16 @@ public CabRenderer(Viewer viewer, MSTSLocomotive car)
                             count[(int)cvc.ControlType]++;
                             continue;
                         }
+                        CVCAnimatedDisplay anim = cvc as CVCAnimatedDisplay;
+                        if (anim != null)
+                        {
+                            CabViewAnimationsRenderer animr = new CabViewAnimationsRenderer(viewer, car, anim, _Shader);
+                            animr.SortIndex = controlSortIndex;
+                            CabViewControlRenderersList[i].Add(animr);
+                            if (!ControlMap.ContainsKey(key)) ControlMap.Add(key, animr);
+                            count[(int)cvc.ControlType]++;
+                            continue;
+                        }
                         CVCMultiStateDisplay multi = cvc as CVCMultiStateDisplay;
                         if (multi != null)
                         {
@@ -1735,7 +1745,7 @@ public override void Draw(GraphicsDevice graphicsDevice)
     /// </summary>
     public class CabViewDiscreteRenderer : CabViewControlRenderer
     {
-        readonly CVCWithFrames ControlDiscrete;
+        protected readonly CVCWithFrames ControlDiscrete;
         readonly Rectangle SourceRectangle;
         Rectangle DestinationRectangle = new Rectangle();
         public readonly float CVCFlashTimeOn = 0.75f;
@@ -1823,7 +1833,7 @@ public override void Draw(GraphicsDevice graphicsDevice)
         /// Determines the index of the Texture to be drawn
         /// </summary>
         /// <returns>index of the Texture</returns>
-        public int GetDrawIndex()
+        public virtual int GetDrawIndex()
         {
             var data = Locomotive.GetDataOf(Control);
 
@@ -2226,7 +2236,7 @@ public void HandleUserInput()
         /// </summary>
         /// <param name="percent">Percent to be translated</param>
         /// <returns>The calculated display index by the Control's Values</returns>
-        int PercentToIndex(float percent)
+        protected int PercentToIndex(float percent)
         {
             var index = 0;
 
@@ -2259,6 +2269,68 @@ int PercentToIndex(float percent)
         }
     }
 
+    /// <summary>
+    /// Discrete renderer for animated controls, like external 2D wiper
+    /// </summary>
+    public class CabViewAnimationsRenderer : CabViewDiscreteRenderer
+    {
+        float CumulativeTime;
+        CVCAnimatedDisplay ControlAnimated;
+        float HalfCycleTimeS;
+        bool wiperOn = false;
+
+        public CabViewAnimationsRenderer(Viewer viewer, MSTSLocomotive locomotive, CVCWithFrames control, CabShader shader)
+            : base(viewer, locomotive, control, shader)
+        {
+            ControlAnimated = (CVCAnimatedDisplay)ControlDiscrete;
+            HalfCycleTimeS = ControlAnimated.CycleTimeS * 0.5f;
+            wiperOn = Locomotive.Wiper;
+        }
+
+        public override void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
+        {
+            if (Locomotive.Wiper) wiperOn = true;
+            if (wiperOn)
+            {
+                CumulativeTime += elapsedTime.ClockSeconds;
+                if (CumulativeTime > ControlAnimated.CycleTimeS && !Locomotive.Wiper)
+                    wiperOn = false;
+                while (CumulativeTime > ControlAnimated.CycleTimeS)
+                    CumulativeTime -= ControlAnimated.CycleTimeS;
+            }
+            base.PrepareFrame(frame, elapsedTime);
+        }
+
+
+        public override int GetDrawIndex()
+        {
+            var data = Locomotive.GetDataOf(Control);
+
+            var index = 0;
+            switch (ControlDiscrete.ControlType)
+            {
+                case CABViewControlTypes.ORTS_2DEXTERNALWIPERS:
+                    if (wiperOn)
+                    {
+                        if (CumulativeTime < HalfCycleTimeS)
+                            index = PercentToIndex(CumulativeTime / HalfCycleTimeS);
+                        else
+                            index = PercentToIndex((ControlAnimated.CycleTimeS - CumulativeTime) / HalfCycleTimeS);
+                    }
+                    break;
+            }
+            // If it is a control with NumPositions and NumValues, the index becomes the reference to the Positions entry, which in turn is the frame index within the .ace file
+            if (ControlDiscrete is CVCDiscrete && !(ControlDiscrete is CVCSignal) && (ControlDiscrete as CVCDiscrete).Positions.Count > index &&
+                (ControlDiscrete as CVCDiscrete).Positions.Count == ControlDiscrete.Values.Count && index >= 0)
+                index = (ControlDiscrete as CVCDiscrete).Positions[index];
+
+            if (index >= ControlDiscrete.FramesCount) index = ControlDiscrete.FramesCount - 1;
+            if (index < 0) index = 0;
+            return index;
+        }
+    }
+
+
     /// <summary>
     /// Digital Cab Control renderer
     /// Uses fonts instead of graphic