CC: introduce parameter to allow CC mode switch also when throttle is not at 0

Author: Csantucci

Source/Documentation/Manual/cruisecontrol.rst

@@ -135,8 +135,7 @@ A list of the available .eng file CC parameters follows here below.
    "ControllerCruiseControlLogic", "Can have values 'None', 'SpeedOnly', 'Full'", "Enum", "Full"
    "HasProportionalSpeedSelector", "Speed selector is performed by a lever ranging from 0 to max speed", "Boolean", "FALSE"
    "SpeedSelectorIsDiscrete", "Speed selected can have only values multiple of NominalSpeedStep, even if selection is through mouse", "Boolean", "FALSE"
-   "DisableManualSwitchToManualWhenSetForceNotAtZero", "Manual Switch to Cruise Control Manual Mode can't occur when max force set is not at 0", "Boolean", "FALSE"
-   "DisableManualSwitchToAutoWhenThrottleNotAtZero", "Manual Switch to Cruise Control Auto Mode can't occur when max force set is not at 0", "Boolean", "FALSE"
+   "ModeSwitchAllowedWithThrottleNotAtZero", "Switch from manual to auto and vice-versa can occur also when throttle lever is not at 0", "Boolean", "FALSE"
    "DisableManualSwitchToAutoWhenSetSpeedNotAtTop", "Manual Switch to Cruise Control Auto Mode can't occur when speed is not set at maximum value and at the same moment train speed is not 0", "Boolean", "FALSE"
    "UseTrainBrakeAndDynBrake", "CC uses train brake and dyn brake together", "Boolean", "FALSE"
    "SpeedDeltaToEnableTrainBrake", "This is the minimum speed delta between actual speed and desired speed for the CC to use also the train brake", "Float(speed)", "5m/s"

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

@@ -3736,6 +3736,7 @@ public void SetThrottleValue(float value)
                 if (CruiseControl.UseThrottleAsForceSelector && CruiseControl.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto)
                 {
                     CruiseControl.SetMaxForcePercent((float)Math.Round(value * 100, 0));
+                    if (!CruiseControl.UseThrottleInCombinedControl) ThrottleController.SetValue(value);
                     return;
                 }
                 if (CruiseControl.UseThrottleAsSpeedSelector && CruiseControl.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto)
@@ -3767,6 +3768,7 @@ public void SetThrottlePercent(float percent)
                 if (CruiseControl.UseThrottleAsForceSelector && CruiseControl.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto)
                 {
                     CruiseControl.SetMaxForcePercent(percent);
+                    if (!CruiseControl.UseThrottleInCombinedControl) ThrottleController.SetPercent(percent);
                     return;
                 }
                 else
@@ -3839,6 +3841,30 @@ public void StartThrottleToZero(float? target)
             CommandStartTime = Simulator.ClockTime;
         }
 
+        /// <summary>
+        /// Returns the position of the throttle handle considering 
+        /// whether it is used for cruise control or not
+        /// </summary>
+        /// <param name="intermediateValue">Whather asking for intermediate (for mouse operation) or notched (for displaying) value.</param>
+        /// <returns>Combined position into 0-1 range</returns>
+        public float GetThrottleHandleValue(float data)
+        {
+            if (CruiseControl?.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto && CruiseControl.SelectedMaxAccelerationPercent != 0
+                && CruiseControl.HasIndependentThrottleDynamicBrakeLever)
+                return ThrottleController.CurrentValue;
+            if (CruiseControl?.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto && CruiseControl.UseThrottleAsForceSelector)
+                return CruiseControl.SelectedMaxAccelerationPercent / 100;
+            if (CruiseControl?.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto && CruiseControl.UseThrottleAsSpeedSelector)
+                return CruiseControl.SelectedSpeedMpS / MaxSpeedMpS;
+
+
+            if (CruiseControl == null || CruiseControl.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Manual)
+                return data;
+            else
+                return ThrottleController.CurrentValue;
+
+        }
+
         #endregion
 
         #region CombinedHandle

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/CruiseControl.cs

@@ -146,6 +146,7 @@ public enum SpeedSelectorMode { Parking, Neutral, On, Start }
         public bool DisableManualSwitchToAutoWhenThrottleNotAtZero = false;
         public bool DisableManualSwitchToAutoWhenSetSpeedNotAtTop = false;
         public bool EnableSelectedSpeedSelectionWhenManualModeSet = false;
+        public bool ModeSwitchAllowedWithThrottleNotAtZero = false;
         public bool UseTrainBrakeAndDynBrake = false;
         protected float SpeedDeltaToEnableTrainBrake = 5;
         protected float SpeedDeltaToEnableFullTrainBrake = 10;
@@ -267,6 +268,7 @@ public CruiseControl(CruiseControl other, MSTSLocomotive locomotive)
             TrainBrakeMaxPercentValue = other.TrainBrakeMaxPercentValue;
             StartInAutoMode = other.StartInAutoMode;
             ThrottleNeutralPosition = other.ThrottleNeutralPosition;
+            ModeSwitchAllowedWithThrottleNotAtZero = other.ModeSwitchAllowedWithThrottleNotAtZero;
 
         }
 
@@ -360,6 +362,7 @@ public void Parse(STFReader stf)
                     case "trainbrakemaxpercentvalue": TrainBrakeMaxPercentValue = stf.ReadFloatBlock(STFReader.UNITS.Any, 0.85f); break;
                     case "startinautomode": StartInAutoMode = stf.ReadBoolBlock(false); break;
                     case "throttleneutralposition": ThrottleNeutralPosition = stf.ReadBoolBlock(false); break;
+                    case "modeswitchallowedwiththrottlenotatzero": ModeSwitchAllowedWithThrottleNotAtZero = stf.ReadBoolBlock(false); break;
                     case "docomputenumberofaxles": DoComputeNumberOfAxles = stf.ReadBoolBlock(false); break;
                     case "options":
                         foreach (var speedRegulatorOption in stf.ReadStringBlock("").ToLower().Replace(" ", "").Split(','))
@@ -497,7 +500,7 @@ public void Update(float elapsedClockSeconds)
                 }
                 else if (DynamicBrakePriority) WasForceReset = false;
                 else if (SpeedSelMode == SpeedSelectorMode.Start) WasForceReset = true;
-                else if (SelectedMaxAccelerationPercent == 0)
+                else if (SelectedMaxAccelerationPercent == 0 || ModeSwitchAllowedWithThrottleNotAtZero && UseThrottleAsForceSelector)
                 {
                     WasBraking = false;
                     WasForceReset = true;
@@ -556,7 +559,6 @@ public void Update(float elapsedClockSeconds)
             if (SpeedRegMode == SpeedRegulatorMode.Manual)
                 SkipThrottleDisplay = false;
 
-            if (maxForceIncreasing) SpeedRegulatorMaxForceIncrease(elapsedClockSeconds);
             if (maxForceIncreasing) SpeedRegulatorMaxForceIncrease(elapsedClockSeconds);
             if (maxForceDecreasing)
             {
@@ -621,7 +623,7 @@ public void SpeedRegulatorModeIncrease()
             SpeedRegulatorMode previousMode = SpeedRegMode;
             if (SpeedRegMode == SpeedRegulatorMode.Testing) return;
             if (SpeedRegMode == SpeedRegulatorMode.Manual &&
-               ((DisableManualSwitchToAutoWhenThrottleNotAtZero && (Locomotive.ThrottlePercent != 0 ||
+               ((!ModeSwitchAllowedWithThrottleNotAtZero && (Locomotive.ThrottlePercent != 0 ||
                (Locomotive.DynamicBrakePercent != -1 && Locomotive.DynamicBrakePercent != 0))) ||
                (DisableManualSwitchToAutoWhenSetSpeedNotAtTop && SelectedSpeedMpS != Locomotive.MaxSpeedMpS && Locomotive.AbsSpeedMpS > Simulator.MaxStoppedMpS)))
                 return;
@@ -635,6 +637,7 @@ public void SpeedRegulatorModeIncrease()
                         {
                             if (SpeedRegulatorOptions.Contains("regulatorauto")) test = true;
                             if (!DisableManualSwitchToAutoWhenSetSpeedNotAtTop && !KeepSelectedSpeedWhenManualModeSet) SelectedSpeedMpS = Locomotive.AbsSpeedMpS;
+                            if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero) SelectedMaxAccelerationPercent = Locomotive.ThrottleController.CurrentValue * 100;
                             break;
                         }
                     case SpeedRegulatorMode.Testing: if (SpeedRegulatorOptions.Contains("regulatortest")) test = true; break;
@@ -652,7 +655,7 @@ public void SpeedRegulatorModeDecrease()
             Locomotive.SignalEvent(Common.Event.CruiseControlSpeedRegulator);
             if (SpeedRegMode == SpeedRegulatorMode.Manual) return;
             if (SpeedRegMode == SpeedRegulatorMode.Auto &&
-                (DisableManualSwitchToManualWhenSetForceNotAtZero && SelectedMaxAccelerationPercent != 0))
+                (!ModeSwitchAllowedWithThrottleNotAtZero && SelectedMaxAccelerationPercent != 0))
                 return;
             bool test = false;
             while (!test)
@@ -663,7 +666,8 @@ public void SpeedRegulatorModeDecrease()
                     case SpeedRegulatorMode.Auto: if (SpeedRegulatorOptions.Contains("regulatorauto")) test = true; break;
                     case SpeedRegulatorMode.Manual:
                         {
-                            Locomotive.ThrottleController.SetPercent(0);
+                            if (!ModeSwitchAllowedWithThrottleNotAtZero)
+                              Locomotive.ThrottleController.SetPercent(0);
                             if (SpeedRegulatorOptions.Contains("regulatormanual")) test = true;
                             if (ZeroSelectedSpeedWhenPassingToThrottleMode || UseThrottleAsSpeedSelector) SelectedSpeedMpS = 0;
                             if (UseThrottleAsForceSelector) SelectedMaxAccelerationPercent = 0;
@@ -779,13 +783,17 @@ protected void SpeedRegulatorMaxForceIncrease(float elapsedClockSeconds)
                     return;
                 speedRegulatorIntermediateValue += StepSize * elapsedClockSeconds;
                 selectedMaxAccelerationPercent = Math.Min((float)Math.Truncate(speedRegulatorIntermediateValue + 1), 100);
+                if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero && !UseThrottleInCombinedControl)
+                    Locomotive.ThrottleController.SetPercent(selectedMaxAccelerationPercent);
             }
             else
             {
                 if (selectedMaxAccelerationStep == SpeedRegulatorMaxForceSteps)
                     return;
                 speedRegulatorIntermediateValue += MaxForceSelectorIsDiscrete ? elapsedClockSeconds : StepSize * elapsedClockSeconds * SpeedRegulatorMaxForceSteps / 100.0f;
                 selectedMaxAccelerationStep = Math.Min((float)Math.Truncate(speedRegulatorIntermediateValue + 1), SpeedRegulatorMaxForceSteps);
+                if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero && !UseThrottleInCombinedControl)
+                    Locomotive.ThrottleController.SetPercent(selectedMaxAccelerationStep * 100 / SpeedRegulatorMaxForceSteps);
             }
             Simulator.Confirmer.ConfirmWithPerCent(CabControl.MaxAcceleration, SelectedMaxAccelerationPercent);
         }
@@ -811,6 +819,8 @@ protected void SpeedRegulatorMaxForceDecrease(float elapsedClockSeconds)
                     return;
                 speedRegulatorIntermediateValue -= StepSize * elapsedClockSeconds;
                 selectedMaxAccelerationPercent = Math.Max((int)speedRegulatorIntermediateValue, 100);
+                if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero && !UseThrottleInCombinedControl)
+                    Locomotive.ThrottleController.SetPercent(selectedMaxAccelerationPercent);
                 if (selectedMaxAccelerationPercent == 0)
                 {
                     Locomotive.SignalEvent(Common.Event.LeverToZero);
@@ -823,6 +833,8 @@ protected void SpeedRegulatorMaxForceDecrease(float elapsedClockSeconds)
                     return;
                 speedRegulatorIntermediateValue -= MaxForceSelectorIsDiscrete ? elapsedClockSeconds : StepSize * elapsedClockSeconds * SpeedRegulatorMaxForceSteps / 100.0f;
                 selectedMaxAccelerationStep = Math.Max((int)speedRegulatorIntermediateValue, DisableZeroForceStep ? 1 : 0);
+                if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero && !UseThrottleInCombinedControl)
+                    Locomotive.ThrottleController.SetPercent(selectedMaxAccelerationStep * 100 / SpeedRegulatorMaxForceSteps);
                 if (selectedMaxAccelerationStep <= (DisableZeroForceStep ? 1 : 0))
                 {
                     Locomotive.SignalEvent(Common.Event.LeverToZero);
@@ -855,6 +867,8 @@ public void SpeedRegulatorMaxForceChangeByMouse(float movExtension, float maxVal
                 {
                     selectedMaxAccelerationPercent += movExtension * maxValue;
                     selectedMaxAccelerationPercent = MathHelper.Clamp(selectedMaxAccelerationPercent, 0, 100);
+                    if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero && !UseThrottleInCombinedControl)
+                        Locomotive.ThrottleController.SetPercent(selectedMaxAccelerationPercent);
                     if (selectedMaxAccelerationPercent == 0)
                     {
                         Locomotive.SignalEvent(Common.Event.LeverToZero);
@@ -875,6 +889,8 @@ public void SpeedRegulatorMaxForceChangeByMouse(float movExtension, float maxVal
                 {
                     selectedMaxAccelerationStep += movExtension * maxValue;
                     selectedMaxAccelerationStep = MathHelper.Clamp(selectedMaxAccelerationStep, DisableZeroForceStep ? 1 : 0, SpeedRegulatorMaxForceSteps);
+                    if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero && !UseThrottleInCombinedControl)
+                        Locomotive.ThrottleController.SetPercent(selectedMaxAccelerationStep * 100 / SpeedRegulatorMaxForceSteps);
                     if (selectedMaxAccelerationStep == (DisableZeroForceStep ? 1 : 0))
                     {
                         Locomotive.SignalEvent(Common.Event.LeverToZero);
@@ -897,6 +913,7 @@ public void SpeedRegulatorSelectedSpeedStartIncrease()
                     Locomotive.ThrottleController.CurrentValue == 0 && Locomotive.DynamicBrakeController.CurrentValue == 0))
                 {
                     SpeedRegMode = SpeedRegulatorMode.Auto;
+                    if (UseThrottleAsForceSelector && ModeSwitchAllowedWithThrottleNotAtZero) SelectedMaxAccelerationPercent = Locomotive.ThrottleController.CurrentValue * 100;
                 }
 
                 mpc.DoMovement(MultiPositionController.Movement.Forward);

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -2071,6 +2071,9 @@ public virtual int GetDrawIndex()
                     index = PercentToIndex(data);
                     break;
                 case CABViewControlTypes.THROTTLE:
+
+                    index = PercentToIndex(Locomotive.GetThrottleHandleValue(data));
+                    break;
                 case CABViewControlTypes.THROTTLE_DISPLAY:
                     index = PercentToIndex(data);
                     break;