More consistent superelevation text, one word with no hyphenation, limit use of camel case to code only

Author: SteelFill

Source/Documentation/How to Provide Track Profiles for Open Rails Dynamic Track.docm

@@ -22,7 +22,7 @@ Rolling Stock
 - 3D cabs add realism.
 - OR graphics renders the results of the rolling stock developers at higher 
   resolution.
-- Rolling stock running on super-elevated track improves gaming experience.
+- Rolling stock running on superelevated track improves gaming experience.
 
 Routes
 ======

Source/Documentation/Manual/developing.rst

@@ -968,7 +968,7 @@ Where x and y are a series of paired parameters specifying the curve radius (def
 (x value), and the amount of superelevation (default meters) (y value). The statement will take
 as many paired values as desired, as long as the radius values are in increasing order.
 Each paired set of values must have an x and y value present. If it is desired
-to 'hold' a certain value of SuperElevation for a number of different radii curves, then the same 
+to 'hold' a certain value of superelevation for a number of different radii curves, then the same 
 y value needs to be used for succeeding values of curve radius. Where the y value changes between 
 curve radii, then Open Rails will interpolate the y value between the two points.
 

Source/Documentation/Manual/features-route.rst

@@ -766,16 +766,16 @@ Some experimental features being introduced in Open Rails may be turned on
 and off through the *Experimental* tab of the Options window, as
 described below.
 
-Super-elevation
+Superelevation
 ---------------
 
-If the value set for *Level* is greater than zero, ORTS supports super-elevation 
-for long curved tracks. The value *Minimum Length* determines
-the length of the shortest curve to have super-elevation. You need to
-choose the correct gauge for your route, otherwise some tracks may not be
-properly shown.
+If "Use Visual Superelevation" is enabled, ORTS applies superelevation graphics
+to curves on every route. For the best results, you need to enter
+the correct gauge for your route, otherwise the resulting superelevation
+may not be accurate. Note that the physics system will always consider the
+physical effects of superelevation regardless of this setting.
 
-When super-elevation is selected, two viewing effects occur at runtime:
+When visual superelevation is selected, two viewing effects occur at runtime:
 
 1. If an external camera view is selected, the tracks and the running
    train will be shown inclined towards the inside of the curve.
@@ -785,9 +785,12 @@ When super-elevation is selected, two viewing effects occur at runtime:
 .. image:: images/options-superelevation_1.png
 .. image:: images/options-superelevation_2.png
 
-OR implements super-elevated tracks using Dynamic Tracks. You can change
-the appearance of tracks by creating a ``<route folder>/TrackProfiles/
-TrProfile.stf`` file. The document ``How to Provide Track Profiles for
+The amount of superelevation applied can be customized
+:ref:`from within the route's .trk file <features-route-curve-superelevation>`.
+
+OR implements superelevated tracks using Dynamic Tracks. You can change
+the appearance of tracks by creating one (or more) ``<route folder>/TrackProfiles/
+TrProfile.stf`` files. The document ``How to Provide Track Profiles for
 Open Rails Dynamic Track.pdf`` describing the creation of track profiles
 can be found in the *Menu > Documents* drop-down or the 
 Open Rails ``/Source/Documentation/`` folder. Forum

Source/Documentation/Manual/images/options-experimental.png

@@ -3859,10 +3859,10 @@ hence were favoured for routes with tight curves.
 
 The value used for the rigid wheelbase is shown as W in figure
 
-Impact of Super Elevation
--------------------------
+Impact of Superelevation
+------------------------
 
-On any curve whose outer rail is super-elevated there is, for any car, one
+On any curve whose outer rail is superelevated there is, for any car, one
 speed of operation at which the car trucks have no more tendency to run
 toward either rail than they have on straight track, where both rail-heads
 are at the same level (known as the equilibrium speed). At lower speeds the
@@ -3893,7 +3893,7 @@ the track curvature. This excess being a variable element of curve
 resistance, we may expect to find that curve resistance reaches a minimum
 value when this excess reduces to zero, that is, when the car speed reaches
 the critical value referred to. This critical speed depends only on the
-super-elevation, the track gauge, and the radius of the track curvature.
+superelevation, the track gauge, and the radius of the track curvature.
 The resulting variation of curve resistance with speed is indicated in
 diagram below.
 
@@ -4262,8 +4262,8 @@ Typical Super Elevation Values & Speed Impact -- High Speed Passenger Routes
 
 +-------------------------------+-------------------+-----------------------+
 |                               |Cant D             |Cant deficiency        |
-|                               |(SuperElevation)   |(Unbalanced            |
-|                               |(mm)               |SuperElevation) I (mm) |
+|                               |(Superelevation)   |(Unbalanced            |
+|                               |(mm)               |Superelevation) I (mm) |
 +===============================+===================+=======================+
 |CEN (draft) -- Tilting trains  |180--200           |300                    |
 +-------------------------------+-------------------+-----------------------+
@@ -4329,15 +4329,15 @@ above classifications.
 
 Track gauge will default to the standard value of 4' 8.5" (1435mm).
 
-Unbalancedsuperelevation (Cant Deficiency) will be determined from the
+Unbalanced superelevation (Cant Deficiency) will be determined from the
 value entered by the user, or will default to the following values:
 
 - Conventional Freight -- 0" (0mm)
 - Conventional Passenger -- 3" (75mm)
 - Engines & tenders -- 6" (150mm)
 
 Tilting trains require the addition of the relevant
-unbalancedsuperelevation information to the relevant rolling stock files.
+unbalanced superelevation information to the relevant rolling stock files.
 
 .. _physics-tunnel-friction:
 

Source/Documentation/Manual/options.rst

@@ -638,7 +638,7 @@ public Direction Direction
         protected float TrackGaugeM = 1.435f;  // Track gauge - read in MSTSWagon
         protected Vector3 InitialCentreOfGravityM = new Vector3(0, 1.8f, 0); // get centre of gravity - read in MSTSWagon
         public Vector3 CentreOfGravityM = new Vector3(0, 1.8f, 0); // get centre of gravity after adjusted for freight animation
-        public float SuperelevationM; // Super elevation on the curve
+        public float SuperElevationM; // Super elevation on the curve
         protected float MaxUnbalancedSuperElevationM;  // Maximum comfortable cant deficiency, read from MSTS Wagon File
         public float SuperElevationAngleRad;
         protected bool IsMaxSafeCurveSpeed = false; // Has equal loading speed around the curve been exceeded, ie are all the wheesl still on the track?
@@ -1879,24 +1879,24 @@ public virtual void UpdateCurveSpeedLimit(float elapsedClockSeconds)
             {
 #if DEBUG_USER_SUPERELEVATION
                        Trace.TraceInformation(" ============================================= User SuperElevation (TrainCar.cs) ========================================");
-                        Trace.TraceInformation("CarID {0} TrackSuperElevation {1} Curve Radius {2}",  CarID, SuperelevationM, CurrentCurveRadius);
+                        Trace.TraceInformation("CarID {0} TrackSuperElevation {1} Curve Radius {2}",  CarID, SuperElevationM, CurrentCurveRadius);
 #endif
                 float s = AbsSpeedMpS; // speed of train
 
                 // Calulate equal wheel loading speed for current curve and superelevation - this was considered the "safe" speed to travel around a curve . In this instance the load on the both railes is evenly distributed.
                 // max equal load speed = SQRT ( (superelevation x gravity x curve radius) / track gauge)
-                // SuperElevation is made up of two components = rail superelevation + the amount of sideways force that a passenger will be comfortable with. This is expressed as a figure similar to superelevation.
+                // Superelevation is made up of two components = rail superelevation + the amount of sideways force that a passenger will be comfortable with. This is expressed as a figure similar to superelevation.
 
                 float SpeedToleranceMpS = Me.FromMi(pS.FrompH(2.5f));  // Set bandwidth tolerance for resetting notifications
 
                 // Railway companies often allow the vehicle to exceed the equal loading speed, provided that the passengers didn't feel uncomfortable, and that the car was not likely to excced the maximum critical speed
-                float MaxSafeCurveSpeedMps = (float)Math.Sqrt(((SuperelevationM + MaxUnbalancedSuperElevationM) * GravitationalAccelerationMpS2 * CurrentCurveRadiusM) / TrackGaugeM);
+                float MaxSafeCurveSpeedMps = (float)Math.Sqrt(((SuperElevationM + MaxUnbalancedSuperElevationM) * GravitationalAccelerationMpS2 * CurrentCurveRadiusM) / TrackGaugeM);
 
                 // Calculate critical speed - indicates the speed above which stock will overturn - sum of the moments of centrifrugal force and the vertical weight of the vehicle around the CoG
                 // critical speed = SQRT ( (centrifrugal force x gravity x curve radius) / Vehicle weight)
                 // centrifrugal force = Stock Weight x factor for movement of resultant force due to superelevation.
 
-                float SinTheta = SuperelevationM / TrackGaugeM; // Definition of sine: opposite / hypotenuse = superelevation / gauge
+                float SinTheta = SuperElevationM / TrackGaugeM; // Definition of sine: opposite / hypotenuse = superelevation / gauge
                 float CosTheta = (float)Math.Cos(SuperElevationAngleRad);
                 float HalfTrackGaugeM = TrackGaugeM / 2.0f;
 
@@ -2013,7 +2013,7 @@ public virtual void UpdateCurveSpeedLimit(float elapsedClockSeconds)
 
 #if DEBUG_CURVE_SPEED
                 Trace.TraceInformation("================================== TrainCar.cs - DEBUG_CURVE_SPEED ==============================================================");
-                Trace.TraceInformation("CarID {0} Curve Radius {1} Super {2} Unbalanced {3} Durability {4}", CarID, CurrentCurveRadius, SuperelevationM, UnbalancedSuperElevationM, Simulator.CurveDurability);
+                Trace.TraceInformation("CarID {0} Curve Radius {1} Super {2} Unbalanced {3} Durability {4}", CarID, CurrentCurveRadius, SuperElevationM, UnbalancedSuperElevationM, Simulator.CurveDurability);
                 Trace.TraceInformation("CoG {0}", CentreOfGravityM);
                 Trace.TraceInformation("Current Speed {0} Equal Load Speed {1} Max Safe Speed {2} Critical Max Speed {3} Critical Min Speed {4}", MpS.ToMpH(s), MpS.ToMpH(MaxCurveEqualLoadSpeedMps), MpS.ToMpH(MaxSafeCurveSpeedMps), MpS.ToMpH(CriticalMaxSpeedMpS), MpS.ToMpH(CriticalMinSpeedMpS));
                 Trace.TraceInformation("IsMaxSafeSpeed {0} IsCriticalSpeed {1}", IsMaxSafeCurveSpeed, IsCriticalSpeed);
@@ -2066,7 +2066,7 @@ public virtual void UpdateCurveForce(float elapsedClockSeconds)
 
                 var speedConstant = 1.5f;
                 var MToMM = 1000;
-                var rspeedKgpTonne = speedConstant * Math.Abs((SpeedMpS * SpeedMpS / CurrentCurveRadiusM) - ((MToMM * SuperelevationM / MToMM * TrackGaugeM) * GravitationalAccelerationMpS2));
+                var rspeedKgpTonne = speedConstant * Math.Abs((SpeedMpS * SpeedMpS / CurrentCurveRadiusM) - ((MToMM * SuperElevationM / MToMM * TrackGaugeM) * GravitationalAccelerationMpS2));
                 var rSpeedWagonN = GravitationalAccelerationMpS2 * (Kg.ToTonne(MassKG) * rspeedKgpTonne);
 
                 CurveForceN = rBaseWagonN + rSpeedWagonN;
@@ -2801,22 +2801,10 @@ public void ComputePosition(Traveller traveler, bool backToFront, float elapsedT
             for (int i = 1; i < Parts.Count; i++)
             {
                 TrainCarPart p = Parts[i];
-                
+                p.FindCenterLine();
+
                 if (p.SumWgt > 1.5f)
-                {
-                    p.FindCenterLine();
                     p0.AddPartLocation(1, p);
-                }
-                else if (p.SumWgt > 0.5f) // Handle edge case of single axle pony trucks
-                {
-                    double d = p.OffsetM.Z - p.SumZOffset / p.SumWgt;
-                    if (-.2 < d && d < .2)
-                        continue;
-                    // Add a fake "wheel" to serve as a pivot point
-                    Vector3 pos = new Vector3(p0.Pos[0] + p.OffsetM.Z * p0.Dir[0], p0.Pos[1] + p.OffsetM.Z * p0.Dir[1], p0.Pos[2] + p.OffsetM.Z * p0.Dir[2]);
-                    p.AddWheelSetLocation(1, p.OffsetM.Z, pos, p.Roll);
-                    p.FindCenterLine();
-                }
             }
             // Determine facing direction and position of train car
             p0.FindCenterLine();
@@ -2856,7 +2844,7 @@ public void ComputePosition(Traveller traveler, bool backToFront, float elapsedT
                 m = rollMat * m;
             }
 
-            SuperelevationInverseMatrix = Matrix.Invert(rollMat);
+            SuperElevationInverseMatrix = Matrix.Invert(rollMat);
 
             // Set position of train car
             m.Translation += new Vector3(p0.Pos[0], p0.Pos[1], -p0.Pos[2]);
@@ -2866,6 +2854,23 @@ public void ComputePosition(Traveller traveler, bool backToFront, float elapsedT
             WorldPosition.TileZ = tileZ;
 
             UpdateVibration(traveler, elapsedTimeS, distance, speed);
+
+            // Check bogies for any corrections needed
+            for (int i = 1; i < Parts.Count; i++)
+            {
+                TrainCarPart p = Parts[i];
+
+                if (p.SumWgt < 1.5f && p.SumWgt > 0.5f) // Handle edge case of single axle pony trucks
+                {
+                    double d = p.OffsetM.Z - p.SumZOffset / p.SumWgt;
+                    if (-.2 < d && d < .2)
+                        continue;
+                    // Add a fake "wheel" to serve as a pivot point
+                    Vector3 pos = new Vector3(p0.Pos[0] + p.OffsetM.Z * p0.Dir[0], p0.Pos[1] + p.OffsetM.Z * p0.Dir[1], p0.Pos[2] + p.OffsetM.Z * p0.Dir[2]);
+                    p.AddWheelSetLocation(1, p.OffsetM.Z, pos, p.Roll);
+                    p.FindCenterLine();
+                }
+            }
         }
 
         #region Traveller-based updates
@@ -2898,7 +2903,7 @@ internal void UpdateTilting(Traveller traveller,  float elapsedTimeS, float spee
         }
         #endregion
 
-        #region Super-elevation
+        #region SuperElevation
         /// <summary>
         /// Determines the curve situation (superelevation and radius) of the train car, given a
         /// traveller to move over an array of offsets to average out the curve across.
@@ -2915,9 +2920,9 @@ public void UpdateCurvePhys(Traveller traveller, float[] offsets)
             traveller.GetCurveData(offsets, out float[] physicsElevation, out float[] curveRadii);
 
             // Superelevation MUST be limited to track gauge to avoid NaN errors
-            SuperelevationM = Math.Min(physicsElevation.Average(), TrackGaugeM);
+            SuperElevationM = Math.Min(physicsElevation.Average(), TrackGaugeM);
             // Set superelevation angle used by physics system
-            SuperElevationAngleRad = (float)Math.Asin(SuperelevationM / TrackGaugeM);
+            SuperElevationAngleRad = (float)Math.Asin(SuperElevationM / TrackGaugeM);
 
             CurrentCurveRadiusM = curveRadii.Average();
             // Straight track has a "radius" of infinity, but rest of code expects straight to have a "radius" of 0
@@ -2928,7 +2933,7 @@ public void UpdateCurvePhys(Traveller traveller, float[] offsets)
 
         #region Vibration and tilting
         public Matrix VibrationInverseMatrix = Matrix.Identity;
-        public Matrix SuperelevationInverseMatrix = Matrix.Identity;
+        public Matrix SuperElevationInverseMatrix = Matrix.Identity;
 
         // https://en.wikipedia.org/wiki/Newton%27s_laws_of_motion#Newton.27s_2nd_Law
         //   Let F be the force in N

Source/Documentation/Manual/physics.rst

@@ -1285,7 +1285,7 @@ public override void Update(ElapsedTime elapsedTime)
                 LookedAtPosition = new WorldPosition(attachedCar.WorldPosition);
 
                 // Cancel out unwanted effects on camera motion caused by vibration and superelevation
-                LookedAtPosition.XNAMatrix = attachedCar.SuperelevationInverseMatrix * attachedCar.VibrationInverseMatrix * LookedAtPosition.XNAMatrix;
+                LookedAtPosition.XNAMatrix = attachedCar.SuperElevationInverseMatrix * attachedCar.VibrationInverseMatrix * LookedAtPosition.XNAMatrix;
             }
             UpdateLocation(LookedAtPosition);
             UpdateListener();

Source/Menu/Options.Designer.cs

@@ -546,7 +546,7 @@ public class TrProfile
         /// <summary>
         /// The type of superelevation used (ie: which rail is superelevated)
         /// </summary>
-        public enum SuperelevationMethod
+        public enum SuperElevationMethod
         {
             /// <summary>
             /// No superelevation - graphical superelevation disabled
@@ -568,7 +568,7 @@ public enum SuperelevationMethod
             /// </summary>
             Inside,
         }
-        public SuperelevationMethod ElevationType = SuperelevationMethod.Outside;
+        public SuperElevationMethod ElevationType = SuperElevationMethod.Outside;
 
         /// <summary>
         /// Enumeration of LOD control methods
@@ -629,7 +629,7 @@ public TrProfile(Viewer viewer)
             //PitchControl = PitchControls.ChordDisplacement; // Target chord displacement from arc
             //PitchControlScalar = 0.034f;                    // Hold to no more than 34 mm (half rail width)
             TrackGaugeM = 1.435f; // Kuju track profile depicts standard gauge track
-            ElevationType = SuperelevationMethod.Outside; // Superelevate the outside rail only to reduce clipping
+            ElevationType = SuperElevationMethod.Outside; // Superelevate the outside rail only to reduce clipping
 
             LOD lod;            // Local LOD instance
             LODItem lodItem;    // Local LODItem instance
@@ -923,24 +923,24 @@ public static LODMethods GetLODMethod(string sLODMethod)
         }
 
         /// <summary>
-        /// Gets a member of the SuperelevationMethod enumeration that corresponds to sElevMethod.
+        /// Gets a member of the SuperElevationMethod enumeration that corresponds to sElevMethod.
         /// </summary>
-        /// <param name="sElevMethod">String that identifies desired SuperelevationMethod.</param>
-        /// <returns>SuperelevationMethod</returns>
-        public static SuperelevationMethod GetElevMethod(string sElevMethod)
+        /// <param name="sElevMethod">String that identifies desired SuperElevationMethod.</param>
+        /// <returns>SuperElevationMethod</returns>
+        public static SuperElevationMethod GetElevMethod(string sElevMethod)
         {
             string s = sElevMethod.ToLower();
             switch (s)
             {
                 case "none":
-                    return SuperelevationMethod.None;
+                    return SuperElevationMethod.None;
                 case "both":
-                    return SuperelevationMethod.Both;
+                    return SuperElevationMethod.Both;
                 case "inside":
-                    return SuperelevationMethod.Inside;
+                    return SuperElevationMethod.Inside;
                 case "outside":
                 default:
-                    return SuperelevationMethod.Outside;
+                    return SuperElevationMethod.Outside;
             }
         }