Api update (#1577)

API update for compatibility with NC/DCR/HUT * TrafficLights/JunctionRestrictions: updated API * LaneEndTransitionGroup : Added Bicycle and Pedestrian for future proofing. * Expose Road sign theme in API.
CitiesSkylinesMods · Jun 1, 2022 · 8feadbb · 8feadbb
1 parent f72ad76
commit 8feadbb
Show file tree

Hide file tree

Showing 13 changed files with 135 additions and 3 deletions.
diff --git a/TLM/TLM/Constants.cs b/TLM/TLM/Constants.cs
@@ -1,7 +1,9 @@
 namespace TrafficManager {
     using TrafficManager.API.Manager;
     using TrafficManager.API.Notifier;
+    using TrafficManager.API.UI;
     using TrafficManager.U;
+    using TrafficManager.UI.Textures;
 
     public static class Constants {
         /// <summary>
@@ -35,6 +37,9 @@ public static float ByteToFloat(byte b) {
 
         public static IManagerFactory ManagerFactory => Manager.Impl.ManagerFactory.Instance;
 
+        public static IUIFactory UIFactory => UI.UIFactory.Instance;
+
         public static INotifier Notifier => TrafficManager.Notifier.Instance;
+
     }
 }
diff --git a/TLM/TLM/Manager/Impl/TrafficLightManager.cs b/TLM/TLM/Manager/Impl/TrafficLightManager.cs
@@ -119,6 +119,8 @@ public void RemoveAllExistingTrafficLights() {
             }
         }
 
+        public bool ToggleTrafficLight(ushort nodeId) => ToggleTrafficLight(nodeId, ref nodeId.ToNode());
+
         public bool ToggleTrafficLight(ushort nodeId, ref NetNode node) {
             return SetTrafficLight(nodeId, !HasTrafficLight(nodeId, ref node), ref node);
         }
@@ -127,6 +129,16 @@ public bool ToggleTrafficLight(ushort nodeId, ref NetNode node, out ToggleTraffi
             return SetTrafficLight(nodeId, !HasTrafficLight(nodeId, ref node), ref node, out reason);
         }
 
+        bool ITrafficLightManager.CanToggleTrafficLight(ushort nodeId) {
+            ref NetNode netNode = ref nodeId.ToNode();
+            return netNode.IsValid() &&
+                CanToggleTrafficLight(
+                nodeId,
+                HasTrafficLight(nodeId, ref netNode),
+                ref netNode,
+                out _);
+        }
+
         public bool CanToggleTrafficLight(ushort nodeId,
                                           bool flag, // override?
                                           ref NetNode node,
@@ -242,6 +254,8 @@ public bool CanEnableTrafficLight(ushort nodeId,
             return ret;
         }
 
+        public bool HasTrafficLight(ushort nodeId) => HasTrafficLight(nodeId, ref nodeId.ToNode());
+
         public bool HasTrafficLight(ushort nodeId, ref NetNode node) {
             return node.IsValid()
                 && node.m_flags.IsFlagSet(NetNode.Flags.TrafficLights);

diff --git a/TLM/TLM/TLM.csproj b/TLM/TLM/TLM.csproj
@@ -182,6 +182,7 @@
     <Compile Include="UI\SubTools\RoutingDetector\Connection.cs" />
     <Compile Include="UI\SubTools\RoutingDetector\LaneEnd.cs" />
     <Compile Include="UI\SubTools\RoutingDetector\RoutingDetectorTool.cs" />
+    <Compile Include="UI\UIFactory.cs" />
     <Compile Include="UI\WhatsNew\MarkupKeyword.cs" />
     <Compile Include="UI\WhatsNew\WhatsNewMarkup.cs" />
     <Compile Include="Util\Extensions\CitizenUnitExtensions.cs" />

diff --git a/TLM/TLM/UI/Textures/RoadSignTheme.cs b/TLM/TLM/UI/Textures/RoadSignTheme.cs
@@ -1,10 +1,12 @@
-namespace TrafficManager.UI.Textures {
+namespace TrafficManager.UI.Textures {
     using System;
     using System.Collections.Generic;
     using CSUtil.Commons;
     using JetBrains.Annotations;
     using TrafficManager.API.Traffic.Data;
     using TrafficManager.API.Traffic.Enums;
+    using TrafficManager.API.UI;
+    using TrafficManager.Manager.Impl;
     using TrafficManager.State;
     using TrafficManager.UI.SubTools;
     using TrafficManager.Util;
@@ -15,7 +17,7 @@
     /// Defines one theme for road signs. All themes are accessible via, and stored in
     /// <see cref="RoadSignThemeManager"/>.
     /// </summary>
-    public class RoadSignTheme {
+    public class RoadSignTheme : ITheme {
         public enum OtherRestriction {
             Crossing,
             EnterBlockedJunction,
@@ -148,6 +150,39 @@ public Texture2D GetOtherRestriction(OtherRestriction type, bool allow) {
                        : this.ParentTheme.GetOtherRestriction(type, allow: false);
         }
 
+        public Texture2D JunctionRestriction(JunctionRestrictionFlags rule, bool allowed) {
+            bool rht = Shortcuts.RHT;
+            switch (rule) {
+                case JunctionRestrictionFlags.AllowPedestrianCrossing:
+                    return GetOtherRestriction(OtherRestriction.Crossing, allowed);
+                case JunctionRestrictionFlags.AllowUTurn:
+                    return GetOtherRestriction(OtherRestriction.UTurn, allowed);
+                case JunctionRestrictionFlags.AllowEnterWhenBlocked:
+                    return GetOtherRestriction(OtherRestriction.EnterBlockedJunction, allowed);
+                case JunctionRestrictionFlags.AllowForwardLaneChange:
+                    return GetOtherRestriction(OtherRestriction.LaneChange, allowed);
+                case JunctionRestrictionFlags.AllowFarTurnOnRed when rht:
+                case JunctionRestrictionFlags.AllowNearTurnOnRed when !rht:
+                    return GetOtherRestriction(OtherRestriction.LeftOnRed, allowed);
+                case JunctionRestrictionFlags.AllowNearTurnOnRed when rht:
+                case JunctionRestrictionFlags.AllowFarTurnOnRed when !rht:
+                    return GetOtherRestriction(OtherRestriction.RightOnRed, allowed);
+                default:
+                    Log.Error($"could not get texture for {rule}.");
+                    return null;
+            }
+        }
+
+        public Texture2D TrafficLightIcon(ushort nodeId) {
+            if (!TrafficLightManager.Instance.HasTrafficLight(nodeId)) {
+                return TrafficLightTextures.Instance.TrafficLightDisabled;
+            } else if (TrafficLightSimulationManager.Instance.HasSimulation(nodeId)) {
+                return TrafficLightTextures.Instance.TrafficLightEnabledTimed;
+            } else {
+                return TrafficLightTextures.Instance.TrafficLightEnabled;
+            }
+        }
+
         public RoadSignTheme Load(bool whiteTexture = false) {
             if (this.AttemptedToLoad) {
                 return this;

diff --git a/TLM/TLM/UI/UIFactory.cs b/TLM/TLM/UI/UIFactory.cs
@@ -0,0 +1,10 @@
+namespace TrafficManager.UI {
+    using TrafficManager.API.UI;
+    using TrafficManager.UI.Textures;
+
+    public class UIFactory : IUIFactory {
+        public static IUIFactory Instance = new UIFactory();
+
+        public ITheme ActiveTheme => RoadSignThemeManager.ActiveTheme;
+    }
+}
diff --git a/TLM/TMPE.API/Implementations.cs b/TLM/TMPE.API/Implementations.cs
@@ -3,14 +3,17 @@ namespace TrafficManager.API {
     using TrafficManager.API.Manager;
     using TrafficManager.API.Notifier;
     using System.Linq;
+    using TrafficManager.API.UI;
 
     public static class Implementations {
         private static Type constantsType_;
         private static IManagerFactory managerFactory_;
         private static INotifier notifier_;
+        private static IUIFactory uiFactory_;
 
         public static IManagerFactory ManagerFactory => managerFactory_ ??= GetImplementation<IManagerFactory>();
         public static INotifier Notifier => notifier_ ??= GetImplementation<INotifier>();
+        public static IUIFactory UIFactory => uiFactory_ ??= GetImplementation<IUIFactory>();
 
         private static T GetImplementation<T>()
             where T : class {

diff --git a/TLM/TMPE.API/Manager/ITrafficLightManager.cs b/TLM/TMPE.API/Manager/ITrafficLightManager.cs
@@ -2,5 +2,23 @@ namespace TrafficManager.API.Manager {
     using TrafficManager.API.Traffic.Enums;
 
     public interface ITrafficLightManager {
+        /// <summary>
+        /// returns if the node as any kind of traffic light (vanilla, manual, timed).
+        /// </summary>
+        public bool HasTrafficLight(ushort nodeId);
+
+        /// <summary>
+        /// Manual/timed traffic light cannot be toggled using <see cref="ITrafficLightManager"/>.
+        /// Use <see cref="ITrafficLightSimulationManager"/> to do that.
+        /// Also certain node types cannot have traffic light.
+        /// </summary>
+        bool CanToggleTrafficLight(ushort nodeId);
+
+        /// <summary>
+        /// if node has no traffic light, vanilla traffic light is set (if possible).
+        /// if node has vanilla traffic light, it is removed (if possible).
+        /// this method will fail if node has  Manual/timed traffic light.
+        /// </summary>
+        bool ToggleTrafficLight(ushort nodeId);
     }
 }
diff --git a/TLM/TMPE.API/Manager/ITrafficLightSimulationManager.cs b/TLM/TMPE.API/Manager/ITrafficLightSimulationManager.cs
@@ -2,5 +2,8 @@ namespace TrafficManager.API.Manager {
     using System.Collections.Generic;
 
     public interface ITrafficLightSimulationManager {
+        bool HasTimedSimulation(ushort nodeId);
+
+        bool HasActiveTimedSimulation(ushort nodeId);
     }
 }
diff --git a/TLM/TMPE.API/TMPE.API.csproj b/TLM/TMPE.API/TMPE.API.csproj
@@ -146,6 +146,7 @@
     <Compile Include="Traffic\Enums\ExtVehicleType.cs" />
     <Compile Include="Traffic\Enums\FlowWaitCalcMode.cs" />
     <Compile Include="Traffic\Enums\GeometryCalculationMode.cs" />
+    <Compile Include="Traffic\Enums\JunctionRestrictionFlags.cs" />
     <Compile Include="Traffic\Enums\LocaleKeyAttribute.cs" />
     <Compile Include="Traffic\Enums\LaneArrows.cs" />
     <Compile Include="Traffic\Enums\LaneEndTransitionGroup.cs" />
@@ -167,6 +168,8 @@
     <Compile Include="Traffic\Enums\VehicleRestrictionsMode.cs" />
     <Compile Include="Traffic\ISegmentEnd.cs" />
     <Compile Include="Traffic\ISegmentEndId.cs" />
+    <Compile Include="UI\IUIFactory.cs" />
+    <Compile Include="UI\ITheme.cs" />
     <Compile Include="Util\IObservable.cs" />
     <Compile Include="Util\IObserver.cs" />
   </ItemGroup>

diff --git a/TLM/TMPE.API/Traffic/Enums/JunctionRestrictionFlags.cs b/TLM/TMPE.API/Traffic/Enums/JunctionRestrictionFlags.cs
@@ -0,0 +1,10 @@
+namespace TrafficManager.API.Traffic.Enums {
+    public enum JunctionRestrictionFlags {
+        AllowUTurn = 1 << 0,
+        AllowNearTurnOnRed = 1 << 1,
+        AllowFarTurnOnRed = 1 << 2,
+        AllowForwardLaneChange = 1 << 3,
+        AllowEnterWhenBlocked = 1 << 4,
+        AllowPedestrianCrossing = 1 << 5,
+    }
+}
diff --git a/TLM/TMPE.API/Traffic/Enums/LaneEndTransitionGroup.cs b/TLM/TMPE.API/Traffic/Enums/LaneEndTransitionGroup.cs
@@ -6,6 +6,8 @@ public enum LaneEndTransitionGroup {
         None = 0,
         Road = 1,
         Track = 2,
-        All = Road | Track,
+        Vehicle = Road | Track,
+        Bicycle = 4,
+        Pedestrian = 8,
     }
 }
diff --git a/TLM/TMPE.API/UI/ITheme.cs b/TLM/TMPE.API/UI/ITheme.cs
@@ -0,0 +1,19 @@
+namespace TrafficManager.API.UI {
+    using TrafficManager.API.Traffic.Enums;
+    using UnityEngine;
+
+    /// <summary>
+    /// gets the texture for overlay sprite for each traffic rule according to the current theme.
+    /// </summary>
+    public interface ITheme {
+        Texture2D JunctionRestriction(JunctionRestrictionFlags rule, bool allowed);
+
+        Texture2D Parking(bool allowed);
+
+        Texture2D Priority(PriorityType p);
+
+        Texture2D VehicleRestriction(ExtVehicleType type, bool allow);
+
+        Texture2D TrafficLightIcon(ushort nodeId);
+    }
+}
diff --git a/TLM/TMPE.API/UI/IUIFactory.cs b/TLM/TMPE.API/UI/IUIFactory.cs
@@ -0,0 +1,9 @@
+namespace TrafficManager.API.UI {
+
+    /// <summary>
+    /// gets the texture for overlay sprite for each traffic rule according to the current theme.
+    /// </summary>
+    public interface IUIFactory {
+        ITheme ActiveTheme { get; }
+    }
+}