Merge pull request #612 from Csantucci/DP-display-3Dcab

https://blueprints.launchpad.net/or/+spec/distributed-power-display-for-3d-cabs

Author: cjakeman

Source/Documentation/Manual/cabs.rst

@@ -478,9 +478,11 @@ Load field. Default is AMPS in a metric environment and KILO_LBS in
 the other cases. Selectable LoadUnits are AMPS, NEWTONS, KILO_NEWTONS, 
 LBS and KILO_KBS.
 
-The screen display can be rotated adding parameter 
+The screen display can be rotated in 2D cabs adding parameter 
 ORTSAngle ( number ) in the ScreenDisplay block. The angle is in degrees.
 
+Info specific for 3D cabs can be found :ref:`here <cabs-distributed-power-3d>` .
+
 For every keyboard command related to Distributed Power, a cabview control 
 is also available. Here's a list of the cabview controls::
 
@@ -1013,6 +1015,41 @@ Here below is an example of an entry for a 3D cab::
   Units ( LBS )
   ) 
 
+
+.. _cabs-distributed-power-3d:
+
+Distributed power display
+-------------------------
+
+Following info applies to the creation of a distributed power display in 2D cabs, in 
+addition to what is described :ref:`here <cabs-distributed-power>` for 2D cabs.
+
+In the 3Dcab .s file an ORTS_DISTRIBUTED_POWER object must be defined, with the same 
+syntax rules of the digitals, so e.g. ORTS_DISTRIBUTED_POWER:0:8:DPI , 
+where 8 is the selected character font size and DPI is the DPI.ace texture associated.
+
+In the folder where the 3D cab files are located (usually CABVIEW3D) such file DPI.ace 
+must be present. A sample file for that can be found in 
+``Documentation\SampleFiles\Manual\DPI.zip`` . Here is how such file looks like
+
+.. image:: images/cabs-dpi-ace.png 
+  :align: center
+  :scale: 80%
+
+Customizations for such file are possible following these rules:
+
+1. Horizontal/vertical ratio must be kept
+2. The first four lines must have the characters centered in their rectangle.
+3. From the 5th line on characters may be also spaced in a thicker way (as is for 
+   the ``Idle`` string in the above picture)
+4. From the 5th line on strings may be replaced bo strings in other national languages, 
+   provided that the new strings aren't wider than the original ones.
+5. It should be possible to have a transparent background if preferred.
+
+
+Except for the first column, fields 
+in the 3D distributed power display are always with center alignment.
+
 Alignment for digital controls
 ------------------------------
 

Source/Documentation/Manual/images/cabs-dpi-ace.png

@@ -1063,7 +1063,7 @@ public string GetDpuStatus(bool dataDpu, CABViewControlUnits loadUnits = CABView
 
             var status = new StringBuilder();
             // ID
-            status.AppendFormat("{0}({1})\t", CarID, DPUnitID);
+            status.AppendFormat("{0}({1})\t", CarID.Replace(" ", ""), DPUnitID);
             // Throttle
             status.AppendFormat("{0}\t", throttle);
 

Source/Documentation/SampleFiles/Manual/DPI.zip

@@ -2863,6 +2863,7 @@ public class ThreeDimentionCabViewer : TrainCarViewer
         Dictionary<int, AnimatedPart> OnDemandAnimateParts = null; //like external wipers, and other parts that will be switched on by mouse in the future
         //Dictionary<int, DigitalDisplay> DigitParts = null;
         Dictionary<int, ThreeDimCabDigit> DigitParts3D = null;
+        Dictionary<int, ThreeDimCabDPI> DPIDisplays3D = null;
         AnimatedPart ExternalWipers = null; // setting to zero to prevent a warning. Probably this will be used later. TODO
         protected MSTSLocomotive MSTSLocomotive { get { return (MSTSLocomotive)Car; } }
         MSTSLocomotiveViewer LocoViewer;
@@ -2883,9 +2884,9 @@ public ThreeDimentionCabViewer(Viewer viewer, MSTSLocomotive car, MSTSLocomotive
             else locoViewer.ThreeDimentionCabRenderer = locoViewer._CabRenderer;
 
             AnimateParts = new Dictionary<int, AnimatedPartMultiState>();
-            //DigitParts = new Dictionary<int, DigitalDisplay>();
             DigitParts3D = new Dictionary<int, ThreeDimCabDigit>();
             Gauges = new Dictionary<int, ThreeDimCabGaugeNative>();
+            DPIDisplays3D = new Dictionary<int, ThreeDimCabDPI>();
             OnDemandAnimateParts = new Dictionary<int, AnimatedPart>();
 
             // Find the animated parts
@@ -2977,6 +2978,10 @@ public ThreeDimentionCabViewer(Viewer viewer, MSTSLocomotive car, MSTSLocomotive
                             tmpPart.AddMatrix(iMatrix); //tmpPart.SetPosition(false);
                         }
                     }
+                    else if (style != null && style is DistributedPowerInterfaceRenderer)
+                    {
+                        DPIDisplays3D.Add(key, new ThreeDimCabDPI(viewer, iMatrix, parameter1, parameter2, this.TrainCarShape, locoViewer.ThreeDimentionCabRenderer.ControlMap[key]));
+                    }
                     else
                     {
                         //if there is a part already, will insert this into it, otherwise, create a new
@@ -3100,6 +3105,23 @@ public override void PrepareFrame(RenderFrame frame, ElapsedTime elapsedTime)
                 }
                 p.Value.PrepareFrame(frame, elapsedTime);
             }
+            foreach (var p in DPIDisplays3D)
+            {
+                var dpdisplay = p.Value.CVFR.Control;
+                if (dpdisplay.Screens != null && dpdisplay.Screens[0] != "all")
+                {
+                    foreach (var screen in dpdisplay.Screens)
+                    {
+                        if (LocoViewer.ThreeDimentionCabRenderer.ActiveScreen[dpdisplay.Display] == screen)
+                        {
+                            p.Value.PrepareFrame(frame, elapsedTime);
+                            break;
+                        }
+                    }
+                    continue;
+                }
+                p.Value.PrepareFrame(frame, elapsedTime);
+            }
             foreach (var p in Gauges)
             {
                 var gauge = p.Value.CVFR.Control;
@@ -3136,6 +3158,10 @@ internal override void Mark()
             {
                 threeDimCabDigit.Mark();
             }
+            foreach (ThreeDimCabDPI threeDimCabDPI in DPIDisplays3D.Values)
+            {
+                threeDimCabDPI.Mark();
+            }
         }
     }