Merge branch 'master' into View-smoke-3D-cabs

Author: Csantucci

Source/Documentation/Manual/features-rollingstock.rst

@@ -444,4 +444,28 @@ MSTS wagon::
 At runtime, when in passenger view, the player may pass from one viewpoint to 
 the other by pressing Shift-5.
 
+Bell animation
+==============
+
+Open Rails supports bell animation. The bell animation matrix must be named 
+ORTSBELL within the engine's .s file. Its default frame rate is 8 frames per 
+second. The default frame rate may be modified through the optional parameter 
+ESD_ORTSBellAnimationFPS (n), to be inserted within the .sd file related to the 
+.s file. n defines the animation FPS.
+It is advisable that the related sound stream within the .sms file is synchronized 
+with the visible animation. To accomplish this the .wav file should contain two 
+bell strokes, which time interval is equal to the time interval of a bell swing 
+from an oscillation end point to the opposite end point. As the first bell stroke 
+should not start immediately, but when the bell is about at the maximum of the 
+swing, the first stroke within the .wav file should be at the time distance equivalent 
+to the oscillation from center point to an oscillation end point. The file should have 
+one cue point at its beginning and one after the time interval of a complete bell swing 
+forward and backward, and should have a final fadeoff for best result. 
+
+
+
+  
+
+
+
 

Source/Documentation/Manual/operation.rst

@@ -1671,9 +1671,10 @@ user settings, and as such are kind of an extension to the four available
 
 Function call::
 
-    state = HASHEAD(Index of SignalSubObj);
+    state = HASHEAD( n );
 
-Function returns 1 if head is set, else 0. 
+where n is the SignalSubObj-Number in question.
+Function returns 1 if head SignalSubObj is set, else 0.
 
 
 Signalling flag OR_NOSPEEDREDUCTION

Source/Orts.Formats.Msts/ShapeDescriptorFile.cs

@@ -64,6 +64,7 @@ public SDShape(STFReader stf)
                             ESD_Bounding_Box = null;
                     }),
                     new STFReader.TokenProcessor("esd_ortssoundfilename", ()=>{ ESD_SoundFileName = stf.ReadStringBlock(null); }),
+                    new STFReader.TokenProcessor("esd_ortsbellanimationfps", ()=>{ ESD_BellAnimationFPS = stf.ReadFloatBlock(STFReader.UNITS.Frequency, null); }),
                 });
                 // TODO - some objects have no bounding box - ie JP2BillboardTree1.sd
                 //if (ESD_Bounding_Box == null) throw new STFException(stf, "Missing ESD_Bound_Box statement");
@@ -75,6 +76,7 @@ public SDShape(STFReader stf)
             public bool ESD_Snapable;
             public bool ESD_SubObj;
             public string ESD_SoundFileName = "";
+            public float ESD_BellAnimationFPS = 8;
         }
 
         public class ESD_Bounding_Box

Source/Orts.Simulation/MultiPlayer/Message.cs

@@ -2093,8 +2093,9 @@ public override void HandleMsg()
             }
             else if (EventName == "BELL")
             {
-                if (t.LeadLocomotive != null)
+                if (t.LeadLocomotive != null && t.LeadLocomotive is MSTSLocomotive)
                 {
+                    (t.LeadLocomotive as MSTSLocomotive).Bell = (EventState == 0 ? false : true);
                     t.LeadLocomotive.SignalEvent(EventState == 0 ? Event.BellOff : Event.BellOn);
                     MPManager.BroadCast(this.ToString()); //if the server, will broadcast
                 }

Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs

@@ -1895,12 +1895,12 @@ protected virtual void UpdateHornAndBell(float elapsedClockSeconds)
             if (Bell && !PreviousBell)
             {
                 SignalEvent(Event.BellOn);
-                if (MPManager.IsMultiPlayer()) MPManager.Notify((new MSGEvent(MPManager.GetUserName(), "BELL", 1)).ToString());
+                if (Train.TrainType != Train.TRAINTYPE.REMOTE && MPManager.IsMultiPlayer()) MPManager.Notify((new MSGEvent(MPManager.GetUserName(), "BELL", 1)).ToString());
             }
             else if (!Bell && PreviousBell)
             {
                 SignalEvent(Event.BellOff);
-                if (MPManager.IsMultiPlayer()) MPManager.Notify((new MSGEvent(MPManager.GetUserName(), "BELL", 0)).ToString());
+                if (Train.TrainType != Train.TRAINTYPE.REMOTE && MPManager.IsMultiPlayer()) MPManager.Notify((new MSGEvent(MPManager.GetUserName(), "BELL", 0)).ToString());
             }
 
             PreviousHorn = Horn;

Source/RunActivity/Viewer3D/AnimatedPart.cs

@@ -156,14 +156,14 @@ public void UpdateLoop(float change)
         /// <summary>
         /// Updates an animated part that loops only when enabled (e.g. wipers).
         /// </summary>
-        public void UpdateLoop(bool running, ElapsedTime elapsedTime)
+        public void UpdateLoop(bool running, ElapsedTime elapsedTime, float frameRateMultiplier = 1.5f)
         {
             if (PoseableShape.SharedShape.Animations == null || PoseableShape.SharedShape.Animations.Count == 0 || FrameCount == 0)
                 return;
 
-            // The speed of cycling is set at 1.5 frames of animation per second at 30 FPS.
-            var frameRate = PoseableShape.SharedShape.Animations[0].FrameRate * 1.5f / 30f;
-            if (running || (AnimationKey > 0 && AnimationKey + elapsedTime.ClockSeconds < FrameCount))
+            // The speed of cycling is as default 1.5 frames of animation per second at 30 FPS.
+            var frameRate = PoseableShape.SharedShape.Animations[0].FrameRate * frameRateMultiplier / 30f;
+            if (running || (AnimationKey > 0 && AnimationKey + elapsedTime.ClockSeconds * frameRate < FrameCount))
                 SetFrameWrap(AnimationKey + elapsedTime.ClockSeconds * frameRate);
             else
                 SetFrame(0);

Source/RunActivity/Viewer3D/Materials.cs

@@ -72,11 +72,14 @@ public Texture2D Get(string path, Texture2D defaultTexture, bool required = fals
                             DDSLib.DDSFromFile(path, GraphicsDevice, true, out texture);
                         }
                         else
+                        // This solves the case where the global shapes have been overwritten and point to .dds textures
+                        // therefore avoiding that routes providing .ace textures show blank global shapes
                         {
                             var aceTexture = Path.ChangeExtension(path, ".ace");
                             if (File.Exists(aceTexture))
                             {
                                 texture = Orts.Formats.Msts.AceFile.Texture2DFromFile(GraphicsDevice, aceTexture);
+                                Trace.TraceWarning("Required texture {1} not existing; using existing texture {2}", path, aceTexture);
                             }
                             else texture = defaultTexture;
                         }

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -266,8 +266,9 @@ public override void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                 //return;
             }
 
-            // Wiper animation
+            // Wipers and bell animation
             Wipers.UpdateLoop(Locomotive.Wiper, elapsedTime);
+            Bell.UpdateLoop(Locomotive.Bell, elapsedTime, TrainCarShape.SharedShape.BellAnimationFPS);
 
             // Draw 2D CAB View - by GeorgeS
             if (Viewer.Camera.AttachedCar == this.MSTSWagon &&

Source/RunActivity/Viewer3D/RollingStock/MSTSWagonViewer.cs

@@ -60,6 +60,7 @@ public class MSTSWagonViewer : TrainCarViewer
         AnimatedPart RightDoor;
         AnimatedPart Mirrors;
         protected AnimatedPart Wipers;
+        protected AnimatedPart Bell;
         AnimatedPart UnloadingParts;
 
         public Dictionary<string, List<ParticleEmitterViewer>> ParticleDrawers = new Dictionary<string, List<ParticleEmitterViewer>>();
@@ -182,6 +183,7 @@ from data in effect.Value
             Mirrors = new AnimatedPart(TrainCarShape);
             Wipers = new AnimatedPart(TrainCarShape);
             UnloadingParts = new AnimatedPart(TrainCarShape);
+            Bell = new AnimatedPart(TrainCarShape);
 
             if (car.FreightAnimations != null)
                 FreightAnimations = new FreightAnimationsViewer(viewer, car, wagonFolderSlash);
@@ -407,6 +409,10 @@ void MatchMatrixToPart(MSTSWagon car, int matrix, int bogieMatrix)
                     else Pantograph2.AddMatrix(matrix);
                 }
             }
+            else if (matrixName.StartsWith("ORTSBELL")) // wipers
+            {
+                Bell.AddMatrix(matrix);
+            }
             else
             {
                 if (matrixAnimated && matrix != 0)

Source/RunActivity/Viewer3D/Shapes.cs

@@ -1386,6 +1386,7 @@ public class SharedShape
         public int RootSubObjectIndex = 0;
         //public bool negativeBogie = false;
         public string SoundFileName = "";
+        public float BellAnimationFPS = 8;
 
 
         readonly Viewer Viewer;
@@ -1449,6 +1450,7 @@ void LoadContent()
                 if ((textureFlags & Helpers.TextureFlags.Night) != 0 && FilePath.Contains("\\trainset\\"))
                     textureFlags |= Helpers.TextureFlags.Underground;
                 SoundFileName = sdFile.shape.ESD_SoundFileName;
+                BellAnimationFPS = sdFile.shape.ESD_BellAnimationFPS;
             }
 
             var matrixCount = sFile.shape.matrices.Count;