Network resolution by total connection cost is working now.
Network resolution by total connection cost is working now.

* text=auto * text=auto
* eol=lf * eol=lf
   
# These files are text and should be normalized (convert crlf => lf) # These files are text and should be normalized (convert crlf => lf)
*.cs text diff=csharp *.cs text diff=csharp
*.cfg text *.cfg text
*.csproj text *.csproj text eol=crlf
*.sln text *.sln text eol=crlf
   
# Images should be treated as binary # Images should be treated as binary
# (binary is a macro for -text -diff) # (binary is a macro for -text -diff)
*.png binary *.png binary
   
// AntennaRange © 2014 toadicus // AntennaRange © 2014 toadicus
// //
// This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a // This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a
// copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ // copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/
   
using KSP; using KSP;
  using KSP.UI.Screens;
using System; using System;
using ToadicusTools; using ToadicusTools.Extensions;
  using ToadicusTools.Text;
  using ToadicusTools.GUIUtils;
  using ToadicusTools.Wrappers;
using UnityEngine; using UnityEngine;
   
namespace AntennaRange namespace AntennaRange
{ {
  /// <summary>
  /// A <see cref="UnityEngine.MonoBehaviour"/> responsible for managing configuration items for AntennaRange.
  /// </summary>
[KSPAddon(KSPAddon.Startup.SpaceCentre, false)] [KSPAddon(KSPAddon.Startup.SpaceCentre, false)]
public class ARConfiguration : MonoBehaviour public class ARConfiguration : MonoBehaviour
{ {
  private const string WINDOW_POS_KEY = "configWindowPos";
  private const string REQUIRE_LOS_KEY = "requireLineOfSight";
  private const string GRACE_RATIO_KEY = "graceRatio";
  private const string REQUIRE_PROBE_CONNECTION_KEY = "requireConnectionForControl";
  private const string FIXED_POWER_KEY = "fixedPowerCost";
  private const string PRETTY_LINES_KEY = "drawPrettyLines";
  private const string UPDATE_DELAY_KEY = "updateDelay";
  private const string USE_ADDITIVE_KEY = "useAdditiveRanges";
   
  private const string TRACKING_STATION_RANGES_KEY = "TRACKING_STATION_RANGES";
  private const string RANGE_KEY = "range";
   
  private const string USE_TOOLBAR_KEY = "useToolbarIfAvailable";
   
  /// <summary>
  /// Indicates whether connections require line of sight.
  /// </summary>
public static bool RequireLineOfSight public static bool RequireLineOfSight
{ {
get; get;
private set; private set;
} }
   
  /// <summary>
  /// A "fudge factor" ratio that pretends planets and moons are slightly smaller than reality to make
  /// building communication constellations easier.
  /// </summary>
public static double RadiusRatio public static double RadiusRatio
{ {
get; get;
private set; private set;
} }
   
  /// <summary>
  /// Indicates whether unmanned vessels require a connection for control.
  /// </summary>
public static bool RequireConnectionForControl public static bool RequireConnectionForControl
{ {
get; get;
private set; private set;
} }
   
  /// <summary>
  /// If true, relays will fix their power cost when above nominal range, decreasing data rate instead.
  /// </summary>
public static bool FixedPowerCost public static bool FixedPowerCost
{ {
get; get;
private set; private set;
} }
   
  /// <summary>
  /// Indicates whether this AntennaRange will draw pretty lines in map view.
  /// </summary>
public static bool PrettyLines public static bool PrettyLines
{ {
get; get;
private set; set;
} }
   
  /// <summary>
  /// Gets the update delay.
  /// </summary>
  public static long UpdateDelay
  {
  get;
  private set;
  }
   
  /// <summary>
  /// Gets a value indicating whether AntennaRange will use additive ranges.
  /// </summary>
  public static bool UseAdditiveRanges
  {
  get;
  private set;
  }
   
  /// <summary>
  /// Gets Kerbin's relay range based on the current tracking station level.
  /// </summary>
  public static double KerbinRelayRange
  {
  get;
  private set;
  }
   
  /// <summary>
  /// Gets Kerbin's nominal relay range based on the current tracking station level.
  /// </summary>
  public static double KerbinNominalRange
  {
  get
  {
  return KerbinRelayRange / 2.8284271247461901d;
  }
  }
   
  /// <summary>
  /// Gets a value indicating whether we should use Toolbar if available.
  /// </summary>
  /// <value><c>true</c> if we should use Toolbar if available; otherwise, <c>false</c>.</value>
  public static bool UseToolbarIfAvailable
  {
  get;
  private set;
  }
   
  #pragma warning disable 1591
   
private bool showConfigWindow; private bool showConfigWindow;
private Rect configWindowPos; private Rect configWindowPos;
   
  private string updateDelayStr;
  private long updateDelay;
   
private IButton toolbarButton; private IButton toolbarButton;
private ApplicationLauncherButton appLauncherButton; private ApplicationLauncherButton appLauncherButton;
   
  private double[] trackingStationRanges;
   
private System.Version runningVersion; private System.Version runningVersion;
   
  private bool runOnce;
   
private KSP.IO.PluginConfiguration _config; private KSP.IO.PluginConfiguration _config;
private KSP.IO.PluginConfiguration config private KSP.IO.PluginConfiguration config
{ {
get get
{ {
if (this._config == null) if (this._config == null)
{ {
this._config = KSP.IO.PluginConfiguration.CreateForType<AntennaRelay>(); this._config = KSP.IO.PluginConfiguration.CreateForType<AntennaRelay>();
} }
   
return this._config; return this._config;
} }
} }
   
public void Awake() public void Awake()
{ {
Tools.PostDebugMessage(this, "Waking up."); this.LogDebug("Waking up.");
   
this.runningVersion = this.GetType().Assembly.GetName().Version; this.runningVersion = this.GetType().Assembly.GetName().Version;
   
this.showConfigWindow = false; this.showConfigWindow = false;
this.configWindowPos = new Rect(Screen.width / 4, Screen.height / 2, 180, 15); this.configWindowPos = new Rect(Screen.width / 4, Screen.height / 2, 180, 15);
   
  this.configWindowPos = this.LoadConfigValue(WINDOW_POS_KEY, this.configWindowPos);
this.configWindowPos = this.LoadConfigValue("configWindowPos", this.configWindowPos);  
  ARConfiguration.RequireLineOfSight = this.LoadConfigValue(REQUIRE_LOS_KEY, false);
ARConfiguration.RequireLineOfSight = this.LoadConfigValue("requireLineOfSight", false);  
  ARConfiguration.RadiusRatio = (1 - this.LoadConfigValue(GRACE_RATIO_KEY, .05d));
ARConfiguration.RadiusRatio = (1 - this.LoadConfigValue("graceRatio", .05d));  
ARConfiguration.RadiusRatio *= ARConfiguration.RadiusRatio; ARConfiguration.RadiusRatio *= ARConfiguration.RadiusRatio;
   
ARConfiguration.RequireConnectionForControl = ARConfiguration.RequireConnectionForControl =
this.LoadConfigValue("requireConnectionForControl", false); this.LoadConfigValue(REQUIRE_PROBE_CONNECTION_KEY, false);
   
ARConfiguration.FixedPowerCost = this.LoadConfigValue("fixedPowerCost", false); ARConfiguration.FixedPowerCost = this.LoadConfigValue(FIXED_POWER_KEY, false);
   
ARConfiguration.PrettyLines = this.LoadConfigValue("drawPrettyLines", true); ARConfiguration.PrettyLines = this.LoadConfigValue(PRETTY_LINES_KEY, true);
   
  ARConfiguration.UpdateDelay = this.LoadConfigValue(UPDATE_DELAY_KEY, 16L);
   
  ARConfiguration.UseAdditiveRanges = this.LoadConfigValue(USE_ADDITIVE_KEY, true);
   
  ARConfiguration.PrettyLines = this.LoadConfigValue(PRETTY_LINES_KEY, true);
   
  ARConfiguration.UpdateDelay = this.LoadConfigValue(UPDATE_DELAY_KEY, 16L);
  this.updateDelayStr = ARConfiguration.UpdateDelay.ToString();
   
  ARConfiguration.UseToolbarIfAvailable = this.LoadConfigValue(USE_TOOLBAR_KEY, true);
   
GameEvents.onGameSceneLoadRequested.Add(this.onSceneChangeRequested); GameEvents.onGameSceneLoadRequested.Add(this.onSceneChangeRequested);
  GameEvents.OnKSCFacilityUpgraded.Add(this.onFacilityUpgraded);
   
Debug.Log(string.Format("{0} v{1} - ARConfiguration loaded!", this.GetType().Name, this.runningVersion)); Debug.Log(string.Format("{0} v{1} - ARConfiguration loaded!", this.GetType().Name, this.runningVersion));
   
Tools.PostDebugMessage(this, "Awake."); ConfigNode[] tsRangeNodes = GameDatabase.Instance.GetConfigNodes(TRACKING_STATION_RANGES_KEY);
   
  if (tsRangeNodes.Length > 0)
  {
  string[] rangeValues = tsRangeNodes[0].GetValues(RANGE_KEY);
   
  this.trackingStationRanges = new double[rangeValues.Length];
   
  for (int idx = 0; idx < rangeValues.Length; idx++)
  {
  if (!double.TryParse(rangeValues[idx], out this.trackingStationRanges[idx]))
  {
  this.LogError("Could not parse value '{0}' to double; Tracking Station ranges may not work!");
  this.trackingStationRanges[idx] = 0d;
  }
  }
   
  this.Log("Loaded Tracking Station ranges from config: [{0}]", this.trackingStationRanges.SPrint());
  }
  else
  {
  this.trackingStationRanges = new double[]
  {
  51696576d,
  37152180000d,
  224770770000d
  };
   
  this.LogWarning("Failed to load Tracking Station ranges from config, using hard-coded values: [{0}]",
  this.trackingStationRanges.SPrint());
  }
   
  this.runOnce = true;
   
  this.LogDebug("Awake.");
  }
   
  public void Update()
  {
  if (
  this.runOnce &&
  (ScenarioUpgradeableFacilities.Instance != null || HighLogic.CurrentGame.Mode != Game.Modes.CAREER)
  )
  {
  this.runOnce = false;
   
  this.SetKerbinRelayRange();
  }
} }
   
public void OnGUI() public void OnGUI()
{ {
// Only runs once, if the Toolbar is available. // Only runs once, if the Toolbar is available.
if (ToolbarManager.ToolbarAvailable) if (ToolbarManager.ToolbarAvailable && ARConfiguration.UseToolbarIfAvailable)
{ {
if (this.toolbarButton == null) if (this.toolbarButton == null)
{ {
Tools.PostDebugMessage(this, "Toolbar available; initializing toolbar button."); this.LogDebug("Toolbar available; initializing toolbar button.");
   
  if (this.appLauncherButton != null)
  {
  ApplicationLauncher.Instance.RemoveModApplication(this.appLauncherButton);
  this.appLauncherButton = null;
  }
   
this.toolbarButton = ToolbarManager.Instance.add("AntennaRange", "ARConfiguration"); this.toolbarButton = ToolbarManager.Instance.add("AntennaRange", "ARConfiguration");
this.toolbarButton.Visibility = new GameScenesVisibility(GameScenes.SPACECENTER); this.toolbarButton.Visibility = new GameScenesVisibility(GameScenes.SPACECENTER);
this.toolbarButton.Text = "AR"; this.toolbarButton.Text = "AR";
this.toolbarButton.TexturePath = "AntennaRange/Textures/toolbarIcon"; this.toolbarButton.TexturePath = "AntennaRange/Textures/toolbarIcon";
this.toolbarButton.TextColor = (Color)XKCDColors.Amethyst; this.toolbarButton.TextColor = (Color)XKCDColors.Amethyst;
this.toolbarButton.OnClick += delegate(ClickEvent e) this.toolbarButton.OnClick += delegate(ClickEvent e)
{ {
this.toggleConfigWindow(); this.toggleConfigWindow();
}; };
} }
} }
else if (this.appLauncherButton == null && ApplicationLauncher.Ready) else if (this.appLauncherButton == null && ApplicationLauncher.Ready)
{ {
Tools.PostDebugMessage(this, "Toolbar available; initializing AppLauncher button."); if (this.toolbarButton != null)
  {
  this.toolbarButton.Destroy();
  this.toolbarButton = null;
  }
   
  this.LogDebug("Toolbar available; initializing AppLauncher button.");
   
this.appLauncherButton = ApplicationLauncher.Instance.AddModApplication( this.appLauncherButton = ApplicationLauncher.Instance.AddModApplication(
this.toggleConfigWindow, this.toggleConfigWindow,
this.toggleConfigWindow, this.toggleConfigWindow,
ApplicationLauncher.AppScenes.SPACECENTER, ApplicationLauncher.AppScenes.SPACECENTER,
GameDatabase.Instance.GetTexture( GameDatabase.Instance.GetTexture(
"AntennaRange/Textures/appLauncherIcon", "AntennaRange/Textures/appLauncherIcon",
false false
) )
); );
} }
   
if (this.showConfigWindow) if (this.showConfigWindow)
{ {
Rect configPos = GUILayout.Window(354163056, Rect configPos = GUILayout.Window(354163056,
this.configWindowPos, this.configWindowPos,
this.ConfigWindow, this.ConfigWindow,
string.Format("AntennaRange {0}.{1}", this.runningVersion.Major, this.runningVersion.Minor), string.Format("AntennaRange {0}.{1}", this.runningVersion.Major, this.runningVersion.Minor),
GUILayout.ExpandHeight(true), GUILayout.ExpandHeight(true),
GUILayout.ExpandWidth(true) GUILayout.ExpandWidth(true)
); );
   
configPos = Tools.ClampRectToScreen(configPos, 20); configPos = WindowTools.ClampRectToScreen(configPos, 20);
   
if (configPos != this.configWindowPos) if (configPos != this.configWindowPos)
{ {
this.configWindowPos = configPos; this.configWindowPos = configPos;
this.SaveConfigValue("configWindowPos", this.configWindowPos); this.SaveConfigValue(WINDOW_POS_KEY, this.configWindowPos);
} }
} }
} }
   
public void ConfigWindow(int _) public void ConfigWindow(int _)
{ {
GUILayout.BeginVertical(GUILayout.ExpandHeight(true)); GUILayout.BeginVertical(GUILayout.ExpandHeight(true));
   
GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true)); GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true));
   
bool requireLineOfSight = GUITools.Toggle(ARConfiguration.RequireLineOfSight, "Require Line of Sight"); bool requireLineOfSight = Layout.Toggle(ARConfiguration.RequireLineOfSight, "Require Line of Sight");
if (requireLineOfSight != ARConfiguration.RequireLineOfSight) if (requireLineOfSight != ARConfiguration.RequireLineOfSight)
{ {
ARConfiguration.RequireLineOfSight = requireLineOfSight; ARConfiguration.RequireLineOfSight = requireLineOfSight;
this.SaveConfigValue("requireLineOfSight", requireLineOfSight); this.SaveConfigValue(REQUIRE_LOS_KEY, requireLineOfSight);
} }
   
GUILayout.EndHorizontal(); GUILayout.EndHorizontal();
   
GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true)); GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true));
   
bool requireConnectionForControl = bool requireConnectionForControl =
GUITools.Toggle( Layout.Toggle(
ARConfiguration.RequireConnectionForControl, ARConfiguration.RequireConnectionForControl,
"Require Connection for Probe Control" "Require Connection for Probe Control"
); );
if (requireConnectionForControl != ARConfiguration.RequireConnectionForControl) if (requireConnectionForControl != ARConfiguration.RequireConnectionForControl)
{ {
ARConfiguration.RequireConnectionForControl = requireConnectionForControl; ARConfiguration.RequireConnectionForControl = requireConnectionForControl;
this.SaveConfigValue("requireConnectionForControl", requireConnectionForControl); this.SaveConfigValue(REQUIRE_PROBE_CONNECTION_KEY, requireConnectionForControl);
} }
   
GUILayout.EndHorizontal(); GUILayout.EndHorizontal();
   
GUILayout.BeginHorizontal(); GUILayout.BeginHorizontal();
   
bool fixedPowerCost = GUITools.Toggle(ARConfiguration.FixedPowerCost, "Use Fixed Power Cost"); bool fixedPowerCost = Layout.Toggle(ARConfiguration.FixedPowerCost, "Use Fixed Power Cost");
if (fixedPowerCost != ARConfiguration.FixedPowerCost) if (fixedPowerCost != ARConfiguration.FixedPowerCost)
{ {
ARConfiguration.FixedPowerCost = fixedPowerCost; ARConfiguration.FixedPowerCost = fixedPowerCost;
this.SaveConfigValue("fixedPowerCost", fixedPowerCost); this.SaveConfigValue(FIXED_POWER_KEY, fixedPowerCost);
} }
   
GUILayout.EndHorizontal(); GUILayout.EndHorizontal();
   
GUILayout.BeginHorizontal(); GUILayout.BeginHorizontal();
   
bool prettyLines = GUITools.Toggle(ARConfiguration.PrettyLines, "Draw Pretty Lines"); bool useAdditive = Layout.Toggle(ARConfiguration.UseAdditiveRanges, "Use Additive Ranges");
  if (useAdditive != ARConfiguration.UseAdditiveRanges)
  {
  ARConfiguration.UseAdditiveRanges = useAdditive;
  this.SaveConfigValue(USE_ADDITIVE_KEY, useAdditive);
  }
   
  GUILayout.EndHorizontal();
   
  GUILayout.BeginHorizontal();
   
  bool prettyLines = Layout.Toggle(ARConfiguration.PrettyLines, "Draw Pretty Lines");
if (prettyLines != ARConfiguration.PrettyLines) if (prettyLines != ARConfiguration.PrettyLines)
{ {
ARConfiguration.PrettyLines = prettyLines; ARConfiguration.PrettyLines = prettyLines;
this.SaveConfigValue("drawPrettyLines", prettyLines); this.SaveConfigValue(PRETTY_LINES_KEY, prettyLines);
} }
   
GUILayout.EndHorizontal(); GUILayout.EndHorizontal();
   
  GUILayout.BeginHorizontal();
   
  bool useToolbar = Layout.Toggle(ARConfiguration.UseToolbarIfAvailable, "Use Blizzy's Toolbar, if Available");
  if (useToolbar != ARConfiguration.UseToolbarIfAvailable)
  {
  ARConfiguration.UseToolbarIfAvailable = useToolbar;
  this.SaveConfigValue(USE_TOOLBAR_KEY, useToolbar);
  }
   
  GUILayout.EndHorizontal();
   
  GUILayout.BeginHorizontal();
   
  GUILayout.Label("Update Delay", GUILayout.ExpandWidth(false));
   
  this.updateDelayStr = GUILayout.TextField(this.updateDelayStr, 4, GUILayout.Width(40f));
   
  GUILayout.Label("ms", GUILayout.ExpandWidth(false));
   
  GUILayout.EndHorizontal();
   
  if (this.updateDelayStr.Length > 1 && long.TryParse(this.updateDelayStr, out this.updateDelay))
  {
  ARConfiguration.UpdateDelay = Math.Min(Math.Max(this.updateDelay, 16), 2500);
  this.updateDelayStr = ARConfiguration.UpdateDelay.ToString();
  }
   
if (requireLineOfSight) if (requireLineOfSight)
{ {
GUILayout.BeginHorizontal(); GUILayout.BeginHorizontal();
   
double graceRatio = 1d - Math.Sqrt(ARConfiguration.RadiusRatio); double graceRatio = 1d - Math.Sqrt(ARConfiguration.RadiusRatio);
double newRatio; double newRatio;
   
GUILayout.Label(string.Format("Line of Sight 'Fudge Factor': {0:P0}", graceRatio)); GUILayout.Label(string.Format("Line of Sight 'Fudge Factor': {0:P0}", graceRatio));
   
GUILayout.EndHorizontal(); GUILayout.EndHorizontal();
   
GUILayout.BeginHorizontal(); GUILayout.BeginHorizontal();
   
newRatio = GUILayout.HorizontalSlider((float)graceRatio, 0f, 1f, GUILayout.ExpandWidth(true)); newRatio = GUILayout.HorizontalSlider((float)graceRatio, 0f, 1f, GUILayout.ExpandWidth(true));
newRatio = Math.Round(newRatio, 2); newRatio = Math.Round(newRatio, 2);
   
if (newRatio != graceRatio) if (newRatio != graceRatio)
{ {
ARConfiguration.RadiusRatio = (1d - newRatio) * (1d - newRatio); ARConfiguration.RadiusRatio = (1d - newRatio) * (1d - newRatio);
this.SaveConfigValue("graceRatio", newRatio); this.SaveConfigValue(GRACE_RATIO_KEY, newRatio);
} }
   
GUILayout.EndHorizontal(); GUILayout.EndHorizontal();
} }
   
GUILayout.EndVertical(); GUILayout.EndVertical();
   
GUI.DragWindow(); GUI.DragWindow();
} }
   
public void OnDestroy() public void OnDestroy()
{ {
GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChangeRequested); GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChangeRequested);
  GameEvents.OnKSCFacilityUpgraded.Remove(this.onFacilityUpgraded);
   
if (this.toolbarButton != null) if (this.toolbarButton != null)
{ {
this.toolbarButton.Destroy(); this.toolbarButton.Destroy();
  this.toolbarButton = null;
} }
   
if (this.appLauncherButton != null) if (this.appLauncherButton != null)
{ {
ApplicationLauncher.Instance.RemoveModApplication(this.appLauncherButton); ApplicationLauncher.Instance.RemoveModApplication(this.appLauncherButton);
} this.appLauncherButton = null;
} }
  }
protected void onSceneChangeRequested(GameScenes scene)  
  private void onSceneChangeRequested(GameScenes scene)
{ {
if (scene != GameScenes.SPACECENTER) if (scene != GameScenes.SPACECENTER)
{ {
print("ARConfiguration: Requesting Destruction."); print("ARConfiguration: Requesting Destruction.");
MonoBehaviour.Destroy(this); MonoBehaviour.Destroy(this);
} }
} }
   
  private void onFacilityUpgraded(Upgradeables.UpgradeableFacility fac, int lvl)
  {
  if (fac.id == "SpaceCenter/TrackingStation")
  {
  this.Log("Caught onFacilityUpgraded for {0} at level {1}", fac.id, lvl);
  this.SetKerbinRelayRange();
  }
  }
   
  private void SetKerbinRelayRange()
  {
  int tsLevel;
   
  if (HighLogic.CurrentGame.Mode == Game.Modes.CAREER)
  {
  tsLevel = ScenarioUpgradeableFacilities.protoUpgradeables["SpaceCenter/TrackingStation"]
  .facilityRefs[0].FacilityLevel;
  }
  else
  {
  tsLevel = this.trackingStationRanges.Length - 1;
  }
   
  if (tsLevel < this.trackingStationRanges.Length && tsLevel >= 0)
  {
  KerbinRelayRange = this.trackingStationRanges[tsLevel];
  this.Log("Setting Kerbin's range to {0}", KerbinRelayRange);
  }
  else
  {
  this.LogError("Could not set Kerbin's range with invalid Tracking Station level {0}", tsLevel);
  }
  }
   
private void toggleConfigWindow() private void toggleConfigWindow()
{ {
this.showConfigWindow = !this.showConfigWindow; this.showConfigWindow = !this.showConfigWindow;
  this.updateDelayStr = ARConfiguration.UpdateDelay.ToString();
} }
   
private T LoadConfigValue<T>(string key, T defaultValue) private T LoadConfigValue<T>(string key, T defaultValue)
{ {
this.config.load(); this.config.load();
   
return config.GetValue(key, defaultValue); return config.GetValue(key, defaultValue);
} }
   
private void SaveConfigValue<T>(string key, T value) private void SaveConfigValue<T>(string key, T value)
{ {
this.config.load(); this.config.load();
   
this.config.SetValue(key, value); this.config.SetValue(key, value);
   
this.config.save(); this.config.save();
} }
} }
} }
   
// AntennaRange // AntennaRange
// //
// ARFlightController.cs // ARFlightController.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
  #pragma warning disable 1591
   
using KSP; using KSP;
  using KSP.UI.Screens;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using ToadicusTools; using ToadicusTools.Extensions;
  using ToadicusTools.Text;
  using ToadicusTools.DebugTools;
  using ToadicusTools.Wrappers;
using UnityEngine; using UnityEngine;
   
namespace AntennaRange namespace AntennaRange
{ {
[KSPAddon(KSPAddon.Startup.Flight, false)] [KSPAddon(KSPAddon.Startup.Flight, false)]
public class ARFlightController : MonoBehaviour public class ARFlightController : MonoBehaviour
{ {
  #region Static
  private static List<IAntennaRelay> usefulRelays;
  public static IList<IAntennaRelay> UsefulRelays;
  #endregion
   
#region Fields #region Fields
protected Dictionary<ConnectionStatus, string> connectionTextures; private Dictionary<ConnectionStatus, string> toolbarTextures;
protected Dictionary<ConnectionStatus, Texture> appLauncherTextures; private Dictionary<ConnectionStatus, Texture> appLauncherTextures;
   
protected ARMapRenderer mapRenderer; private ARMapRenderer mapRenderer;
   
protected IButton toolbarButton; private IButton toolbarButton;
   
protected ApplicationLauncherButton appLauncherButton; private ApplicationLauncherButton appLauncherButton;
protected Tools.DebugLogger log; private PooledDebugLogger log;
   
protected System.Diagnostics.Stopwatch updateTimer; private System.Diagnostics.Stopwatch updateTimer;
#endregion #endregion
   
#region Properties #region Properties
public ConnectionStatus currentConnectionStatus public ConnectionStatus currentConnectionStatus
{ {
get; get;
protected set; private set;
} }
   
protected string currentConnectionTexture private string currentConnectionTexture
{ {
get get
{ {
return this.connectionTextures[this.currentConnectionStatus]; return this.toolbarTextures[this.currentConnectionStatus];
} }
} }
   
protected Texture currentAppLauncherTexture private Texture currentAppLauncherTexture
{ {
get get
{ {
return this.appLauncherTextures[this.currentConnectionStatus]; return this.appLauncherTextures[this.currentConnectionStatus];
} }
} }
   
public ControlTypes currentControlLock public ControlTypes currentControlLock
{ {
get get
{ {
if (this.lockID == string.Empty) if (this.lockID == string.Empty)
{ {
return ControlTypes.None; return ControlTypes.None;
} }
   
return InputLockManager.GetControlLock(this.lockID); return InputLockManager.GetControlLock(this.lockID);
} }
} }
   
public string lockID public string lockID
{ {
get; get;
protected set; private set;
} }
   
public ControlTypes lockSet public ControlTypes lockSet
{ {
get get
{ {
return ControlTypes.ALL_SHIP_CONTROLS; return ControlTypes.ALL_SHIP_CONTROLS;
} }
} }
   
public Vessel vessel public Vessel vessel
{ {
get get
{ {
if (FlightGlobals.ready && FlightGlobals.ActiveVessel != null) if (FlightGlobals.ready && FlightGlobals.ActiveVessel != null)
{ {
return FlightGlobals.ActiveVessel; return FlightGlobals.ActiveVessel;
} }
   
return null; return null;
} }
} }
#endregion #endregion
   
#region MonoBehaviour LifeCycle #region MonoBehaviour LifeCycle
protected void Awake() private void Awake()
{ {
this.lockID = "ARConnectionRequired"; this.lockID = "ARConnectionRequired";
   
this.log = Tools.DebugLogger.New(this); this.log = PooledDebugLogger.New(this);
   
this.updateTimer = new System.Diagnostics.Stopwatch(); this.updateTimer = new System.Diagnostics.Stopwatch();
   
this.connectionTextures = new Dictionary<ConnectionStatus, string>(); this.toolbarTextures = new Dictionary<ConnectionStatus, string>();
   
this.connectionTextures[ConnectionStatus.None] = "AntennaRange/Textures/toolbarIconNoConnection"; this.toolbarTextures[ConnectionStatus.None] = "AntennaRange/Textures/toolbarIconNoConnection";
this.connectionTextures[ConnectionStatus.Suboptimal] = "AntennaRange/Textures/toolbarIconSubOptimal"; this.toolbarTextures[ConnectionStatus.Suboptimal] = "AntennaRange/Textures/toolbarIconSubOptimal";
this.connectionTextures[ConnectionStatus.Optimal] = "AntennaRange/Textures/toolbarIcon"; this.toolbarTextures[ConnectionStatus.Optimal] = "AntennaRange/Textures/toolbarIcon";
   
this.appLauncherTextures = new Dictionary<ConnectionStatus, Texture>(); this.appLauncherTextures = new Dictionary<ConnectionStatus, Texture>();
   
this.appLauncherTextures[ConnectionStatus.None] = this.appLauncherTextures[ConnectionStatus.None] =
GameDatabase.Instance.GetTexture("AntennaRange/Textures/appLauncherIconNoConnection", false); GameDatabase.Instance.GetTexture("AntennaRange/Textures/appLauncherIconNoConnection", false);
this.appLauncherTextures[ConnectionStatus.Suboptimal] = this.appLauncherTextures[ConnectionStatus.Suboptimal] =
GameDatabase.Instance.GetTexture("AntennaRange/Textures/appLauncherIconSubOptimal", false); GameDatabase.Instance.GetTexture("AntennaRange/Textures/appLauncherIconSubOptimal", false);
this.appLauncherTextures[ConnectionStatus.Optimal] = this.appLauncherTextures[ConnectionStatus.Optimal] =
GameDatabase.Instance.GetTexture("AntennaRange/Textures/appLauncherIcon", false); GameDatabase.Instance.GetTexture("AntennaRange/Textures/appLauncherIcon", false);
   
if (ToolbarManager.ToolbarAvailable) if (ToolbarManager.ToolbarAvailable && ARConfiguration.UseToolbarIfAvailable)
{ {
this.toolbarButton = ToolbarManager.Instance.add("AntennaRange", "ARConnectionStatus"); this.toolbarButton = ToolbarManager.Instance.add("AntennaRange", "ARConnectionStatus");
   
this.toolbarButton.TexturePath = this.connectionTextures[ConnectionStatus.None]; this.toolbarButton.TexturePath = this.toolbarTextures[ConnectionStatus.None];
this.toolbarButton.Text = "AntennaRange"; this.toolbarButton.Text = "AntennaRange";
this.toolbarButton.Visibility = new GameScenesVisibility(GameScenes.FLIGHT); this.toolbarButton.Visibility = new GameScenesVisibility(GameScenes.FLIGHT);
this.toolbarButton.Enabled = false; this.toolbarButton.OnClick += (e) => (this.buttonToggle());
} }
   
GameEvents.onGameSceneLoadRequested.Add(this.onSceneChangeRequested); GameEvents.onGameSceneLoadRequested.Add(this.onSceneChangeRequested);
GameEvents.onVesselChange.Add(this.onVesselChange); GameEvents.onVesselChange.Add(this.onVesselChange);
}  
  usefulRelays = new List<IAntennaRelay>();
protected void Start() UsefulRelays = usefulRelays.AsReadOnly();
{ }
this.mapRenderer = MapView.MapCamera.gameObject.AddComponent<ARMapRenderer>();  
} private void FixedUpdate()
  {
protected void FixedUpdate()  
{  
if (this.appLauncherButton == null && !ToolbarManager.ToolbarAvailable && ApplicationLauncher.Ready)  
{  
this.appLauncherButton = ApplicationLauncher.Instance.AddModApplication(  
ApplicationLauncher.AppScenes.FLIGHT,  
this.appLauncherTextures[ConnectionStatus.None]  
);  
}  
   
this.log.Clear(); this.log.Clear();
   
VesselCommand availableCommand; VesselCommand availableCommand;
   
if (ARConfiguration.RequireConnectionForControl) if (ARConfiguration.RequireConnectionForControl)
{ {
availableCommand = this.vessel.CurrentCommand(); availableCommand = this.vessel.CurrentCommand();
} }
else else
{ {
availableCommand = VesselCommand.Crew; availableCommand = VesselCommand.Crew;
} }
   
log.AppendFormat("availableCommand: {0}\n\t" + log.AppendFormat("availableCommand: {0}\n\t" +
"(availableCommand & VesselCommand.Crew) == VesselCommand.Crew: {1}\n\t" + "(availableCommand & VesselCommand.Crew) == VesselCommand.Crew: {1}\n\t" +
"(availableCommand & VesselCommand.Probe) == VesselCommand.Probe: {2}\n\t" + "(availableCommand & VesselCommand.Probe) == VesselCommand.Probe: {2}\n\t" +
"vessel.HasConnectedRelay(): {3}", "vessel.HasConnectedRelay(): {3}",
(int)availableCommand, (int)availableCommand,
(availableCommand & VesselCommand.Crew) == VesselCommand.Crew, (availableCommand & VesselCommand.Crew) == VesselCommand.Crew,
(availableCommand & VesselCommand.Probe) == VesselCommand.Probe, (availableCommand & VesselCommand.Probe) == VesselCommand.Probe,
vessel.HasConnectedRelay() vessel.HasConnectedRelay()
); );
   
// If we are requiring a connection for control, the vessel does not have any adequately staffed pods, // If we are requiring a connection for control, the vessel does not have any adequately staffed pods,
// and the vessel does not have any connected relays... // and the vessel does not have any connected relays...
if ( if (
HighLogic.LoadedSceneIsFlight && HighLogic.LoadedSceneIsFlight &&
ARConfiguration.RequireConnectionForControl && ARConfiguration.RequireConnectionForControl &&
this.vessel != null && this.vessel != null &&
this.vessel.vesselType != VesselType.EVA && this.vessel.vesselType != VesselType.EVA &&
!( !(
(availableCommand & VesselCommand.Crew) == VesselCommand.Crew || (availableCommand & VesselCommand.Crew) == VesselCommand.Crew ||
(availableCommand & VesselCommand.Probe) == VesselCommand.Probe && vessel.HasConnectedRelay() (availableCommand & VesselCommand.Probe) == VesselCommand.Probe && vessel.HasConnectedRelay()
)) ))
{ {
// ...and if the controls are not currently locked... // ...and if the controls are not currently locked...
if (currentControlLock == ControlTypes.None) if (currentControlLock == ControlTypes.None)
{ {
// ...lock the controls. // ...lock the controls.
InputLockManager.SetControlLock(this.lockSet, this.lockID); InputLockManager.SetControlLock(this.lockSet, this.lockID);
} }
} }
// ...otherwise, if the controls are locked... // ...otherwise, if the controls are locked...
else if (currentControlLock != ControlTypes.None) else if (currentControlLock != ControlTypes.None)
{ {
// ...unlock the controls. // ...unlock the controls.
InputLockManager.RemoveControlLock(this.lockID); InputLockManager.RemoveControlLock(this.lockID);
} }
   
log.Print(); log.Print();
} }
   
protected void Update() private void Update()
{ {
if (!this.updateTimer.IsRunning || this.updateTimer.ElapsedMilliseconds > 125L) if (MapView.MapIsEnabled && this.mapRenderer == null)
{ {
this.updateTimer.Reset(); this.mapRenderer = MapView.MapCamera.gameObject.AddComponent<ARMapRenderer>();
  }
   
  if (this.toolbarButton != null)
  {
  this.toolbarButton.Enabled = MapView.MapIsEnabled;
  }
   
  if (this.appLauncherButton == null && !ToolbarManager.ToolbarAvailable && ApplicationLauncher.Ready)
  {
  this.appLauncherButton = ApplicationLauncher.Instance.AddModApplication(
  this.buttonToggle, this.buttonToggle,
  ApplicationLauncher.AppScenes.FLIGHT | ApplicationLauncher.AppScenes.MAPVIEW,
  this.appLauncherTextures[ConnectionStatus.None]
  );
  }
   
  if (!this.updateTimer.IsRunning || this.updateTimer.ElapsedMilliseconds > ARConfiguration.UpdateDelay)
  {
  this.updateTimer.Restart();
} }
else else
{ {
return; return;
} }
   
this.log.Clear(); this.log.Clear();
   
if ( this.log.Append("[ARFlightController]: Update");
(this.toolbarButton != null || this.appLauncherButton != null) &&  
HighLogic.LoadedSceneIsFlight && if (HighLogic.LoadedSceneIsFlight && FlightGlobals.ready && FlightGlobals.ActiveVessel != null)
FlightGlobals.ActiveVessel != null {
) Vessel vessel;
{ IAntennaRelay relay;
log.Append("Checking vessel relay status.\n"); IAntennaRelay bestActiveRelay = null;
  IList<IAntennaRelay> activeVesselRelays;
this.currentConnectionStatus = FlightGlobals.ActiveVessel.GetConnectionStatus();  
  usefulRelays.Clear();
log.AppendFormat("currentConnectionStatus: {0}, setting texture to {1}",  
this.currentConnectionStatus, this.currentConnectionTexture); for (int vIdx = 0; vIdx < FlightGlobals.Vessels.Count; vIdx++)
  {
if (this.toolbarButton != null) vessel = FlightGlobals.Vessels[vIdx];
{  
this.toolbarButton.TexturePath = this.currentConnectionTexture; if (vessel == null || vessel == FlightGlobals.ActiveVessel)
  {
if (this.currentConnectionStatus == ConnectionStatus.None) continue;
{ }
this.toolbarButton.Important = true;  
} switch (vessel.vesselType)
else {
{ case VesselType.Debris:
this.toolbarButton.Important = false; case VesselType.Flag:
} case VesselType.Unknown:
} continue;
if (this.appLauncherButton != null) }
{  
this.appLauncherButton.SetTexture(this.currentAppLauncherTexture); log.AppendFormat("\nFetching best relay for vessel {0}", vessel);
}  
} relay = vessel.GetBestRelay();
   
log.Print(); if (relay != null)
} {
  log.AppendFormat("\n\tAdding useful relay {0}", relay);
protected void OnDestroy()  
  usefulRelays.Add(relay);
  }
  }
   
  activeVesselRelays = RelayDatabase.Instance[FlightGlobals.ActiveVessel];
   
  if (activeVesselRelays.Count > 0)
  {
  bestActiveRelay = RelayDatabase.Instance.GetBestVesselRelay(FlightGlobals.ActiveVessel);
   
  log.AppendFormat("\n\tAdding best active vessel relay {0} to usefulRelays", bestActiveRelay);
   
  usefulRelays.Add(bestActiveRelay);
  }
   
  log.AppendFormat("\n\tDoing target searches for {0} useful relays", usefulRelays.Count);
   
  for (int uIdx = 0; uIdx < usefulRelays.Count; uIdx++)
  {
  relay = usefulRelays[uIdx];
   
  if (relay == null)
  {
  continue;
  }
   
  log.AppendFormat("\n\tDoing target search for useful relay {0}", relay);
   
  relay.FindNearestRelay();
  relay.RecalculateTransmissionRates();
  }
   
  // Very last, find routes for the non-best relays on the active vessel.
  for (int rIdx = 0; rIdx < activeVesselRelays.Count; rIdx++)
  {
  relay = activeVesselRelays[rIdx];
   
  // The best active relay will get checked with the other useful relays later.
  if (relay == null || relay == bestActiveRelay)
  {
  continue;
  }
   
  log.AppendFormat("\nFinding nearest relay for active vessel relay {0}", relay);
   
  relay.RecalculateTransmissionRates();
  relay.FindNearestRelay();
  }
   
  if (this.toolbarButton != null || this.appLauncherButton != null)
  {
  log.Append("\nChecking active vessel relay status.");
   
  this.currentConnectionStatus = FlightGlobals.ActiveVessel.GetConnectionStatus();
   
  log.AppendFormat("\n\tcurrentConnectionStatus: {0}, setting texture to {1}",
  this.currentConnectionStatus, this.currentConnectionTexture);
   
  if (this.toolbarButton != null)
  {
  this.toolbarButton.TexturePath = this.currentConnectionTexture;
   
  if (this.currentConnectionStatus == ConnectionStatus.None)
  {
  if (!this.toolbarButton.Important) this.toolbarButton.Important = true;
  }
  else
  {
  if (this.toolbarButton.Important) this.toolbarButton.Important = false;
  }
  }
  if (this.appLauncherButton != null)
  {
  this.appLauncherButton.SetTexture(this.currentAppLauncherTexture);
  }
  }
  }
   
  log.Print(false);
  }
   
  private void OnDestroy()
{ {
InputLockManager.RemoveControlLock(this.lockID); InputLockManager.RemoveControlLock(this.lockID);
   
if (this.mapRenderer != null) if (this.mapRenderer != null)
{ {
GameObject.Destroy(this.mapRenderer); GameObject.Destroy(this.mapRenderer);
} }
   
if (this.toolbarButton != null) if (this.toolbarButton != null)
{ {
this.toolbarButton.Destroy(); this.toolbarButton.Destroy();
} }
   
if (this.appLauncherButton != null) if (this.appLauncherButton != null)
{ {
ApplicationLauncher.Instance.RemoveModApplication(this.appLauncherButton); ApplicationLauncher.Instance.RemoveModApplication(this.appLauncherButton);
this.appLauncherButton = null; this.appLauncherButton = null;
} }
   
GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChangeRequested); GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChangeRequested);
GameEvents.onVesselChange.Remove(this.onVesselChange); GameEvents.onVesselChange.Remove(this.onVesselChange);
   
print("ARFlightController: Destroyed."); print("ARFlightController: Destroyed.");
} }
#endregion #endregion
   
  private void buttonToggle()
  {
  if (MapView.MapIsEnabled)
  {
  ARConfiguration.PrettyLines = !ARConfiguration.PrettyLines;
  }
  }
   
#region Event Handlers #region Event Handlers
protected void onSceneChangeRequested(GameScenes scene) private void onSceneChangeRequested(GameScenes scene)
{ {
print("ARFlightController: Requesting Destruction."); print("ARFlightController: Requesting Destruction.");
MonoBehaviour.Destroy(this); MonoBehaviour.Destroy(this);
} }
   
protected void onVesselChange(Vessel vessel) private void onVesselChange(Vessel vessel)
{ {
InputLockManager.RemoveControlLock(this.lockID); InputLockManager.RemoveControlLock(this.lockID);
} }
#endregion #endregion
} }
} }
   
// AntennaRange // AntennaRange
// //
// ARMapRenderer.cs // ARMapRenderer.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
  #pragma warning disable 1591
   
using KSP; using KSP;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using ToadicusTools; using ToadicusTools.Extensions;
  using ToadicusTools.DebugTools;
using UnityEngine; using UnityEngine;
   
namespace AntennaRange namespace AntennaRange
{ {
public class ARMapRenderer : MonoBehaviour public class ARMapRenderer : MonoBehaviour
{ {
  #if BENCH
  private static ulong updateCount = 0u;
  private static ulong updateTimer = 0u;
  private readonly static RollingAverage averager = new RollingAverage();
  private static long twiceAverageTime = long.MaxValue;
  #endif
   
#region Fields #region Fields
private Dictionary<Guid, LineRenderer> vesselLineRenderers; private Dictionary<Guid, LineRenderer> vesselLineRenderers;
   
  // Debug Stuff
  #pragma warning disable 649
  private System.Diagnostics.Stopwatch timer;
  private PooledDebugLogger log;
  private long relayStart;
  private long start;
  #pragma warning restore 649
   
  #pragma warning disable 414
  private Color thisColor;
  #pragma warning restore 414
#endregion #endregion
   
#region Properties #region Properties
public LineRenderer this[Guid idx] public LineRenderer this[Guid idx]
{ {
get get
{ {
if (this.vesselLineRenderers == null) LineRenderer lr;
{  
this.vesselLineRenderers = new Dictionary<Guid, LineRenderer>(); if (!this.vesselLineRenderers.TryGetValue(idx, out lr))
}  
   
if (!this.vesselLineRenderers.ContainsKey(idx))  
{ {
GameObject obj = new GameObject(); GameObject obj = new GameObject();
obj.layer = 31; obj.layer = 31;
   
LineRenderer lr = obj.AddComponent<LineRenderer>(); lr = obj.AddComponent<LineRenderer>();
   
lr.SetColors(Color.green, Color.green);  
lr.material = MapView.OrbitLinesMaterial; lr.material = MapView.OrbitLinesMaterial;
lr.SetVertexCount(2);  
   
this.vesselLineRenderers[idx] = lr; this.vesselLineRenderers[idx] = lr;
}  
  return lr;
return this.vesselLineRenderers[idx]; }
   
  return lr;
} }
} }
#endregion #endregion
   
#region MonoBehaviour Lifecycle #region MonoBehaviour Lifecycle
private void Awake() private void Awake()
{ {
if (ARConfiguration.PrettyLines) if (ARConfiguration.PrettyLines)
{ {
this.vesselLineRenderers = new Dictionary<Guid, LineRenderer>(); this.vesselLineRenderers = new Dictionary<Guid, LineRenderer>();
} }
   
  #if DEBUG || BENCH
  this.timer = new System.Diagnostics.Stopwatch();
  #endif
  #if DEBUG
  this.log = PooledDebugLogger.Get();
  #endif
} }
   
private void OnPreCull() private void OnPreCull()
{ {
if (!HighLogic.LoadedSceneIsFlight || !MapView.MapIsEnabled || !ARConfiguration.PrettyLines) if (!HighLogic.LoadedSceneIsFlight || !MapView.MapIsEnabled || !ARConfiguration.PrettyLines)
{ {
this.Cleanup(); this.Cleanup(!HighLogic.LoadedSceneIsFlight);
   
return; return;
} }
   
Tools.DebugLogger log = Tools.DebugLogger.New(this); #if DEBUG || BENCH
  timer.Restart();
  #endif
   
try try
{ {
  log.Clear();
   
log.AppendFormat("OnPreCull.\n"); log.AppendFormat("OnPreCull.\n");
  /* @ TODO: Fix
log.AppendFormat("\tMapView: Draw3DLines: {0}\n" + log.AppendFormat("\tMapView: Draw3DLines: {0}\n" +
"\tMapView.MapCamera.camera.fieldOfView: {1}\n" + "\tMapView.MapCamera.camera.fieldOfView: {1}\n" +
"\tMapView.MapCamera.Distance: {2}\n", "\tMapView.MapCamera.Distance: {2}\n",
MapView.Draw3DLines, MapView.Draw3DLines,
MapView.MapCamera.camera.fieldOfView, MapView.MapCamera.camera.fieldOfView,
MapView.MapCamera.Distance MapView.MapCamera.Distance
); );
  */
log.AppendLine("vesselFrameCache cleared."); log.AppendLine("FlightGlobals ready and Vessels list not null.");
   
if (FlightGlobals.ready && FlightGlobals.Vessels != null) IAntennaRelay relay;
{  
log.AppendLine("FlightGlobals ready and Vessels list not null."); for (int i = 0; i < ARFlightController.UsefulRelays.Count; i++)
  {
foreach (Vessel vessel in FlightGlobals.Vessels) relay = ARFlightController.UsefulRelays[i];
   
  if (relay == null)
{ {
if (vessel == null) log.AppendFormat("\n\tGot null relay, skipping");
{ continue;
log.AppendFormat("Skipping vessel {0} altogether because it is null.\n");  
continue;  
}  
   
log.AppendFormat("Checking vessel {0}.\n", vessel.vesselName);  
   
switch (vessel.vesselType)  
{  
case VesselType.Debris:  
case VesselType.EVA:  
case VesselType.Unknown:  
case VesselType.SpaceObject:  
log.AppendFormat("\tDiscarded because vessel is of invalid type {0}\n",  
vessel.vesselType);  
continue;  
}  
   
log.Append("\tChecking connection status...\n");  
   
/*if (vessel.HasConnectedRelay())  
{  
log.AppendLine("\tHas a connection, checking for the best relay to use for the line.");*/  
   
IAntennaRelay vesselRelay = null;  
float bestScore = float.PositiveInfinity;  
float relayScore = float.NaN;  
   
foreach (IAntennaRelay relay in RelayDatabase.Instance[vessel].Values)  
{  
relayScore = (float)relay.transmitDistance / relay.maxTransmitDistance;  
   
if (relayScore < bestScore)  
{  
bestScore = relayScore;  
vesselRelay = relay as IAntennaRelay;  
}  
}  
   
if (vesselRelay != null)  
{  
log.AppendFormat("\t...picked relay {0} with a score of {1}",  
vesselRelay, relayScore  
);  
   
this.SetRelayVertices(vesselRelay);  
}  
/*}  
else if (this.vesselLineRenderers.ContainsKey(vessel.id))  
{  
log.AppendLine("\tDisabling line because vessel has no connection.");  
this[vessel.id].enabled = false;  
}*/  
} }
}  
} log.AppendFormat("\n\tDrawing pretty lines for useful relay {0}", relay);
catch (Exception)  
{ #if DEBUG
this.Cleanup(); start = timer.ElapsedMilliseconds;
  #endif
   
  this.SetRelayVertices(relay);
   
  log.AppendFormat("\n\tSet relay vertices for {0} in {1}ms",
  relay, timer.ElapsedMilliseconds - start);
  }
  }
  catch (Exception ex)
  {
  this.LogError("Caught {0}: {1}\n{2}\n", ex.GetType().Name, ex.ToString(), ex.StackTrace.ToString());
  this.Cleanup(false);
} }
#if DEBUG #if DEBUG
finally finally
{ {
  log.AppendFormat("\n\tOnPreCull finished in {0}ms\n", timer.ElapsedMilliseconds);
   
log.Print(); log.Print();
} }
#endif #endif
   
  #if BENCH
  ARMapRenderer.updateCount++;
  ARMapRenderer.updateTimer += (ulong)this.timer.ElapsedTicks;
   
  if (ARMapRenderer.updateCount >= (ulong)(8d / Time.smoothDeltaTime))
  {
  ARMapRenderer.averager.AddItem((double)ARMapRenderer.updateTimer / (double)ARMapRenderer.updateCount);
  ARMapRenderer.updateTimer = 0u;
  ARMapRenderer.updateCount = 0u;
  ARMapRenderer.twiceAverageTime = (long)(ARMapRenderer.averager.Average * 2d);
  }
   
  if (this.timer.ElapsedTicks > ARMapRenderer.twiceAverageTime)
  {
  this.Log("PreCull took significant longer than usual ({0:S3}s vs {1:S3}s)",
  (double)this.timer.ElapsedTicks / (double)System.Diagnostics.Stopwatch.Frequency,
  ARMapRenderer.averager.Average / (double)System.Diagnostics.Stopwatch.Frequency
  );
  }
  #endif
} }
   
private void OnDestroy() private void OnDestroy()
{ {
this.Cleanup(); this.Cleanup(true);
   
print("ARMapRenderer: Destroyed."); this.Log("Destroyed");
} }
#endregion #endregion
   
  #region Utility
private void SetRelayVertices(IAntennaRelay relay) private void SetRelayVertices(IAntennaRelay relay)
{ {
if (relay == null) log.AppendFormat("\n\t\tDrawing line for relay chain starting at {0}.", relay);
{  
  if (relay.vessel == null)
  {
  log.Append("\n\t\tvessel is null, bailing out");
return; return;
} }
   
LineRenderer renderer = this[relay.vessel.id]; LineRenderer renderer = this[relay.vessel.id];
  Vector3 start = ScaledSpace.LocalToScaledSpace(relay.vessel.GetWorldPos3D());
Vector3d start;  
Vector3d end; float lineWidth;
  float d = Screen.height / 2f + 0.01f;
   
  if (MapView.Draw3DLines)
  {
  lineWidth = 0.00833333333f * MapView.MapCamera.Distance;
  }
  else
  {
  lineWidth = 3f;
   
  // TODO: No idea if this substitution is right.
  // start = MapView.MapCamera.camera.WorldToScreenPoint(start);
  start = PlanetariumCamera.Camera.WorldToScreenPoint(start);
   
  start.z = start.z >= 0f ? d : -d;
  }
   
  renderer.SetWidth(lineWidth, lineWidth);
   
  renderer.SetPosition(0, start);
   
  int idx = 0;
   
  #if DEBUG
  relayStart = timer.ElapsedMilliseconds;
  #endif
   
  Vector3 nextPoint;
   
renderer.enabled = true; renderer.enabled = true;
   
if (!relay.CanTransmit()) if (!relay.CanTransmit())
{ {
renderer.SetColors(Color.red, Color.red); thisColor = Color.red;
} }
else else
{ {
if (relay.transmitDistance < relay.nominalTransmitDistance) if (relay.LinkStatus == ConnectionStatus.Optimal)
{ {
renderer.SetColors(Color.green, Color.green); thisColor = Color.green;
} }
else else
{ {
renderer.SetColors(Color.yellow, Color.yellow); thisColor = Color.yellow;
} }
} }
   
start = ScaledSpace.LocalToScaledSpace(relay.vessel.GetWorldPos3D());  
   
if (relay.KerbinDirect) if (relay.KerbinDirect)
{ {
end = ScaledSpace.LocalToScaledSpace(AntennaRelay.Kerbin.position); nextPoint = ScaledSpace.LocalToScaledSpace(AntennaRelay.Kerbin.position);
} }
else else
{ {
if (relay.targetRelay == null) if (relay.targetRelay == null || relay.targetRelay.vessel == null)
{ {
  this.LogError(
  "SetRelayVertices: relay {0} has null target relay or vessel when not KerbinDirect, bailing out!",
  relay
  );
   
  renderer.enabled = false;
return; return;
} }
end = ScaledSpace.LocalToScaledSpace(relay.targetRelay.vessel.GetWorldPos3D());  
} switch (relay.targetRelay.vessel.vesselType)
  {
float lineWidth; case VesselType.Debris:
  case VesselType.Flag:
if (MapView.Draw3DLines) case VesselType.Unknown:
{ renderer.enabled = false;
lineWidth = 0.005859375f * MapView.MapCamera.Distance; return;
} default:
else break;
{ }
lineWidth = 2f;  
  nextPoint = ScaledSpace.LocalToScaledSpace(relay.targetRelay.vessel.GetWorldPos3D());
start = MapView.MapCamera.camera.WorldToScreenPoint(start); }
end = MapView.MapCamera.camera.WorldToScreenPoint(end);  
  renderer.SetColors(thisColor, thisColor);
float d = Screen.height / 2f + 0.01f;  
start.z = start.z >= 0f ? d : -d; if (!MapView.Draw3DLines)
end.z = end.z >= 0f ? d : -d; {
} // TODO: No idea if this substitution is right.
  // nextPoint = MapView.MapCamera.camera.WorldToScreenPoint(nextPoint);
renderer.SetWidth(lineWidth, lineWidth); nextPoint = PlanetariumCamera.Camera.WorldToScreenPoint(nextPoint);
  nextPoint.z = nextPoint.z >= 0f ? d : -d;
renderer.SetPosition(0, start); }
renderer.SetPosition(1, end);  
} idx++;
   
public void Cleanup() renderer.SetVertexCount(idx + 1);
  renderer.SetPosition(idx, nextPoint);
   
  log.AppendFormat("\n\t\t\t...finished segment in {0} ms", timer.ElapsedMilliseconds - relayStart);
  }
   
  private void Cleanup(bool freeObjects)
{ {
if (this.vesselLineRenderers != null && this.vesselLineRenderers.Count > 0) if (this.vesselLineRenderers != null && this.vesselLineRenderers.Count > 0)
{ {
foreach (LineRenderer lineRenderer in this.vesselLineRenderers.Values) IEnumerator<LineRenderer> enumerator = this.vesselLineRenderers.Values.GetEnumerator();
{ LineRenderer lineRenderer;
   
  while (enumerator.MoveNext())
  {
  lineRenderer = enumerator.Current;
   
  if (lineRenderer == null)
  {
  continue;
  }
   
lineRenderer.enabled = false; lineRenderer.enabled = false;
GameObject.Destroy(lineRenderer.gameObject);  
} if (freeObjects)
this.vesselLineRenderers.Clear(); {
} GameObject.Destroy(lineRenderer.gameObject);
} }
  }
   
  if (freeObjects)
  {
  this.vesselLineRenderers.Clear();
  }
  }
  }
  #endregion
} }
} }
   
   
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup> <PropertyGroup>
<Configuration Condition=" '$(Configuration)' == '' ">Debug_win</Configuration> <Configuration Condition=" '$(Configuration)' == '' ">Debug_win</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform> <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<ProductVersion>8.0.30703</ProductVersion> <ProductVersion>8.0.30703</ProductVersion>
<SchemaVersion>2.0</SchemaVersion> <SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{B36F2C11-962E-4A75-9F41-61AD56D11493}</ProjectGuid> <ProjectGuid>{B36F2C11-962E-4A75-9F41-61AD56D11493}</ProjectGuid>
<OutputType>Library</OutputType> <OutputType>Library</OutputType>
<RootNamespace>AntennaRange</RootNamespace> <RootNamespace>AntennaRange</RootNamespace>
<AssemblyName>AntennaRange</AssemblyName> <AssemblyName>AntennaRange</AssemblyName>
<ReleaseVersion>1.3</ReleaseVersion> <ReleaseVersion>1.3</ReleaseVersion>
<SynchReleaseVersion>false</SynchReleaseVersion> <SynchReleaseVersion>false</SynchReleaseVersion>
<TargetFrameworkVersion>v3.5</TargetFrameworkVersion> <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
<UseMSBuildEngine>False</UseMSBuildEngine> <UseMSBuildEngine>False</UseMSBuildEngine>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug_win|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug_win|AnyCPU' ">
<DebugSymbols>true</DebugSymbols> <DebugSymbols>true</DebugSymbols>
<DebugType>full</DebugType> <DebugType>full</DebugType>
<Optimize>false</Optimize> <Optimize>false</Optimize>
<OutputPath>bin\Debug</OutputPath> <OutputPath>bin\Debug</OutputPath>
<DefineConstants>DEBUG;TRACE;</DefineConstants> <DefineConstants>DEBUG;TRACE;</DefineConstants>
<ErrorReport>prompt</ErrorReport> <ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel> <WarningLevel>4</WarningLevel>
<ConsolePause>false</ConsolePause> <ConsolePause>false</ConsolePause>
<CustomCommands> <CustomCommands>
<CustomCommands> <CustomCommands>
<Command type="AfterBuild" command="xcopy /y ${TargetFile} ${ProjectDir}\GameData\AntennaRange\" /> <Command type="AfterBuild" command="xcopy /y ${TargetFile} ${ProjectDir}\GameData\AntennaRange\" />
</CustomCommands> </CustomCommands>
</CustomCommands> </CustomCommands>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release_win|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release_win|AnyCPU' ">
<Optimize>true</Optimize> <Optimize>true</Optimize>
<OutputPath>bin\Release</OutputPath> <OutputPath>bin\Release</OutputPath>
<ErrorReport>prompt</ErrorReport> <ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel> <WarningLevel>4</WarningLevel>
<ConsolePause>false</ConsolePause> <ConsolePause>false</ConsolePause>
<CustomCommands> <CustomCommands>
<CustomCommands> <CustomCommands>
<Command type="AfterBuild" command="xcopy /y ${TargetFile} ${ProjectDir}\GameData\AntennaRange\" /> <Command type="AfterBuild" command="xcopy /y ${TargetFile} ${ProjectDir}\GameData\AntennaRange\" />
</CustomCommands> </CustomCommands>
</CustomCommands> </CustomCommands>
  <DocumentationFile>bin\Release\AntennaRange.xml</DocumentationFile>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug_linux|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug_linux|AnyCPU' ">
<DebugSymbols>true</DebugSymbols> <DebugSymbols>true</DebugSymbols>
<DebugType>full</DebugType> <DebugType>full</DebugType>
<Optimize>false</Optimize> <Optimize>false</Optimize>
<OutputPath>bin\Debug</OutputPath> <OutputPath>bin\Debug</OutputPath>
<DefineConstants>DEBUG;TRACE;</DefineConstants> <DefineConstants>DEBUG;TRACE;</DefineConstants>
<ErrorReport>prompt</ErrorReport> <ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel> <WarningLevel>4</WarningLevel>
<ConsolePause>false</ConsolePause> <ConsolePause>false</ConsolePause>
<CustomCommands> <CustomCommands>
<CustomCommands> <CustomCommands>
<Command type="AfterBuild" command="cp -afv ${TargetFile} ${ProjectDir}/GameData/${ProjectName}/" /> <Command type="AfterBuild" command="cp -afv ${TargetFile} ${ProjectDir}/GameData/${ProjectName}/" />
</CustomCommands> </CustomCommands>
</CustomCommands> </CustomCommands>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release_linux|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release_linux|AnyCPU' ">
<Optimize>true</Optimize> <Optimize>true</Optimize>
<OutputPath>bin\Release</OutputPath> <OutputPath>bin\Release</OutputPath>
<ErrorReport>prompt</ErrorReport> <ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel> <WarningLevel>4</WarningLevel>
<CustomCommands> <CustomCommands>
<CustomCommands> <CustomCommands>
<Command type="AfterBuild" command="cp -afv ${TargetFile} ${ProjectDir}/GameData/${ProjectName}/" /> <Command type="AfterBuild" command="cp -afv ${TargetFile} ${ProjectDir}/GameData/${ProjectName}/" />
</CustomCommands> </CustomCommands>
</CustomCommands> </CustomCommands>
<ConsolePause>false</ConsolePause> <ConsolePause>false</ConsolePause>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<Compile Include="Properties\AssemblyInfo.cs" /> <Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="IAntennaRelay.cs" /> <Compile Include="IAntennaRelay.cs" />
<Compile Include="ModuleLimitedDataTransmitter.cs" /> <Compile Include="ModuleLimitedDataTransmitter.cs" />
<Compile Include="AntennaRelay.cs" /> <Compile Include="AntennaRelay.cs" />
<Compile Include="ProtoAntennaRelay.cs" /> <Compile Include="ProtoAntennaRelay.cs" />
<Compile Include="RelayDatabase.cs" /> <Compile Include="RelayDatabase.cs" />
<Compile Include="RelayExtensions.cs" /> <Compile Include="RelayExtensions.cs" />
<Compile Include="ARConfiguration.cs" /> <Compile Include="ARConfiguration.cs" />
<Compile Include="ARFlightController.cs" /> <Compile Include="ARFlightController.cs" />
<Compile Include="ARMapRenderer.cs" /> <Compile Include="ARMapRenderer.cs" />
  <Compile Include="RelayDataCost.cs" />
</ItemGroup> </ItemGroup>
<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" /> <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
<ItemGroup> <ItemGroup>
<Reference Include="Assembly-CSharp"> <Reference Include="Assembly-CSharp">
<HintPath>..\_KSPAssemblies\Assembly-CSharp.dll</HintPath> <HintPath>..\_KSPAssemblies\Assembly-CSharp.dll</HintPath>
<Private>False</Private> <Private>False</Private>
</Reference> </Reference>
<Reference Include="System"> <Reference Include="System">
<HintPath>..\_KSPAssemblies\System.dll</HintPath> <HintPath>..\_KSPAssemblies\System.dll</HintPath>
<Private>False</Private> <Private>False</Private>
</Reference> </Reference>
<Reference Include="UnityEngine"> <Reference Include="UnityEngine">
<HintPath>..\_KSPAssemblies\UnityEngine.dll</HintPath> <HintPath>..\_KSPAssemblies\UnityEngine.dll</HintPath>
<Private>False</Private> </Reference>
  <Reference Include="KSPUtil">
  <HintPath>..\_KSPAssemblies\KSPUtil.dll</HintPath>
  </Reference>
  <Reference Include="UnityEngine.UI">
  <HintPath>..\_KSPAssemblies\UnityEngine.UI.dll</HintPath>
</Reference> </Reference>
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<ProjectReference Include="..\ToadicusTools\ToadicusTools.csproj"> <ProjectReference Include="..\ToadicusTools\ToadicusTools.csproj">
<Project>{D48A5542-6655-4149-BC27-B27DF0466F1C}</Project> <Project>{D48A5542-6655-4149-BC27-B27DF0466F1C}</Project>
<Name>ToadicusTools</Name> <Name>ToadicusTools</Name>
</ProjectReference> </ProjectReference>
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<None Include="GameData\AntennaRange\AntennaRange.cfg" /> <None Include="GameData\AntennaRange\AntennaRange.cfg" />
<None Include="GameData\AntennaRange\ATM_AntennaRange.cfg" /> <None Include="GameData\AntennaRange\ATM_AntennaRange.cfg" />
</ItemGroup> </ItemGroup>
</Project> </Project>
// AntennaRange // AntennaRange
// //
// AntennaRelay.cs // AntennaRelay.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using ToadicusTools.DebugTools;
using ToadicusTools; using ToadicusTools.Extensions;
  using UnityEngine;
   
namespace AntennaRange namespace AntennaRange
{ {
  /// <summary>
  /// Relay code at the heart of AntennaRange
  /// </summary>
public class AntennaRelay public class AntennaRelay
{ {
// We don't have a Bard, so we'll hide Kerbin here. // We don't have a Bard, so we'll hide Kerbin here.
private static CelestialBody _Kerbin; private static CelestialBody _Kerbin;
   
  /// <summary>
  /// Fetches, caches, and returns a <see cref="CelestialBody"/> reference to Kerbin
  /// </summary>
public static CelestialBody Kerbin public static CelestialBody Kerbin
{ {
get get
{ {
if (_Kerbin == null && FlightGlobals.ready) if (_Kerbin == null && FlightGlobals.ready)
{ {
_Kerbin = FlightGlobals.GetHomeBody(); _Kerbin = FlightGlobals.GetHomeBody();
} }
   
return _Kerbin; return _Kerbin;
} }
} }
   
protected bool canTransmit; #if BENCH
  private static ushort relayCount = 0;
  private static ulong searchCount = 0u;
  private static ulong searchTimer = 0u;
  private readonly static RollingAverage averager = new RollingAverage(16);
  private static long doubleAverageTime = long.MaxValue;
   
   
  private System.Diagnostics.Stopwatch performanceTimer = new System.Diagnostics.Stopwatch();
  #endif
   
  private bool canTransmit;
   
  private IAntennaRelay nearestRelay;
  private IAntennaRelay bestOccludedRelay;
   
  /// <summary>
  /// The <see cref="AntennaRange.ModuleLimitedDataTransmitter"/> reference underlying this AntennaRelay, as an
  /// <see cref="AntennaRange.IAntennaRelay"/>
  /// </summary>
protected IAntennaRelay moduleRef; protected IAntennaRelay moduleRef;
   
protected System.Diagnostics.Stopwatch searchTimer;  
protected long millisecondsBetweenSearches;  
   
/// <summary> /// <summary>
/// Gets the parent Vessel. /// Gets the parent Vessel.
/// </summary> /// </summary>
/// <value>The parent Vessel.</value> /// <value>The parent Vessel.</value>
public virtual Vessel vessel public virtual Vessel vessel
{ {
get get
{ {
return this.moduleRef.vessel; return this.moduleRef.vessel;
} }
} }
   
/// <summary> /// <summary>
/// Gets or sets the nearest relay. /// Gets the target <see cref="AntennaRange.IAntennaRelay"/>relay.
/// </summary> /// </summary>
/// <value>The nearest relay</value> public IAntennaRelay targetRelay
public IAntennaRelay nearestRelay  
{ {
get; get;
protected set; protected set;
} }
   
public IAntennaRelay bestOccludedRelay /// <summary>
  /// Gets a value indicating whether this <see cref="AntennaRange.IAntennaRelay"/> Relay is communicating
  /// directly with Kerbin.
  /// </summary>
  public virtual bool KerbinDirect
{ {
get; get;
protected set; protected set;
} }
   
public IAntennaRelay targetRelay /// <summary>
  /// Gets or sets the nominal link distance, in meters.
  /// </summary>
  public virtual double NominalLinkSqrDistance
{ {
get; get;
protected set; protected set;
} }
   
/// <summary> /// <summary>
/// Gets the first <see cref="CelestialBody"/> found to be blocking line of sight. /// Gets or sets the maximum link distance, in meters.
/// </summary> /// </summary>
public virtual CelestialBody firstOccludingBody public virtual double MaximumLinkSqrDistance
{ {
get; get;
protected set; protected set;
} }
   
/// <summary> /// <summary>
  /// Gets the first <see cref="CelestialBody"/> found to be blocking line of sight.
  /// </summary>
  public virtual CelestialBody firstOccludingBody
  {
  get;
  protected set;
  }
   
  /// <summary>
/// Gets the transmit distance. /// Gets the transmit distance.
/// </summary> /// </summary>
/// <value>The transmit distance.</value> /// <value>The transmit distance.</value>
public double transmitDistance public double CurrentLinkSqrDistance
{ {
get get
{ {
this.FindNearestRelay();  
   
if (this.KerbinDirect || this.targetRelay == null) if (this.KerbinDirect || this.targetRelay == null)
{ {
return this.DistanceTo(Kerbin); return this.SqrDistanceTo(Kerbin);
} }
else else
{ {
return this.DistanceTo(this.targetRelay); return this.SqrDistanceTo(this.targetRelay);
} }
} }
} }
   
  /// <summary>
  /// Gets the current link resource rate in EC/MiT.
  /// </summary>
  /// <value>The current link resource rate in EC/MiT.</value>
  public virtual RelayDataCost CurrentLinkCost
  {
  get
  {
  return new RelayDataCost(this.moduleRef.PacketResourceCost, this.moduleRef.PacketSize);
  }
  }
   
  /// <summary>
  /// Gets the current network link cost back to Kerbin, in EC/MiT.
  /// </summary>
  /// <value>The current network link cost back to Kerbin, in EC/MiT.</value>
  public virtual RelayDataCost CurrentNetworkLinkCost
  {
  get
  {
  RelayDataCost cost = new RelayDataCost();
   
  IAntennaRelay relay = this.moduleRef;
   
  ushort iters = 0;
  while (relay != null)
  {
  cost += new RelayDataCost(relay.PacketResourceCost, relay.PacketSize);
   
  if (relay.KerbinDirect)
  {
  break;
  }
   
  iters++;
   
  if (iters > 255)
  {
  this.LogError("Bailing out of AntennaRelay.CurrentNetworkLinkCost because it looks like " +
  "we're stuck in an infinite loop. This is probably a bug.");
   
  break;
  }
   
  relay = relay.targetRelay;
  }
   
  return cost;
  }
  }
   
  /// <summary>
  /// Gets or sets the link status.
  /// </summary>
  public virtual ConnectionStatus LinkStatus
  {
  get;
  protected set;
  }
   
  /// <summary>
  /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config.
  /// </summary>
public virtual double nominalTransmitDistance public virtual double nominalTransmitDistance
{ {
get; get;
set; set;
} }
   
/// <summary> /// <summary>
/// The maximum distance at which this relay can operate. /// The maximum distance at which this relay can operate.
/// </summary> /// </summary>
/// <value>The max transmit distance.</value> /// <value>The max transmit distance.</value>
public virtual float maxTransmitDistance public virtual double maxTransmitDistance
{ {
get; get;
set; set;
} }
  /*
public virtual bool KerbinDirect * The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except
{ * in that they both return floats. Here's some quick justification:
get; *
protected set; * The stock implementation of GetTransmitterScore (which I cannot override) is:
  * Score = (1 + DataResourceCost) / DataRate
  *
  * The stock DataRate and DataResourceCost are:
  * DataRate = packetSize / packetInterval
  * DataResourceCost = packetResourceCost / packetSize
  *
  * So, the resulting score is essentially in terms of joules per byte per baud. Rearranging that a bit, it
  * could also look like joule-seconds per byte per byte, or newton-meter-seconds per byte per byte. Either way,
  * that metric is not a very reasonable one.
  *
  * Two metrics that might make more sense are joules per byte or joules per byte per second. The latter case
  * would look like:
  * DataRate = packetSize / packetInterval
  * DataResourceCost = packetResourceCost
  *
  * The former case, which I've chosen to implement below, is:
  * DataRate = packetSize
  * DataResourceCost = packetResourceCost
  *
  * So... hopefully that doesn't screw with anything else.
  * */
  /// <summary>
  /// Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in
  /// terms of joules/byte
  /// </summary>
  public virtual float DataRate
  {
  get
  {
  if (this.CanTransmit())
  {
  return this.moduleRef.PacketSize;
  }
  else
  {
  return float.Epsilon;
  }
  }
  }
   
  /// <summary>
  /// Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas
  /// to be scored in terms of joules/byte
  /// </summary>
  public virtual double DataResourceCost
  {
  get
  {
  if (this.CanTransmit())
  {
  return this.moduleRef.PacketResourceCost;
  }
  else
  {
  return float.PositiveInfinity;
  }
  }
} }
   
/// <summary> /// <summary>
/// Determines whether this instance can transmit. /// Determines whether this instance can transmit.
/// </summary> /// </summary>
/// <returns><c>true</c> if this instance can transmit; otherwise, <c>false</c>.</returns> /// <returns><c>true</c> if this instance can transmit; otherwise, <c>false</c>.</returns>
public virtual bool CanTransmit() public virtual bool CanTransmit()
{ {
this.FindNearestRelay();  
return this.canTransmit; return this.canTransmit;
} }
   
/// <summary> /// <summary>
  /// Recalculates the transmission rates.
  /// </summary>
  public void RecalculateTransmissionRates()
  {
  if (!this.canTransmit) {
  this.moduleRef.PacketSize = 0f;
  this.moduleRef.PacketResourceCost = float.PositiveInfinity;
  return;
  }
   
  RelayDataCost cost = this.GetPotentialLinkCost(this.CurrentLinkSqrDistance, this.NominalLinkSqrDistance);
   
  this.moduleRef.PacketSize = cost.PacketSize;
  this.moduleRef.PacketResourceCost = cost.PacketResourceCost;
  }
   
  /// <summary>
  /// Gets the potential link cost, in EC/MiT.
  /// </summary>
  /// <returns>The potential link cost, in EC/MiT.</returns>
  /// <param name="currentSqrDistance">Square of the current distance to the target</param>
  /// <param name="nominalSqrDistance">Square of the nominal range to the target.</param>
  public RelayDataCost GetPotentialLinkCost(double currentSqrDistance, double nominalSqrDistance)
  {
  RelayDataCost linkCost = new RelayDataCost();
   
  float rangeFactor = (float)(nominalSqrDistance / currentSqrDistance);
   
  linkCost.PacketSize = this.moduleRef.PacketSize;
   
  if (ARConfiguration.FixedPowerCost)
  {
  linkCost.PacketResourceCost = this.moduleRef.BasePacketResourceCost;
   
  linkCost.PacketSize = Mathf.Min(
  this.moduleRef.BasePacketSize * rangeFactor,
  this.moduleRef.BasePacketSize * this.moduleRef.MaxDataFactor
  );
  }
  else
  {
  if (currentSqrDistance > nominalSqrDistance)
  {
  linkCost.PacketSize = this.moduleRef.BasePacketSize;
  linkCost.PacketResourceCost = this.moduleRef.BasePacketResourceCost / rangeFactor;
  }
  else
  {
  linkCost.PacketSize = Mathf.Min(
  this.moduleRef.BasePacketSize * rangeFactor,
  this.moduleRef.BasePacketSize * this.moduleRef.MaxDataFactor
  );
  linkCost.PacketResourceCost = this.moduleRef.BasePacketResourceCost;
  }
  }
   
  linkCost.PacketResourceCost *= this.moduleRef.PacketThrottle / 100f;
  linkCost.PacketSize *= this.moduleRef.PacketThrottle / 100f;
   
  return linkCost;
  }
   
  /// <summary>
  /// Gets the potential link cost, in EC/MiT.
  /// </summary>
  /// <returns>The potential link cost, in EC/MiT.</returns>
  /// <param name="potentialTarget">Potential target relay.</param>
  public RelayDataCost GetPotentialLinkCost(IAntennaRelay potentialTarget)
  {
  if (potentialTarget == null)
  {
  return RelayDataCost.Infinity;
  }
   
  double currentSqrDistance = this.SqrDistanceTo(potentialTarget);
   
  if (currentSqrDistance > this.MaxLinkSqrDistanceTo(potentialTarget))
  {
  return RelayDataCost.Infinity;
  }
   
  double nominalSqrDistance;
  if (ARConfiguration.UseAdditiveRanges)
  {
  nominalSqrDistance = this.nominalTransmitDistance * potentialTarget.nominalTransmitDistance;
  }
  else
  {
  nominalSqrDistance = this.nominalTransmitDistance * this.nominalTransmitDistance;
  }
   
  return GetPotentialLinkCost(currentSqrDistance, nominalSqrDistance);
  }
   
  /// <summary>
  /// Gets the potential link cost, in EC/MiT.
  /// </summary>
  /// <returns>The potential link cost, in EC/MiT.</returns>
  /// <param name="body">Potential target Body</param>
  public RelayDataCost GetPotentialLinkCost(CelestialBody body)
  {
  if (body == null || body != Kerbin)
  {
  return RelayDataCost.Infinity;
  }
   
  double currentSqrDistance = this.SqrDistanceTo(body);
   
  if (currentSqrDistance > this.MaxLinkSqrDistanceTo(body))
  {
  return RelayDataCost.Infinity;
  }
   
  double nominalSqrDistance;
  if (ARConfiguration.UseAdditiveRanges)
  {
  nominalSqrDistance = this.nominalTransmitDistance * ARConfiguration.KerbinNominalRange;
  }
  else
  {
  nominalSqrDistance = this.nominalTransmitDistance * this.nominalTransmitDistance;
  }
   
  return GetPotentialLinkCost(currentSqrDistance, nominalSqrDistance);
  }
   
  /// <summary>
/// Finds the nearest relay. /// Finds the nearest relay.
/// </summary> /// </summary>
/// <returns>The nearest relay or null, if no relays in range.</returns> /// <returns>The nearest relay or null, if no relays in range.</returns>
private void FindNearestRelay() public void FindNearestRelay()
{ {
if (!this.searchTimer.IsRunning || this.searchTimer.ElapsedMilliseconds > this.millisecondsBetweenSearches) if (!FlightGlobals.ready)
{  
this.searchTimer.Reset();  
}  
else  
{ {
return; return;
} }
   
// Skip vessels that have already been checked for a nearest relay this pass. PooledDebugLogger log;
if (RelayDatabase.Instance.CheckedVesselsTable.ContainsKey(this.vessel.id)) #if DEBUG
{ log = PooledDebugLogger.New(this);
return; #endif
}  
  #if BENCH
if (FlightGlobals.ActiveVessel != null && FlightGlobals.ActiveVessel.id == this.vessel.id) this.performanceTimer.Restart();
{  
Tools.PostDebugMessage(string.Format( long startVesselLoopTicks;
"{0}: finding nearest relay for {1}", long totalVesselLoopTicks;
this.GetType().Name,  
this.ToString() string slowestLOSVesselName = string.Empty;
)); long slowestLOSVesselTicks = long.MinValue;
} long startLOSVesselTicks;
  long totalLOSVesselTicks;
// Set this vessel as checked, so that we don't check it again.  
RelayDatabase.Instance.CheckedVesselsTable[vessel.id] = true; string slowestCircularVesselName = string.Empty;
  long slowestCircularVesselTicks = long.MinValue;
  long startCircularVesselTicks;
  long totalCircularVesselTicks;
   
  long startKerbinLOSTicks;
  long totalKerbinLOSTicks;
  long statusResolutionTicks;
   
  ushort usefulVesselCount = 0;
  #endif
   
  log.AppendFormat("{0}: Target search started).", this.ToString());
   
  #if DEBUG
  try {
  #endif
   
  // Declare a bunch of variables we'll be using.
  CelestialBody bodyOccludingBestOccludedRelay = null;
  IAntennaRelay needle;
   
  RelayDataCost cheapestRelayRate = RelayDataCost.Infinity;
  RelayDataCost cheapestOccludedRelayRate = RelayDataCost.Infinity;
   
  RelayDataCost potentialRelayRate;
   
  RelayDataCost kerbinRelayRate = this.GetPotentialLinkCost(Kerbin);
   
  bool isCircular;
  int iterCount;
   
// Blank everything we're trying to find before the search. // Blank everything we're trying to find before the search.
this.firstOccludingBody = null; this.firstOccludingBody = null;
this.bestOccludedRelay = null; this.bestOccludedRelay = null;
this.targetRelay = null; this.targetRelay = null;
this.nearestRelay = null; this.nearestRelay = null;
   
CelestialBody bodyOccludingBestOccludedRelay = null; // Default to KerbinDirect = true in case something in here doesn't work right.
  this.KerbinDirect = true;
double nearestRelaySqrDistance = double.PositiveInfinity;  
double bestOccludedSqrDistance = double.PositiveInfinity;  
double maxTransmitSqrDistance = this.maxTransmitDistance * this.maxTransmitDistance;  
   
/* /*
* Loop through all the vessels and exclude this vessel, vessels of the wrong type, and vessels that are too * Loop through the useful relays as determined by ARFlightController and check each for line of sight and
* far away. When we find a candidate, get through its antennae for relays which have not been checked yet * distance, searching for the relay with the best distance/maxRange ratio that is in sight, in range, and
* and that can transmit. Once we find a suitable candidate, assign it to nearestRelay for comparison * can transmit, also stashing the "best" relay outside of line of sight for failure report.
* against future finds.  
* */ * */
foreach (Vessel potentialVessel in FlightGlobals.Vessels) IAntennaRelay potentialBestRelay;
{ CelestialBody fob;
// Skip vessels of the wrong type.  
switch (potentialVessel.vesselType) #if BENCH
{ startVesselLoopTicks = performanceTimer.ElapsedTicks;
case VesselType.Debris: #endif
case VesselType.Flag:  
case VesselType.EVA: for (int rIdx = 0; rIdx < ARFlightController.UsefulRelays.Count; rIdx++)
case VesselType.SpaceObject: {
case VesselType.Unknown: potentialBestRelay = ARFlightController.UsefulRelays[rIdx];
continue; log.AppendFormat("\n\tgot useful relay {0}",
default: potentialBestRelay == null ? "null" : potentialBestRelay.ToString());
break;  
} if (potentialBestRelay == null)
  {
// Skip vessels with the wrong ID log.Append("\n\t...skipping null relay");
if (potentialVessel.id == vessel.id)  
{  
continue; continue;
} }
   
  if (potentialBestRelay == this || potentialBestRelay.vessel == this.vessel)
  {
  log.AppendFormat(
  "\n\t...skipping relay {0} because it or its vessel ({1}) is the same as ours" +
  "\n\t\t(our vessel is {2})",
  potentialBestRelay,
  potentialBestRelay.vessel == null ? "null" : potentialBestRelay.vessel.vesselName,
  this.vessel == null ? "null" : this.vessel.vesselName
  );
  continue;
  }
   
  #if BENCH
  usefulVesselCount++;
  #endif
   
// Find the distance from here to the vessel... // Find the distance from here to the vessel...
double potentialSqrDistance = this.sqrDistanceTo(potentialVessel); log.Append("\n\tgetting cost to potential vessel");
  potentialRelayRate = potentialBestRelay.CurrentNetworkLinkCost + this.GetPotentialLinkCost(potentialBestRelay);
CelestialBody fob = null;  
  log.AppendFormat("\n\tpotentialRelayRate = {0} ({1} + {2})", potentialRelayRate, potentialBestRelay.CurrentNetworkLinkCost, this.GetPotentialLinkCost(potentialBestRelay));
   
  #if BENCH
  startLOSVesselTicks = performanceTimer.ElapsedTicks;
  #endif
   
  log.Append("\n\t\tdoing LOS check");
// Skip vessels to which we do not have line of sight. // Skip vessels to which we do not have line of sight.
if ( if (
ARConfiguration.RequireLineOfSight && ARConfiguration.RequireLineOfSight &&
!this.vessel.hasLineOfSightTo(potentialVessel, out fob, ARConfiguration.RadiusRatio) !this.vessel.hasLineOfSightTo(potentialBestRelay.vessel, out fob, ARConfiguration.RadiusRatio)
) )
{ {
this.firstOccludingBody = fob; #if BENCH
  totalLOSVesselTicks = performanceTimer.ElapsedTicks - startLOSVesselTicks;
if (FlightGlobals.ActiveVessel != null && FlightGlobals.ActiveVessel.id == this.vessel.id)  
{ if (totalLOSVesselTicks > slowestLOSVesselTicks)
Tools.PostDebugMessage("{6}: Vessel {0} discarded because we do not have line of sight." + {
"\npotentialSqrDistance: {1}, bestOccludedSqrDistance: {2}, maxTransmitSqrDistance: {3}" + slowestLOSVesselTicks = totalLOSVesselTicks;
"\npotentialSqrDistance < bestOccludedSqrDistance: {4}" + slowestLOSVesselName = vessel.vesselName;
"\npotentialSqrDistance < (this.maxTransmitDistance * this.maxTransmitDistance): {5}", }
potentialVessel.vesselName, #endif
potentialSqrDistance, bestOccludedSqrDistance, this.maxTransmitDistance * this.maxTransmitDistance,  
potentialSqrDistance < bestOccludedSqrDistance, log.Append("\n\t\t...failed LOS check");
potentialSqrDistance < (this.maxTransmitDistance * this.maxTransmitDistance),  
this.ToString() log.AppendFormat("\n\t\t\t{0}: Relay {1} not in line of sight.",
); this.ToString(), potentialBestRelay);
}  
  log.AppendFormat("\n\t\t\tpotentialRelayRate: {0}", potentialRelayRate);
  log.AppendFormat("\n\t\t\tcheapestOccludedRelayRate: {0}", cheapestOccludedRelayRate);
   
if ( if (
(potentialSqrDistance < bestOccludedSqrDistance) && (potentialRelayRate < cheapestRelayRate) &&
(potentialSqrDistance < maxTransmitSqrDistance) this.IsInRangeOf(potentialBestRelay) &&
  potentialBestRelay.CanTransmit()
) )
{ {
if (FlightGlobals.ActiveVessel != null && FlightGlobals.ActiveVessel.id == this.vessel.id) log.Append("\n\t\t...vessel is cheapest and close enough and potentialBestRelay can transmit");
{ log.AppendFormat("\n\t\t...{0} found new best occluded relay {1}", this, potentialBestRelay);
Tools.PostDebugMessage("{0}: Checking {1} relays on {2}.",  
this.ToString(), this.bestOccludedRelay = potentialBestRelay;
potentialVessel.GetAntennaRelays().Count(), bodyOccludingBestOccludedRelay = fob;
potentialVessel cheapestOccludedRelayRate = potentialRelayRate;
); }
} else
  {
foreach (IAntennaRelay occludedRelay in potentialVessel.GetAntennaRelays()) log.Append("\n\t\t...vessel is not close enough to check for occluded relays, carrying on");
{ }
if (FlightGlobals.ActiveVessel != null && FlightGlobals.ActiveVessel.id == this.vessel.id)  
{  
Tools.PostDebugMessage(this.ToString() + " Checking candidate for bestOccludedRelay: {0}" +  
"\n\tCanTransmit: {1}", occludedRelay, occludedRelay.CanTransmit());  
}  
   
if (occludedRelay.CanTransmit())  
{  
this.bestOccludedRelay = occludedRelay;  
bodyOccludingBestOccludedRelay = fob;  
bestOccludedSqrDistance = potentialSqrDistance;  
   
if (FlightGlobals.ActiveVessel != null && FlightGlobals.ActiveVessel.id == this.vessel.id)  
{  
Tools.PostDebugMessage(this.ToString() + " Found new bestOccludedRelay: {0}" +  
"\nfirstOccludingBody: {1}" +  
"\nbestOccludedSqrDistance: {2}",  
occludedRelay,  
fob,  
potentialSqrDistance  
);  
}  
break;  
}  
}  
}  
   
continue; continue;
} }
  #if BENCH
  else
  {
  totalLOSVesselTicks = performanceTimer.ElapsedTicks - startLOSVesselTicks;
  }
   
  if (totalLOSVesselTicks > slowestLOSVesselTicks)
  {
  slowestLOSVesselTicks = totalLOSVesselTicks;
  slowestLOSVesselName = vessel.vesselName;
  }
  #endif
   
  log.Append("\n\t\t...passed LOS check");
   
/* /*
* ...so that we can skip the vessel if it is further away than a vessel we've already checked. * ...so that we can skip the vessel if it is further away than a vessel we've already checked.
* */ * */
if (potentialSqrDistance > nearestRelaySqrDistance) if (potentialRelayRate > cheapestRelayRate)
{ {
if (FlightGlobals.ActiveVessel != null && FlightGlobals.ActiveVessel.id == this.vessel.id)  
{ log.AppendFormat(
Tools.PostDebugMessage("{0}: Vessel {1} discarded because it is out of range, or farther than another relay.", "\n\t{0}: Relay {1} discarded because it is more expensive than the cheapest relay." +
  "\n\t\t({2}, {3} > {4})",
  this.ToString(),
  potentialBestRelay,
  this.nearestRelay == null ? "NULL" : this.nearestRelay.ToString(),
  potentialRelayRate, cheapestRelayRate
  );
  continue;
  }
   
  log.Append("\n\t\t...passed distance check");
   
  if (potentialBestRelay.CanTransmit())
  {
  #if BENCH
  startCircularVesselTicks = performanceTimer.ElapsedTicks;
  #endif
   
  needle = potentialBestRelay;
  isCircular = false;
   
  iterCount = 0;
  while (needle != null)
  {
  iterCount++;
   
  if (needle.KerbinDirect)
  {
  break;
  }
   
  if (needle.targetRelay == null)
  {
  break;
  }
   
  if (needle.targetRelay.vessel == this.vessel || needle == this.moduleRef)
  {
  isCircular = true;
  break;
  }
   
  // Avoid infinite loops when we're not catching things right.
  if (iterCount > FlightGlobals.Vessels.Count)
  {
  this.LogError(
  "iterCount exceeded while checking for circular network; assuming it is circular" +
  "\n\tneedle={0}" +
  "\n\tthis.moduleRef={1}",
  needle == null ? "null" : string.Format(
  "{0}, needle.KerbinDirect={1}, needle.targetRelay={2}",
  needle, needle.KerbinDirect, needle.targetRelay == null ? "null" : string.Format(
  "{0}\n\tneedle.targetRelay.vessel={1}",
  needle.targetRelay,
  needle.targetRelay.vessel == null ?
  "null" : needle.targetRelay.vessel.vesselName
  )
  ),
  this.moduleRef == null ? "null" : this.moduleRef.ToString()
  );
  isCircular = true;
  break;
  }
   
  needle = needle.targetRelay;
  }
   
  if (!isCircular)
  {
  cheapestRelayRate = potentialRelayRate;
  this.nearestRelay = potentialBestRelay;
   
  log.AppendFormat("\n\t{0}: found new cheapest relay {1} ({2} EC/MiT)",
this.ToString(), this.ToString(),
potentialVessel.vesselName this.nearestRelay.ToString(),
  cheapestRelayRate
); );
} }
continue; else
} {
  log.AppendFormat("\n\t\t...connection to {0} would result in a circular network, skipping",
nearestRelaySqrDistance = potentialSqrDistance; potentialBestRelay
  );
foreach (IAntennaRelay potentialRelay in potentialVessel.GetAntennaRelays()) }
{  
if (potentialRelay.CanTransmit() && potentialRelay.targetRelay != this) #if BENCH
{ totalCircularVesselTicks = performanceTimer.ElapsedTicks - startCircularVesselTicks;
this.nearestRelay = potentialRelay;  
  if (totalCircularVesselTicks > slowestCircularVesselTicks)
if (FlightGlobals.ActiveVessel != null && FlightGlobals.ActiveVessel.id == this.vessel.id) {
{ slowestCircularVesselName = vessel.vesselName;
Tools.PostDebugMessage(string.Format("{0}: found new best relay {1} ({2})", slowestCircularVesselTicks = totalCircularVesselTicks;
this.ToString(), }
this.nearestRelay.ToString(),  
this.nearestRelay.vessel.id #endif
)); }
} }
break;  
} #if BENCH
} totalVesselLoopTicks = performanceTimer.ElapsedTicks - startVesselLoopTicks;
} #endif
   
CelestialBody bodyOccludingKerbin = null; CelestialBody bodyOccludingKerbin = null;
   
double kerbinSqrDistance = this.vessel.DistanceTo(Kerbin) - Kerbin.Radius; log.AppendFormat("\n{0} ({1}): Search done, figuring status.", this.ToString(), this.GetType().Name);
kerbinSqrDistance *= kerbinSqrDistance; log.AppendFormat(
  "\n{0}: nearestRelay={1} ({2})), bestOccludedRelay={3} ({4}), kerbinRelayRate={5} EC/MiT)",
Tools.DebugLogger log = Tools.DebugLogger.New(this); this,
  this.nearestRelay == null ? "null" : this.nearestRelay.ToString(),
log.AppendFormat("{0} ({1}): Search done, figuring status.", this.ToString(), this.GetType().Name); cheapestRelayRate,
  this.bestOccludedRelay == null ? "null" : this.bestOccludedRelay.ToString(),
  cheapestOccludedRelayRate,
  kerbinRelayRate
  );
   
  #if BENCH
  startKerbinLOSTicks = this.performanceTimer.ElapsedTicks;
  #endif
   
// If we don't have LOS to Kerbin, focus on relays // If we don't have LOS to Kerbin, focus on relays
if (!this.vessel.hasLineOfSightTo(Kerbin, out bodyOccludingKerbin, ARConfiguration.RadiusRatio)) if (
{ ARConfiguration.RequireLineOfSight &&
  !this.vessel.hasLineOfSightTo(Kerbin, out bodyOccludingKerbin, ARConfiguration.RadiusRatio)
  )
  {
  #if BENCH
  totalKerbinLOSTicks = this.performanceTimer.ElapsedTicks - startKerbinLOSTicks;
  #endif
log.AppendFormat("\n\tKerbin LOS is blocked by {0}.", bodyOccludingKerbin.bodyName); log.AppendFormat("\n\tKerbin LOS is blocked by {0}.", bodyOccludingKerbin.bodyName);
   
// nearestRelaySqrDistance will be infinity if all relays are occluded or none exist. // If we're in range of the "nearest" (actually cheapest) relay, use it.
// Therefore, this will only be true if a valid relay is in range. if (this.IsInRangeOf(this.nearestRelay))
if (nearestRelaySqrDistance <= maxTransmitSqrDistance) {
{ log.AppendFormat("\n\t\tCan transmit to nearby relay {0}).",
log.AppendFormat("\n\tCan transmit to nearby relay {0} ({1} <= {2}).", this.nearestRelay == null ? "null" : this.nearestRelay.ToString()
this.nearestRelay == null ? "null" : this.nearestRelay.ToString(), );
nearestRelaySqrDistance, maxTransmitSqrDistance);  
   
this.KerbinDirect = false; this.KerbinDirect = false;
this.canTransmit = true; this.canTransmit = true;
this.targetRelay = this.nearestRelay; this.targetRelay = this.nearestRelay;
} }
// If this isn't true, we can't transmit, but pick a second best of bestOccludedRelay and Kerbin anyway // If this isn't true, we can't transmit, but pick a second best of bestOccludedRelay and Kerbin anyway
else else
{ {
log.AppendFormat("\n\tCan't transmit to nearby relay {0} ({1} > {2}).", log.AppendFormat("\n\t\tCan't transmit to nearby relay {0}.",
this.nearestRelay == null ? "null" : this.nearestRelay.ToString(), this.nearestRelay == null ? "null" : this.nearestRelay.ToString()
nearestRelaySqrDistance, maxTransmitSqrDistance); );
   
this.canTransmit = false; this.canTransmit = false;
   
// If the best occluded relay is closer than Kerbin, target it. // If the best occluded relay is cheaper than Kerbin, check it against the nearest relay.
if (bestOccludedSqrDistance < kerbinSqrDistance) // Since cheapestOccludedRelayRate is infinity if there are no occluded relays, this is safe
{ if (cheapestOccludedRelayRate < kerbinRelayRate)
log.AppendFormat("\n\t\tPicking occluded relay {0} as target ({1} < {2}).", {
this.bestOccludedRelay == null ? "null" : this.bestOccludedRelay.ToString(), log.AppendFormat("\n\t\t\tBest occluded relay is cheaper than Kerbin ({0} < {1})",
bestOccludedSqrDistance, kerbinSqrDistance); cheapestOccludedRelayRate, kerbinRelayRate);
   
this.KerbinDirect = false; this.KerbinDirect = false;
this.targetRelay = this.bestOccludedRelay;  
this.firstOccludingBody = bodyOccludingBestOccludedRelay; // If the nearest relay is cheaper than the best occluded relay, pick it.
} // Since cheapestRelayRate is infinity if there are no nearby relays, this is safe.
// Otherwise, target Kerbin and report the first body blocking it. if (cheapestRelayRate < cheapestOccludedRelayRate)
  {
  log.AppendFormat("\n\t\t\t\t...but the nearest relay is cheaper ({0} < {1}), so picking it.",
  cheapestRelayRate, cheapestOccludedRelayRate);
   
  this.targetRelay = this.nearestRelay;
  this.firstOccludingBody = null;
  }
  // Otherwise, target the best occluded relay.
  else
  {
  log.AppendFormat("\n\t\t\t\t...and cheaper than the nearest relay ({0} >= {1}), so picking it.",
  cheapestRelayRate, cheapestOccludedRelayRate);
   
  this.targetRelay = bestOccludedRelay;
  this.firstOccludingBody = bodyOccludingBestOccludedRelay;
  }
  }
  // Otherwise, check Kerbin against the "nearest" (cheapest) relay.
else else
{ {
log.AppendFormat("\n\t\tPicking Kerbin as target ({0} >= {1}).", log.AppendFormat("\n\t\t\tKerbin is cheaper than the best occluded relay ({0} >= {1})",
bestOccludedSqrDistance, kerbinSqrDistance); cheapestOccludedRelayRate, kerbinRelayRate);
   
  // If the "nearest" (cheapest) relay is cheaper than Kerbin, pick it.
  // Since cheapestRelayRate is infinity if there are no nearby relays, this is safe.
  if (cheapestRelayRate < kerbinRelayRate)
  {
  log.AppendFormat("\n\t\t\t\t...but the nearest relay is cheaper ({0} < {1}), so picking it.",
  cheapestRelayRate, kerbinRelayRate);
   
  // Since we have LOS, blank the first occluding body.
  this.firstOccludingBody = null;
   
  this.KerbinDirect = false;
  this.targetRelay = this.nearestRelay;
  }
  // Otherwise, pick Kerbin.
  else
  {
  log.AppendFormat("\n\t\t\t\t...and cheaper than the nearest relay ({0} >= {1}), so picking it.",
  cheapestRelayRate, kerbinRelayRate);
   
  this.KerbinDirect = true;
  this.firstOccludingBody = bodyOccludingKerbin;
  this.targetRelay = null;
  }
  }
  }
  }
  // If we do have LOS to Kerbin, try to prefer the closest of nearestRelay and Kerbin
  else
  {
  #if BENCH
  totalKerbinLOSTicks = this.performanceTimer.ElapsedTicks - startKerbinLOSTicks;
  #endif
   
  log.AppendFormat("\n\tKerbin is in LOS.");
   
  // If the nearest relay is in range, we can transmit.
  if (this.IsInRangeOf(this.nearestRelay))
  {
  log.AppendFormat("\n\t\tCan transmit to nearby relay {0} (in range).",
  this.nearestRelay == null ? "null" : this.nearestRelay.ToString()
  );
   
  this.canTransmit = true;
   
  // If the nearestRelay is closer than Kerbin, use it.
  if (cheapestRelayRate < kerbinRelayRate)
  {
  log.AppendFormat("\n\t\t\tPicking relay {0} over Kerbin ({1} < {2}).",
  this.nearestRelay == null ? "null" : this.nearestRelay.ToString(),
  cheapestRelayRate, kerbinRelayRate);
   
  this.KerbinDirect = false;
  this.targetRelay = this.nearestRelay;
  }
  // Otherwise, Kerbin is closer, so use it.
  else
  {
  log.AppendFormat("\n\t\t\tBut picking Kerbin over nearby relay {0} ({1} >= {2}).",
  this.nearestRelay == null ? "null" : this.nearestRelay.ToString(),
  cheapestRelayRate, kerbinRelayRate);
   
this.KerbinDirect = true; this.KerbinDirect = true;
this.targetRelay = null; this.targetRelay = null;
this.firstOccludingBody = bodyOccludingKerbin;  
}  
}  
}  
// If we do have LOS to Kerbin, try to prefer the closest of nearestRelay and Kerbin  
else  
{  
log.AppendFormat("\n\tKerbin is in LOS.");  
   
// If the nearest relay is closer than Kerbin and in range, transmit to it.  
if (nearestRelaySqrDistance <= maxTransmitSqrDistance)  
{  
log.AppendFormat("\n\tCan transmit to nearby relay {0} ({1} <= {2}).",  
this.nearestRelay == null ? "null" : this.nearestRelay.ToString(),  
nearestRelaySqrDistance, maxTransmitSqrDistance);  
   
this.canTransmit = true;  
   
// If the nearestRelay is closer than Kerbin, use it.  
if (nearestRelaySqrDistance < kerbinSqrDistance)  
{  
log.AppendFormat("\n\tPicking relay {0} over Kerbin ({1} < {2}).",  
this.nearestRelay == null ? "null" : this.nearestRelay.ToString(),  
nearestRelaySqrDistance, kerbinSqrDistance);  
   
this.KerbinDirect = false;  
this.targetRelay = this.nearestRelay;  
}  
// Otherwise, Kerbin is closer, so use it.  
else  
{  
log.AppendFormat("\n\tBut picking Kerbin over nearby relay {0} ({1} >= {2}).",  
this.nearestRelay == null ? "null" : this.nearestRelay.ToString(),  
nearestRelaySqrDistance, kerbinSqrDistance);  
   
this.KerbinDirect = true;  
this.targetRelay = null;  
} }
} }
// If the nearest relay is out of range, we still need to check on Kerbin. // If the nearest relay is out of range, we still need to check on Kerbin.
else else
{ {
log.AppendFormat("\n\tCan't transmit to nearby relay {0} ({1} > {2}).", log.AppendFormat("\n\t\tCheapest relay {0} is out of range.",
this.nearestRelay == null ? "null" : this.nearestRelay.ToString(), this.nearestRelay == null ? "null" : this.nearestRelay.ToString()
nearestRelaySqrDistance, maxTransmitSqrDistance); );
   
// If Kerbin is in range, use it. // If Kerbin is in range, use it.
if (kerbinSqrDistance <= maxTransmitSqrDistance) if (this.IsInRangeOf(Kerbin))
{ {
log.AppendFormat("\n\tCan transmit to Kerbin ({0} <= {1}).", log.AppendFormat("\n\t\t\tCan transmit to Kerbin (in range).");
kerbinSqrDistance, maxTransmitSqrDistance);  
   
this.canTransmit = true; this.canTransmit = true;
this.KerbinDirect = true; this.KerbinDirect = true;
this.targetRelay = null; this.targetRelay = null;
} }
// If Kerbin is out of range and the nearest relay is out of range, pick a second best between // If Kerbin is out of range and the nearest relay is out of range, pick a second best between
// Kerbin and bestOccludedRelay // Kerbin and bestOccludedRelay
else else
{ {
log.AppendFormat("\n\tCan't transmit to Kerbin ({0} > {1}).", log.AppendFormat("\n\t\t\tCan't transmit to Kerbin (out of range).");
kerbinSqrDistance, maxTransmitSqrDistance);  
   
this.canTransmit = false; this.canTransmit = false;
   
// If the best occluded relay is closer than Kerbin, use it. // If the best occluded relay is cheaper than Kerbin, check it against the nearest relay.
// Since bestOccludedSqrDistance is infinity if there are no occluded relays, // Since bestOccludedSqrDistance is infinity if there are no occluded relays, this is safe
// this is safe if (cheapestOccludedRelayRate < kerbinRelayRate)
if (bestOccludedSqrDistance < kerbinSqrDistance)  
{ {
log.AppendFormat("\n\t\tPicking occluded relay {0} as target ({1} < {2}).", log.AppendFormat("\n\t\t\tBest occluded relay is closer than Kerbin ({0} < {1})",
this.bestOccludedRelay == null ? "null" : this.bestOccludedRelay.ToString(), cheapestOccludedRelayRate, kerbinRelayRate);
bestOccludedSqrDistance, kerbinSqrDistance);  
   
this.KerbinDirect = false; this.KerbinDirect = false;
this.targetRelay = bestOccludedRelay;  
this.firstOccludingBody = bodyOccludingBestOccludedRelay; // If the nearest relay is closer than the best occluded relay, pick it.
  // Since cheapestRelayRate is infinity if there are no nearby relays, this is safe.
  if (cheapestRelayRate < cheapestOccludedRelayRate)
  {
  log.AppendFormat("\n\t\t\t\t...but the nearest relay is cheaper ({0} < {1}), so picking it.",
  cheapestRelayRate, cheapestOccludedRelayRate);
   
  this.targetRelay = this.nearestRelay;
  this.firstOccludingBody = null;
  }
  // Otherwise, target the best occluded relay.
  else
  {
  log.AppendFormat("\n\t\t\t\t...and cheaper than the nearest relay ({0} >= {1}), so picking it.",
  cheapestRelayRate, cheapestOccludedRelayRate);
   
  this.targetRelay = bestOccludedRelay;
  this.firstOccludingBody = bodyOccludingBestOccludedRelay;
  }
} }
// Otherwise, target Kerbin. Since we have LOS, blank the first occluding body. // Otherwise, check Kerbin against the nearest relay.
  // Since we have LOS, blank the first occluding body.
else else
{ {
log.AppendFormat("\n\t\tPicking Kerbin as target ({0} >= {1}).", log.AppendFormat("\n\t\t\tKerbin is cheaper than the best occluded relay ({0} >= {1})",
bestOccludedSqrDistance, kerbinSqrDistance); cheapestOccludedRelayRate, kerbinRelayRate);
   
this.KerbinDirect = true;  
this.targetRelay = null;  
this.firstOccludingBody = null; this.firstOccludingBody = null;
   
  // If the nearest relay is cheaper than Kerbin, pick it.
  // Since cheapestRelayRate is infinity if there are no nearby relays, this is safe.
  if (cheapestRelayRate < kerbinRelayRate)
  {
  log.AppendFormat("\n\t\t\t\t...but the nearest relay is cheaper ({0} < {1}), so picking it.",
  cheapestRelayRate, kerbinRelayRate);
   
  this.KerbinDirect = false;
  this.targetRelay = this.nearestRelay;
  }
  // Otherwise, pick Kerbin.
  else
  {
  log.AppendFormat("\n\t\t\t\t...and cheaper than the nearest relay ({0} >= {1}), so picking it.",
  cheapestRelayRate, kerbinRelayRate);
   
  this.KerbinDirect = true;
  this.targetRelay = null;
  }
} }
} }
} }
} }
   
log.AppendFormat("\n{0}: Status determination complete.", this.ToString()); if (ARConfiguration.UseAdditiveRanges)
  {
log.Print(); if (this.KerbinDirect)
  {
// Now that we're done with our recursive CanTransmit checks, flag this relay as not checked so it can be this.NominalLinkSqrDistance = this.nominalTransmitDistance * ARConfiguration.KerbinNominalRange;
// used next time. this.MaximumLinkSqrDistance = this.maxTransmitDistance * ARConfiguration.KerbinRelayRange;
RelayDatabase.Instance.CheckedVesselsTable.Remove(vessel.id); }
} else
  {
  this.NominalLinkSqrDistance = this.nominalTransmitDistance * this.targetRelay.nominalTransmitDistance;
  this.MaximumLinkSqrDistance = this.maxTransmitDistance * this.targetRelay.maxTransmitDistance;
  }
  }
  else
  {
  this.NominalLinkSqrDistance = this.nominalTransmitDistance * this.nominalTransmitDistance;
  this.MaximumLinkSqrDistance = this.maxTransmitDistance * this.maxTransmitDistance;
  }
   
  if (this.canTransmit)
  {
  if (this.CurrentLinkSqrDistance < this.NominalLinkSqrDistance)
  {
  this.LinkStatus = ConnectionStatus.Optimal;
  }
  else
  {
  this.LinkStatus = ConnectionStatus.Suboptimal;
  }
  }
  else
  {
  this.LinkStatus = ConnectionStatus.None;
  }
   
  #if BENCH
  statusResolutionTicks = performanceTimer.ElapsedTicks - startKerbinLOSTicks - totalKerbinLOSTicks;
  #endif
   
  log.AppendFormat("\n{0}: Target search and status determination complete.", this.ToString());
   
  #if DEBUG
  } catch (Exception ex) {
  log.AppendFormat("\nCaught {0}: {1}\n{2}", ex.GetType().FullName, ex.ToString(), ex.StackTrace);
  #if QUIT_ON_EXCEPTION
  UnityEngine.Application.Quit();
  #endif
  } finally {
  #endif
  log.Print(false);
  #if DEBUG
  }
  #endif
   
  #if BENCH
  AntennaRelay.searchTimer += (ulong)this.performanceTimer.ElapsedTicks;
  AntennaRelay.searchCount++;
  this.performanceTimer.Stop();
   
  double averageSearchTime = (double)AntennaRelay.searchTimer / (double)AntennaRelay.searchCount;
   
  if (AntennaRelay.searchCount >= 8000u / (ulong)ARConfiguration.UpdateDelay)
  {
  AntennaRelay.searchCount = 0u;
  AntennaRelay.searchTimer = 0u;
   
  AntennaRelay.averager.AddItem(averageSearchTime);
  AntennaRelay.doubleAverageTime = (long)(AntennaRelay.averager.Average * 2d);
  }
   
  if (this.performanceTimer.ElapsedTicks > AntennaRelay.doubleAverageTime)
  {
  System.Text.StringBuilder sb = Tools.GetStringBuilder();
   
  sb.AppendFormat(Tools.SIFormatter, "[AntennaRelay] FindNearestRelay search for {0}" +
  " took significantly longer than average ({1:S3}s vs {2:S3}s)",
  this.ToString(),
  (double)this.performanceTimer.ElapsedTicks / (double)System.Diagnostics.Stopwatch.Frequency,
  (double)AntennaRelay.averager.Average / (double)System.Diagnostics.Stopwatch.Frequency
  );
   
  sb.AppendFormat(Tools.SIFormatter, "\n\tVessel loop time: {0:S3}s",
  (double)totalVesselLoopTicks / (double)System.Diagnostics.Stopwatch.Frequency
  );
   
  sb.AppendFormat(Tools.SIFormatter, "\n\t\tAverage vessel time for each of {1} vessels: {0:S3}s",
  (double)totalVesselLoopTicks / (double)System.Diagnostics.Stopwatch.Frequency /
  (double)usefulVesselCount,
  usefulVesselCount
  );
   
  sb.AppendFormat(Tools.SIFormatter, "\n\t\tSlowest vessel LOS check: {0:S3}s to {1}",
  (double)slowestLOSVesselTicks / (double)System.Diagnostics.Stopwatch.Frequency,
  slowestLOSVesselName
  );
   
  sb.AppendFormat(Tools.SIFormatter, "\n\t\tSlowest circular relay check: {0:S3}s for {1}",
  (double)slowestCircularVesselTicks / (double)System.Diagnostics.Stopwatch.Frequency,
  slowestCircularVesselName
  );
   
  sb.AppendFormat(Tools.SIFormatter, "\n\tKerbin LOS check: {0:S3}s",
  (double)totalKerbinLOSTicks / (double)System.Diagnostics.Stopwatch.Frequency
  );
   
  sb.AppendFormat(Tools.SIFormatter, "\n\tStatus resolution check: {0:S3}s",
  (double)statusResolutionTicks / (double)System.Diagnostics.Stopwatch.Frequency
  );
   
  // sb.AppendFormat(Tools.SIFormatter, "", start)
   
  this.LogWarning(sb.ToString());
   
  Tools.PutStringBuilder(sb);
  }
  #endif
  }
   
  /// <summary>
  /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.AntennaRelay"/>.
  /// </summary>
  /// <returns>A <see cref="System.String"/> that represents the current <see cref="AntennaRange.AntennaRelay"/>.</returns>
public override string ToString() public override string ToString()
{ {
if (this is ProtoAntennaRelay) if (this is ProtoAntennaRelay)
{ {
return (this as ProtoAntennaRelay).ToString(); return (this as ProtoAntennaRelay).ToString();
} }
return this.moduleRef.ToString(); return this.moduleRef.ToString();
} }
   
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="AntennaRange.ProtoDataTransmitter"/> class. /// Initializes a new instance of the <see cref="AntennaRange.AntennaRelay"/> class.
/// </summary> /// </summary>
/// <param name="ms"><see cref="ProtoPartModuleSnapshot"/></param> /// <param name="module">The module reference underlying this AntennaRelay,
  /// as an <see cref="AntennaRange.IAntennaRelay"/></param>
public AntennaRelay(IAntennaRelay module) public AntennaRelay(IAntennaRelay module)
{ {
  this.KerbinDirect = true;
this.moduleRef = module; this.moduleRef = module;
   
this.searchTimer = new System.Diagnostics.Stopwatch(); #if BENCH
this.millisecondsBetweenSearches = 125L; AntennaRelay.relayCount++;
  #endif
   
  this.LogDebug("{0}: constructed {1}", this.GetType().Name, this.ToString());
} }
} }
} }
   
   
// AntennaRange // AntennaRange
// //
// AntennaRange.cfg // AntennaRange.cfg
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// //
// This software uses the ModuleManager library © 2013 ialdabaoth, used under a Creative Commons Attribution-ShareAlike // This software uses the ModuleManager library © 2013 ialdabaoth, used under a Creative Commons Attribution-ShareAlike
// 3.0 Uported License. // 3.0 Uported License.
// //
// Specifications: // Specifications:
// nominalRange: The distance from Kerbin at which the antenna will perform exactly as prescribed by // nominalRange: The distance from Kerbin at which the antenna will perform exactly as prescribed by
// packetResourceCost and packetSize. // packetResourceCost and packetSize.
// maxPowerFactor: The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the // maxPowerFactor: The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the
// power cost exceeds packetResourceCost * maxPowerFactor, transmission will fail. // power cost exceeds packetResourceCost * maxPowerFactor, transmission will fail.
// maxDataFactor: The multipler on packetSize that defines the maximum data bandwidth of the antenna. // maxDataFactor: The multipler on packetSize that defines the maximum data bandwidth of the antenna.
// //
   
@PART[longAntenna]:FOR[AntennaRange]:NEEDS[!RemoteTech2] @PART[longAntenna]:FOR[AntennaRange]:NEEDS[!RemoteTech]
{ {
  @TechRequired = start
   
@MODULE[ModuleDataTransmitter] @MODULE[ModuleDataTransmitter]
{ {
@name = ModuleLimitedDataTransmitter @name = ModuleLimitedDataTransmitter
nominalRange = 1500000 nominalRange = 6364
  simpleRange = 20500000
maxPowerFactor = 8 maxPowerFactor = 8
maxDataFactor = 4 maxDataFactor = 4
} }
   
MODULE MODULE
{ {
name = ModuleScienceContainer name = ModuleScienceContainer
   
dataIsCollectable = true dataIsCollectable = true
dataIsStorable = false dataIsStorable = false
   
storageRange = 2 storageRange = 2
} }
} }
   
@PART[mediumDishAntenna]:FOR[AntennaRange]:NEEDS[!RemoteTech2] @PART[mediumDishAntenna]:FOR[AntennaRange]:NEEDS[!RemoteTech]
{ {
@MODULE[ModuleDataTransmitter] @MODULE[ModuleDataTransmitter]
{ {
@name = ModuleLimitedDataTransmitter @name = ModuleLimitedDataTransmitter
nominalRange = 30000000 nominalRange = 3150000000
maxPowerFactor = 8 simpleRange = 18000000000
maxDataFactor = 4 maxPowerFactor = 4
  maxDataFactor = 8
} }
   
MODULE MODULE
{ {
name = ModuleScienceContainer name = ModuleScienceContainer
   
dataIsCollectable = true dataIsCollectable = true
dataIsStorable = false dataIsStorable = false
   
storageRange = 2 storageRange = 2
} }
} }
   
@PART[commDish]:FOR[AntennaRange]:NEEDS[!RemoteTech2] @PART[commDish]:FOR[AntennaRange]:NEEDS[!RemoteTech]
{ {
@MODULE[ModuleDataTransmitter] @MODULE[ModuleDataTransmitter]
{ {
@name = ModuleLimitedDataTransmitter @name = ModuleLimitedDataTransmitter
nominalRange = 80000000000 @packetResourceCost /= 1.414213
maxPowerFactor = 8 nominalRange = 9250000000
maxDataFactor = 4 simpleRange = 56250000000
  maxPowerFactor = 16
  maxDataFactor = 2
} }
   
MODULE MODULE
{ {
name = ModuleScienceContainer name = ModuleScienceContainer
   
dataIsCollectable = true dataIsCollectable = true
dataIsStorable = false dataIsStorable = false
   
storageRange = 2 storageRange = 2
} }
} }
   
  @PART[HighGainAntenna]:FOR[AntennaRange]:NEEDS[!RemoteTech]
  {
  @TechRequired = electronics
  @description = Repurposed for medium range probes, the HG-55 provdes high speed directional data transmission.
   
  @MODULE[ModuleDataTransmitter]
  {
  @name = ModuleLimitedDataTransmitter
  nominalRange = 7774867578
  simpleRange = 25030376544
  maxPowerFactor = 2.6180339887498948
  maxDataFactor = 9
  }
   
  MODULE
  {
  name = ModuleScienceContainer
   
  dataIsCollectable = true
  dataIsStorable = false
   
  storageRange = 2
  }
  }
   
  TRACKING_STATION_RANGES
  {
  range = 800000
  range = 200000000000
  range = 2000000000000
  }
   
EVA_MODULE EVA_MODULE
{ {
name = ModuleLimitedDataTransmitter name = ModuleLimitedDataTransmitter
   
nominalRange = 5000 nominalRange = 1389
  simpleRange = 5000
maxPowerFactor = 1 maxPowerFactor = 1
maxDataFactor = 1 maxDataFactor = 1
   
packetInterval = 0.2 packetInterval = 0.2
packetSize = 1 packetSize = 1
packetResourceCost = 6.25 packetResourceCost = 6.25
   
requiredResource = ElectricCharge requiredResource = ElectricCharge
} }
   
EVA_RESOURCE EVA_RESOURCE
{ {
name = ElectricCharge name = ElectricCharge
amount = 100 amount = 0
maxAmount = 100 maxAmount = 100
} }
   
@EVA_RESOURCE[ElectricCharge]:AFTER[AntennaRange]:NEEDS[TacLifeSupport] @EVA_RESOURCE[ElectricCharge]:AFTER[AntennaRange]:NEEDS[TacLifeSupport]
{ {
!name = DELETE !name = DELETE
} }
   
 Binary files a/GameData/AntennaRange/Textures/appLauncherIcon.png and b/GameData/AntennaRange/Textures/appLauncherIcon.png differ
 Binary files a/GameData/AntennaRange/Textures/appLauncherIconNoConnection.png and b/GameData/AntennaRange/Textures/appLauncherIconNoConnection.png differ
 Binary files a/GameData/AntennaRange/Textures/appLauncherIconSubOptimal.png and b/GameData/AntennaRange/Textures/appLauncherIconSubOptimal.png differ
 Binary files a/GameData/AntennaRange/Textures/toolbarIcon.png and b/GameData/AntennaRange/Textures/toolbarIcon.png differ
 Binary files a/GameData/AntennaRange/Textures/toolbarIconNoConnection.png and b/GameData/AntennaRange/Textures/toolbarIconNoConnection.png differ
 Binary files a/GameData/AntennaRange/Textures/toolbarIconSubOptimal.png and b/GameData/AntennaRange/Textures/toolbarIconSubOptimal.png differ
// AntennaRange // AntennaRange
// //
// IAntennaRelay.cs // IAntennaRelay.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
using KSP; using KSP;
using System; using System;
   
namespace AntennaRange namespace AntennaRange
{ {
/* /// <summary>
* Interface defining the basic functionality of AntennaRelay modules for AntennaRange. /// Interface defining the basic functionality of AntennaRelay modules for AntennaRange.
* */ /// </summary>
public interface IAntennaRelay public interface IAntennaRelay
{ {
/// <summary> /// <summary>
/// Gets the parent Vessel. /// Gets the parent Vessel.
/// </summary> /// </summary>
/// <value>The parent Vessel.</value>  
Vessel vessel { get; } Vessel vessel { get; }
   
IAntennaRelay nearestRelay { get; } /// <summary>
  /// Gets the target <see cref="AntennaRange.IAntennaRelay"/>relay.
IAntennaRelay bestOccludedRelay { get; } /// </summary>
   
IAntennaRelay targetRelay { get; } IAntennaRelay targetRelay { get; }
   
/// <summary> /// <summary>
/// Gets the distance to the nearest relay or Kerbin, whichever is closer. /// Gets or sets the data capacity of a packet, in MiT/packet
/// </summary> /// </summary>
/// <value>The distance to the nearest relay or Kerbin, whichever is closer.</value> /// <value>The data capacity of a packet, in MiT/packet</value>
double transmitDistance { get; } float PacketSize { get; set; }
   
double nominalTransmitDistance { get; }  
   
/// <summary> /// <summary>
/// The maximum distance at which this relay can operate. /// Gets the base data capacity of a packet, in MiT/packet
/// </summary> /// </summary>
/// <value>The max transmit distance.</value> /// <value>The base data capacity of a packet, in MiT/packet</value>
float maxTransmitDistance { get; } float BasePacketSize { get; }
   
/// <summary> /// <summary>
/// The first CelestialBody blocking line of sight to a /// Gets or sets the resource cost of a packet, in EC/packet
/// </summary> /// </summary>
/// <value>The first occluding body.</value> /// <value>The resource cost of a packet, in EC/packet</value>
CelestialBody firstOccludingBody { get; } float PacketResourceCost { get; set; }
   
  /// <summary>
  /// Gets the base resource cost of a packet, in EC/packet
  /// </summary>
  /// <value>The base resource cost of a packet, in EC/packet</value>
  float BasePacketResourceCost { get; }
   
  /// <summary>
  /// Gets the packet throttle.
  /// </summary>
  /// <value>The packet throttle in range [0..100].</value>
  float PacketThrottle { get; }
   
  /// <summary>
  /// Gets the max data factor.
  /// </summary>
  /// <value>The max data factor.</value>
  float MaxDataFactor { get; }
   
  /// <summary>
  /// Gets the data resource cost in EC/MiT.
  /// </summary>
  /// <value>The data resource cost in EC/MiT.</value>
  double DataResourceCost { get; }
   
  /// <summary>
  /// Gets the current network resource rate in EC/MiT.
  /// </summary>
  /// <value>The current network resource rate in EC/MiT.</value>
  RelayDataCost CurrentNetworkLinkCost { get; }
   
/// <summary> /// <summary>
/// Gets a value indicating whether this <see cref="AntennaRange.IAntennaRelay"/> Relay is communicating /// Gets a value indicating whether this <see cref="AntennaRange.IAntennaRelay"/> Relay is communicating
/// directly with Kerbin. /// directly with Kerbin.
/// </summary> /// </summary>
bool KerbinDirect { get; } bool KerbinDirect { get; }
   
/// <summary> /// <summary>
  /// The link distance, in meters, at which this relay behaves nominally.
  /// </summary>
  double NominalLinkSqrDistance { get; }
   
  /// <summary>
  /// The link distance, in meters, beyond which this relay cannot operate.
  /// </summary>
  double MaximumLinkSqrDistance { get; }
   
  /// <summary>
  /// Gets the distance to the nearest relay or Kerbin, whichever is closer.
  /// </summary>
  double CurrentLinkSqrDistance { get; }
   
  /// <summary>
  /// Gets the link status.
  /// </summary>
  ConnectionStatus LinkStatus { get; }
   
  /// <summary>
  /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config.
  /// </summary>
  double nominalTransmitDistance { get; }
   
  /// <summary>
  /// The maximum distance at which this relay can operate.
  /// </summary>
  double maxTransmitDistance { get; }
   
  /// <summary>
  /// The first CelestialBody blocking line of sight to a
  /// </summary>
  CelestialBody firstOccludingBody { get; }
   
  /// <summary>
  /// Gets the Part title.
  /// </summary>
  string Title { get; }
   
  /// <summary>
/// Determines whether this instance can transmit. /// Determines whether this instance can transmit.
  /// <c>true</c> if this instance can transmit; otherwise, <c>false</c>.
/// </summary> /// </summary>
/// <returns><c>true</c> if this instance can transmit; otherwise, <c>false</c>.</returns>  
bool CanTransmit(); bool CanTransmit();
   
  /// <summary>
  /// Recalculates the transmission rates.
  /// </summary>
  void RecalculateTransmissionRates();
   
  /// <summary>
  /// Finds the nearest relay.
  /// </summary>
  void FindNearestRelay();
   
  /// <summary>
  /// Recalculates the max range; useful for making sure we're using additive ranges when enabled.
  /// </summary>
  void RecalculateMaxRange();
   
  /// <summary>
  /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.IAntennaRelay"/>.
  /// </summary>
string ToString(); string ToString();
   
string Title { get; }  
} }
} }
   
   
// AntennaRange // AntennaRange
// //
// ModuleLimitedDataTransmitter.cs // ModuleLimitedDataTransmitter.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
using KSP; using KSP;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;  
using System.Text; using System.Text;
using ToadicusTools; using ToadicusTools.DebugTools;
  using ToadicusTools.Extensions;
  using ToadicusTools.Text;
using UnityEngine; using UnityEngine;
   
namespace AntennaRange namespace AntennaRange
{ {
/* /// <summary>
* ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles range- /// <para>ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles
* finding, power scaling, and data scaling for antennas during science transmission. Its functionality varies with /// rangefinding, power scaling, and data scaling for antennas during science transmission. Its functionality
* three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files. /// varies with three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files.</para>
* ///
* In general, the scaling functions assume the following relation: /// <para>In general, the scaling functions assume the following relation:</para>
* ///
* D² α P/R, /// <para> D² α P/R,</para>
* ///
* where D is the total transmission distance, P is the transmission power, and R is the data rate. /// <para>where D is the total transmission distance, P is the transmission power, and R is the data rate.</para>
* /// </summary>
* */ public class ModuleLimitedDataTransmitter
  : ModuleDataTransmitter, IScienceDataTransmitter, IAntennaRelay, IModuleInfo
/*  
* Fields  
* */  
public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter, IAntennaRelay  
{ {
// Stores the packetResourceCost as defined in the .cfg file. private const string tooltipSkinName = "PartTooltipSkin";
protected float _basepacketResourceCost; private static GUISkin partTooltipSkin;
  private static GUIStyle partTooltipBodyStyle;
// Stores the packetSize as defined in the .cfg file. private static GUIStyle partTooltipHeaderStyle;
protected float _basepacketSize;  
   
// Every antenna is a relay. // Every antenna is a relay.
protected AntennaRelay relay; private AntennaRelay relay;
   
// Keep track of vessels with transmitters for relay purposes.  
protected List<Vessel> _relayVessels;  
   
// Sometimes we will need to communicate errors; this is how we do it. // Sometimes we will need to communicate errors; this is how we do it.
protected ScreenMessage ErrorMsg; private ScreenMessage ErrorMsg;
   
// The distance from Kerbin at which the antenna will perform exactly as prescribed by packetResourceCost // Used in module info panes for part tooltips in the editor and R&D
// and packetSize. private GUIContent moduleInfoContent;
   
  /// <summary>
  /// When additive ranges are enabled, the distance from Kerbin at which the antenna will perform exactly as
  /// prescribed by packetResourceCost and packetSize.
  /// </summary>
[KSPField(isPersistant = false)] [KSPField(isPersistant = false)]
public float nominalRange; public double nominalRange;
   
  /// <summary>
  /// When additive ranges are disabled, the distance from Kerbin at which the antenna will perform exactly as
  /// prescribed by packetResourceCost and packetSize.
  /// </summary>
  [KSPField(isPersistant = false)]
  public double simpleRange;
   
  /// <summary>
  /// Relay status string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Status")] [KSPField(isPersistant = false, guiActive = true, guiName = "Status")]
public string UIrelayStatus; public string UIrelayStatus;
   
  /// <summary>
  /// Relay target string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Relay")] [KSPField(isPersistant = false, guiActive = true, guiName = "Relay")]
public string UIrelayTarget; public string UIrelayTarget;
   
  /// <summary>
  /// Transmit distance string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Transmission Distance")] [KSPField(isPersistant = false, guiActive = true, guiName = "Transmission Distance")]
public string UItransmitDistance; public string UItransmitDistance;
   
[KSPField(isPersistant = false, guiActive = true, guiName = "Maximum Distance")] /// <summary>
  /// The nominal range string for use in action menus.
  /// </summary>
  [KSPField(isPersistant = false, guiActive = true, guiName = "Nominal Range")]
  public string UInominalLinkDistance;
   
  /// <summary>
  /// Maximum distance string for use in action menus.
  /// </summary>
  [KSPField(isPersistant = false, guiActive = true, guiName = "Maximum Range")]
public string UImaxTransmitDistance; public string UImaxTransmitDistance;
   
  /// <summary>
  /// Packet size string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Packet Size")] [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Size")]
public string UIpacketSize; public string UIpacketSize;
   
  /// <summary>
  /// Packet cost string for use in action menus.
  /// </summary>
[KSPField(isPersistant = false, guiActive = true, guiName = "Packet Cost")] [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Cost")]
public string UIpacketCost; public string UIpacketCost;
   
// The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the power /// <summary>
// cost exceeds packetResourceCost * maxPowerFactor, transmission will fail. /// The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the power
  /// cost exceeds packetResourceCost * maxPowerFactor, transmission will fail.
  /// </summary>
[KSPField(isPersistant = false)] [KSPField(isPersistant = false)]
public float maxPowerFactor; public float maxPowerFactor;
   
// The multipler on packetSize that defines the maximum data bandwidth of the antenna. /// <summary>
  /// The multipler on packetSize that defines the maximum data bandwidth of the antenna.
  /// </summary>
[KSPField(isPersistant = false)] [KSPField(isPersistant = false)]
public float maxDataFactor; public float maxDataFactor;
   
  /// <summary>
  /// The packet throttle.
  /// </summary>
[KSPField( [KSPField(
isPersistant = true, isPersistant = true,
guiName = "Packet Throttle", guiName = "Packet Throttle",
guiUnits = "%", guiUnits = "%",
guiActive = true, guiActive = true,
guiActiveEditor = false guiActiveEditor = false
)] )]
[UI_FloatRange(maxValue = 100f, minValue = 2.5f, stepIncrement = 2.5f)] [UI_FloatRange(maxValue = 100f, minValue = 2.5f, stepIncrement = 2.5f)]
public float packetThrottle; public float packetThrottle;
   
protected bool actionUIUpdate; private bool actionUIUpdate;
   
/* /*
* Properties * Properties
* */ * */
// Returns the parent vessel housing this antenna. /// <summary>
  /// Gets the parent Vessel.
  /// </summary>
public new Vessel vessel public new Vessel vessel
{ {
get get
{ {
if (base.vessel != null) if (base.vessel != null)
{ {
return base.vessel; return base.vessel;
} }
else if (this.part != null) else if (this.part != null && this.part.vessel != null)
{ {
return this.part.vessel; return this.part.vessel;
} }
  else if (
  this.part.protoPartSnapshot != null &&
  this.part.protoPartSnapshot.pVesselRef != null &&
  this.part.protoPartSnapshot.pVesselRef.vesselRef != null
  )
  {
  return this.part.protoPartSnapshot.pVesselRef.vesselRef;
  }
else else
{ {
  this.LogError("Vessel and/or part reference are null, returning null vessel.");
  #if DEBUG && VERBOSE
  this.LogError(new System.Diagnostics.StackTrace().ToString());
  #endif
return null; return null;
} }
} }
} }
   
public IAntennaRelay nearestRelay /// <summary>
  /// Gets or sets the data capacity of a packet, in MiT/packet
  /// </summary>
  /// <value>The data capacity of a packet, in MiT/packet</value>
  public float PacketSize
  {
  get
  {
  return this.packetSize;
  }
  set
  {
  this.packetSize = value;
  }
  }
   
  /// <summary>
  /// Gets the base data capacity of a packet, in MiT/packet
  /// </summary>
  /// <value>The base data capacity of a packet, in MiT/packet</value>
  public float BasePacketSize
  {
  get;
  private set;
  }
   
  /// <summary>
  /// Gets or sets the resource cost of a packet, in EC/packet
  /// </summary>
  /// <value>The resource cost of a packet, in EC/packet</value>
  public float PacketResourceCost
  {
  get
  {
  return this.packetResourceCost;
  }
  set
  {
  this.packetResourceCost = value;
  }
  }
   
  /// <summary>
  /// Gets the base resource cost of a packet, in EC/packet
  /// </summary>
  /// <value>The base resource cost of a packet, in EC/packet</value>
  public float BasePacketResourceCost
  {
  get;
  private set;
  }
   
  /// <summary>
  /// Gets the packet throttle.
  /// </summary>
  /// <value>The packet throttle in range [0..100].</value>
  public float PacketThrottle
  {
  get
  {
  return this.packetThrottle;
  }
  }
   
  /// <summary>
  /// Gets the max data factor.
  /// </summary>
  /// <value>The max data factor.</value>
  public float MaxDataFactor
  {
  get
  {
  return this.maxDataFactor;
  }
  }
   
  /// <summary>
  /// Gets the target <see cref="AntennaRange.IAntennaRelay"/>relay.
  /// </summary>
  public IAntennaRelay targetRelay
{ {
get get
{ {
if (this.relay == null) if (this.relay == null)
{ {
return null; return null;
} }
   
return this.relay.nearestRelay; return this.relay.targetRelay;
} }
} }
   
public IAntennaRelay bestOccludedRelay /// <summary>
  /// Gets a value indicating whether this <see cref="AntennaRange.IAntennaRelay"/> Relay is communicating
  /// directly with Kerbin.
  /// </summary>
  public bool KerbinDirect
  {
  get
  {
  if (this.relay != null)
  {
  return this.relay.KerbinDirect;
  }
   
  return false;
  }
  }
   
  /// <summary>
  /// Gets or sets the nominal link distance, in meters.
  /// </summary>
  public double NominalLinkSqrDistance
  {
  get
  {
  if (this.relay != null)
  {
  return this.relay.NominalLinkSqrDistance;
  }
   
  return 0d;
  }
  }
   
  /// <summary>
  /// Gets or sets the maximum link distance, in meters.
  /// </summary>
  public double MaximumLinkSqrDistance
  {
  get
  {
  if (this.relay != null)
  {
  return this.relay.MaximumLinkSqrDistance;
  }
   
  return 0d;
  }
  }
   
  /// <summary>
  /// Gets the distance to the nearest relay or Kerbin, whichever is closer.
  /// </summary>
  public double CurrentLinkSqrDistance
{ {
get get
{ {
if (this.relay == null) if (this.relay == null)
{ {
return null; return double.PositiveInfinity;
} }
   
return this.relay.bestOccludedRelay; return this.relay.CurrentLinkSqrDistance;
} }
} }
   
public IAntennaRelay targetRelay /// <summary>
  /// Gets the link status.
  /// </summary>
  public ConnectionStatus LinkStatus
{ {
get get
{ {
if (this.relay == null) if (this.relay == null)
{ {
return null; return ConnectionStatus.None;
} }
   
return this.relay.targetRelay; return this.relay.LinkStatus;
} }
} }
   
// Returns the distance to the nearest relay or Kerbin, whichever is closer. /// <summary>
public double transmitDistance /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config.
{ /// </summary>
get  
{  
if (this.relay == null)  
{  
return double.PositiveInfinity;  
}  
   
return this.relay.transmitDistance;  
}  
}  
   
public double nominalTransmitDistance public double nominalTransmitDistance
{ {
get get
{ {
return this.nominalRange; if (ARConfiguration.UseAdditiveRanges)
} {
} return this.nominalRange;
  }
// Returns the maximum distance this module can transmit else
public float maxTransmitDistance {
{ return this.simpleRange;
get }
{ }
// TODO: Cache this in a way that doesn't break everything. }
return Mathf.Sqrt(this.maxPowerFactor) * this.nominalRange;  
} /// <summary>
} /// The maximum distance at which this relay can operate.
  /// </summary>
  public double maxTransmitDistance
  {
  get;
  protected set;
  }
   
  /// <summary>
  /// The first CelestialBody blocking line of sight to a
  /// </summary>
public CelestialBody firstOccludingBody public CelestialBody firstOccludingBody
{ {
get get
{ {
return this.relay.firstOccludingBody; return this.relay.firstOccludingBody;
} }
} }
   
/* /*
* The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except * The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except
* in that they both return floats. Here's some quick justification: * in that they both return floats. Here's some quick justification:
* *
* The stock implementation of GetTransmitterScore (which I cannot override) is: * The stock implementation of GetTransmitterScore (which I cannot override) is:
* Score = (1 + DataResourceCost) / DataRate * Score = (1 + DataResourceCost) / DataRate
* *
* The stock DataRate and DataResourceCost are: * The stock DataRate and DataResourceCost are:
* DataRate = packetSize / packetInterval * DataRate = packetSize / packetInterval
* DataResourceCost = packetResourceCost / packetSize * DataResourceCost = packetResourceCost / packetSize
* *
* So, the resulting score is essentially in terms of joules per byte per baud. Rearranging that a bit, it * So, the resulting score is essentially in terms of joules per byte per baud. Rearranging that a bit, it
* could also look like joule-seconds per byte per byte, or newton-meter-seconds per byte per byte. Either way, * could also look like joule-seconds per byte per byte, or newton-meter-seconds per byte per byte. Either way,
* that metric is not a very reasonable one. * that metric is not a very reasonable one.
* *
* Two metrics that might make more sense are joules per byte or joules per byte per second. The latter case * Two metrics that might make more sense are joules per byte or joules per byte per second. The latter case
* would look like: * would look like:
* DataRate = packetSize / packetInterval * DataRate = packetSize / packetInterval
* DataResourceCost = packetResourceCost * DataResourceCost = packetResourceCost
* *
* The former case, which I've chosen to implement below, is: * The former case, which I've chosen to implement below, is:
* DataRate = packetSize * DataRate = packetSize
* DataResourceCost = packetResourceCost * DataResourceCost = packetResourceCost
* *
* So... hopefully that doesn't screw with anything else. * So... hopefully that doesn't screw with anything else.
* */ * */
// Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in /// <summary>
// terms of joules/byte /// Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in
  /// terms of joules/byte
  /// </summary>
public new float DataRate public new float DataRate
{ {
get get
{ {
this.PreTransmit_SetPacketSize(); if (this.relay == null)
   
if (this.CanTransmit())  
{  
return this.packetSize;  
}  
else  
{  
return float.Epsilon;  
}  
}  
}  
   
// Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas  
// to be scored in terms of joules/byte  
public new float DataResourceCost  
{  
get  
{  
this.PreTransmit_SetPacketResourceCost();  
   
if (this.CanTransmit())  
{  
return this.packetResourceCost;  
}  
else  
{ {
return float.PositiveInfinity; return float.PositiveInfinity;
} }
}  
} return this.relay.DataRate;
  }
public bool KerbinDirect }
{  
get /// <summary>
{ /// Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas
if (this.relay != null) /// to be scored in terms of joules/byte
{ /// </summary>
return this.relay.KerbinDirect; public new double DataResourceCost
} {
  get
return false; {
} if (this.relay == null)
} {
  return double.PositiveInfinity;
  }
   
  return this.relay.DataResourceCost;
  }
  }
   
  /// <summary>
  /// Gets the current network resource rate in EC/MiT.
  /// </summary>
  /// <value>The current network resource rate in EC/MiT.</value>
  public RelayDataCost CurrentNetworkLinkCost
  {
  get
  {
  if (this.relay == null)
  {
  return RelayDataCost.Infinity;
  }
   
  return this.relay.CurrentNetworkLinkCost;
  }
  }
   
  /// <summary>
  /// Gets the Part title.
  /// </summary>
public string Title public string Title
{ {
get get
{ {
if (this.part != null && this.part.partInfo != null) if (this.part != null && this.part.partInfo != null)
{ {
return this.part.partInfo.title; return this.part.partInfo.title;
} }
   
return string.Empty; return string.Empty;
} }
} }
   
/* /*
* Methods * Methods
* */ * */
// Build ALL the objects. // Build ALL the objects.
public ModuleLimitedDataTransmitter () : base() public ModuleLimitedDataTransmitter () : base()
{ {
this.ErrorMsg = new ScreenMessage("", 4f, false, ScreenMessageStyle.UPPER_LEFT); this.ErrorMsg = new ScreenMessage("", 4f, ScreenMessageStyle.UPPER_LEFT);
this.packetThrottle = 100f; this.packetThrottle = 100f;
} }
   
  /// <summary>
  /// PartModule OnAwake override; runs at Unity Awake.
  /// </summary>
public override void OnAwake() public override void OnAwake()
{ {
base.OnAwake(); base.OnAwake();
   
this._basepacketSize = base.packetSize; this.BasePacketSize = base.packetSize;
this._basepacketResourceCost = base.packetResourceCost; this.BasePacketResourceCost = base.packetResourceCost;
  this.moduleInfoContent = new GUIContent();
Tools.PostDebugMessage(string.Format(  
"{0} loaded:\n" + this.LogDebug("{0} loaded:\n" +
"packetSize: {1}\n" + "packetSize: {1}\n" +
"packetResourceCost: {2}\n" + "packetResourceCost: {2}\n" +
"nominalRange: {3}\n" + "nominalTransmitDistance: {3}\n" +
"maxPowerFactor: {4}\n" + "maxPowerFactor: {4}\n" +
"maxDataFactor: {5}\n", "maxDataFactor: {5}\n",
this.name, this,
base.packetSize, base.packetSize,
this._basepacketResourceCost, this.BasePacketResourceCost,
this.nominalRange, this.nominalTransmitDistance,
this.maxPowerFactor, this.maxPowerFactor,
this.maxDataFactor this.maxDataFactor
)); );
} }
   
// At least once, when the module starts with a state on the launch pad or later, go find Kerbin. /// <summary>
  /// PartModule OnStart override; runs at Unity Start.
  /// </summary>
  /// <param name="state">State.</param>
public override void OnStart (StartState state) public override void OnStart (StartState state)
{ {
base.OnStart (state); base.OnStart (state);
   
  this.RecalculateMaxRange();
   
if (state >= StartState.PreLaunch) if (state >= StartState.PreLaunch)
{ {
this.relay = new AntennaRelay(this); this.relay = new AntennaRelay(this);
  this.relay.nominalTransmitDistance = this.nominalTransmitDistance;
this.relay.maxTransmitDistance = this.maxTransmitDistance; this.relay.maxTransmitDistance = this.maxTransmitDistance;
this.relay.nominalTransmitDistance = this.nominalRange;  
  this.UImaxTransmitDistance = TextTools.Format("{0:S3}m", this.maxTransmitDistance);
this.UImaxTransmitDistance = Tools.MuMech_ToSI(this.maxTransmitDistance) + "m";  
   
GameEvents.onPartActionUICreate.Add(this.onPartActionUICreate); GameEvents.onPartActionUICreate.Add(this.onPartActionUICreate);
GameEvents.onPartActionUIDismiss.Add(this.onPartActionUIDismiss); GameEvents.onPartActionUIDismiss.Add(this.onPartActionUIDismiss);
} }
} }
   
// When the module loads, fetch the Squad KSPFields from the base. This is necessary in part because /// <summary>
// overloading packetSize and packetResourceCostinto a property in ModuleLimitedDataTransmitter didn't /// When the module loads, fetch the Squad KSPFields from the base. This is necessary in part because
// work. /// overloading packetSize and packetResourceCostinto a property in ModuleLimitedDataTransmitter didn't
  /// work.
  /// </summary>
  /// <param name="node"><see cref="ConfigNode"/> with data for this module.</param>
public override void OnLoad(ConfigNode node) public override void OnLoad(ConfigNode node)
{ {
this.Fields.Load(node); this.Fields.Load(node);
base.Fields.Load(node); base.Fields.Load(node);
   
base.OnLoad (node); base.OnLoad (node);
}  
  this.RecalculateMaxRange();
// Post an error in the communication messages describing the reason transmission has failed. Currently there }
// is only one reason for this.  
protected void PostCannotTransmitError() /// <summary>
{ /// Gets the human-friendly module title.
string ErrorText = string.Intern("Unable to transmit: no visible receivers in range!"); /// </summary>
  public string GetModuleTitle()
this.ErrorMsg.message = string.Format( {
"<color='#{0}{1}{2}{3}'><b>{4}</b></color>", return "Comms Transceiver";
((int)(XKCDColors.OrangeRed.r * 255f)).ToString("x2"), }
((int)(XKCDColors.OrangeRed.g * 255f)).ToString("x2"),  
((int)(XKCDColors.OrangeRed.b * 255f)).ToString("x2"), /// <summary>
((int)(XKCDColors.OrangeRed.a * 255f)).ToString("x2"), /// Returns drawTooltipWidget as a callback for part tooltips.
ErrorText /// </summary>
  public Callback<Rect> GetDrawModulePanelCallback()
  {
  return this.drawTooltipWidget;
  }
   
  // Called by Squad's part tooltip system when drawing tooltips.
  // HACK: Currently hacks around Squad's extraneous layout box, see KSPModders issue #5118
  private void drawTooltipWidget(Rect rect)
  {
  this.moduleInfoContent.text = this.GetInfo();
   
  if (partTooltipSkin == null)
  {
  UnityEngine.Object[] skins = Resources.FindObjectsOfTypeAll(typeof(GUISkin));
  GUISkin skin;
  for (int sIdx = 0; sIdx < skins.Length; sIdx++)
  {
  skin = (GUISkin)skins[sIdx];
   
  if (skin.name == tooltipSkinName)
  {
  partTooltipSkin = skin;
  partTooltipBodyStyle = partTooltipSkin.customStyles[0];
  partTooltipHeaderStyle = partTooltipSkin.customStyles[1];
  }
  }
   
  if (partTooltipSkin == null)
  {
  this.LogError("Could not find GUISkin {0}? Please report this!", tooltipSkinName);
  return;
  }
  else
  {
  this.Log("Loaded GUISkin {0}", tooltipSkinName);
  }
  }
   
  float width = rect.width;
  float orgHeight = rect.height;
  float height = partTooltipBodyStyle.CalcHeight(this.moduleInfoContent, width);
   
  rect.height = height;
   
  GUI.Box(rect, this.moduleInfoContent, partTooltipBodyStyle);
  GUI.Label(rect, this.GetModuleTitle(), partTooltipHeaderStyle);
   
  GUILayout.Space(height - orgHeight
  - partTooltipBodyStyle.padding.bottom - partTooltipBodyStyle.padding.top
  - 2f * (partTooltipBodyStyle.margin.bottom + partTooltipBodyStyle.margin.top)
); );
  }
Tools.PostDebugMessage(this.GetType().Name + ": " + this.ErrorMsg.message);  
  /// <summary>
ScreenMessages.PostScreenMessage(this.ErrorMsg, false); /// Returns an empty string, because we don't really have a "primary field" like some modules do.
} /// </summary>
  public string GetPrimaryField()
// Before transmission, set packetResourceCost. Per above, packet cost increases with the square of {
// distance. packetResourceCost maxes out at _basepacketResourceCost * maxPowerFactor, at which point return string.Empty;
// transmission fails (see CanTransmit). }
protected void PreTransmit_SetPacketResourceCost()  
{ /// <summary>
if (ARConfiguration.FixedPowerCost || this.transmitDistance <= this.nominalRange) /// Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description.
{ /// </summary>
base.packetResourceCost = this._basepacketResourceCost; public override string GetInfo()
  {
  using (PooledStringBuilder sb = PooledStringBuilder.Get())
  {
  string text;
   
  sb.Append(base.GetInfo());
   
  if (ARConfiguration.UseAdditiveRanges)
  {
  sb.AppendFormat("Nominal Range to Kerbin: {0:S3}m\n",
  Math.Sqrt(this.nominalTransmitDistance * ARConfiguration.KerbinNominalRange)
  );
  sb.AppendFormat("Maximum Range to Kerbin: {0:S3}m",
  Math.Sqrt(
  this.nominalTransmitDistance * Math.Sqrt(this.maxPowerFactor) *
  ARConfiguration.KerbinRelayRange
  )
  );
  }
  else
  {
  sb.AppendFormat("Nominal Range: {0:S3}m\n", this.nominalTransmitDistance);
  sb.AppendFormat("Maximum Range: {0:S3}m", this.maxTransmitDistance);
  }
   
  text = sb.ToString();
   
  return text;
  }
  }
   
  /// <summary>
  /// Determines whether this instance can transmit.
  /// <c>true</c> if this instance can transmit; otherwise, <c>false</c>.
  /// </summary>
  public new bool CanTransmit()
  {
  if (this.part == null || this.relay == null)
  {
  return false;
  }
   
  switch (this.part.State)
  {
  case PartStates.DEAD:
  case PartStates.DEACTIVATED:
  this.LogDebug(
  "{0}: {1} on {2} cannot transmit: {3}",
  this.GetType().Name,
  this.part.partInfo.title,
  this.vessel.vesselName,
  Enum.GetName(typeof(PartStates), this.part.State)
  );
  return false;
  default:
  break;
  }
   
  return this.relay.CanTransmit();
  }
   
  /// <summary>
  /// Recalculates the transmission rates.
  /// </summary>
  public void RecalculateTransmissionRates()
  {
  if (this.relay != null)
  {
  this.relay.RecalculateTransmissionRates();
  }
  }
   
  /// <summary>
  /// Finds the nearest relay.
  /// </summary>
  public void FindNearestRelay()
  {
  if (this.relay != null)
  {
  this.relay.FindNearestRelay();
  }
  }
   
  /// <summary>
  /// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit
  /// returns false.
  /// </summary>
  /// <param name="dataQueue">List of <see cref="ScienceData"/> to transmit.</param>
  public new void TransmitData(List<ScienceData> dataQueue)
  {
  this.LogDebug(
  "TransmitData(List<ScienceData> dataQueue, Callback callback) called. dataQueue.Count={0}",
  dataQueue.Count
  );
   
  if (this.CanTransmit())
  {
  ScreenMessages.PostScreenMessage(this.buildTransmitMessage(), 4f, ScreenMessageStyle.UPPER_LEFT);
   
  this.LogDebug(
  "CanTransmit in TransmitData, calling base.TransmitData with dataQueue=[{0}] and callback={1}",
  dataQueue.SPrint()
  );
   
  base.TransmitData(dataQueue);
} }
else else
{ {
double rangeFactor = (this.transmitDistance / this.nominalRange); this.LogDebug("{0} unable to transmit during TransmitData.", this.part.partInfo.title);
rangeFactor *= rangeFactor;  
  var logger = PooledDebugLogger.New(this);
base.packetResourceCost = this._basepacketResourceCost  
* (float)rangeFactor; IList<ModuleScienceContainer> vesselContainers = this.vessel.getModulesOfType<ModuleScienceContainer>();
  ModuleScienceContainer scienceContainer;
Tools.PostDebugMessage( for (int cIdx = 0; cIdx < vesselContainers.Count; cIdx++)
this, {
"Pretransmit: packet cost set to {0} before throttle (rangeFactor = {1}).", scienceContainer = vesselContainers[cIdx];
base.packetResourceCost,  
rangeFactor);  
}  
   
base.packetResourceCost *= this.packetThrottle / 100f;  
}  
   
// Before transmission, set packetSize. Per above, packet size increases with the inverse square of  
// distance. packetSize maxes out at _basepacketSize * maxDataFactor.  
protected void PreTransmit_SetPacketSize()  
{  
if (!ARConfiguration.FixedPowerCost && this.transmitDistance >= this.nominalRange)  
{  
base.packetSize = this._basepacketSize;  
}  
else  
{  
double rangeFactor = (this.nominalRange / this.transmitDistance);  
rangeFactor *= rangeFactor;  
   
base.packetSize = Math.Min(  
this._basepacketSize * (float)rangeFactor,  
this._basepacketSize * this.maxDataFactor);  
   
Tools.PostDebugMessage(  
this,  
"Pretransmit: packet size set to {0} before throttle (rangeFactor = {1}).",  
base.packetSize,  
rangeFactor);  
}  
   
base.packetSize *= this.packetThrottle / 100f;  
}  
   
// Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description.  
public override string GetInfo()  
{  
string text = base.GetInfo();  
text += "Nominal Range: " + Tools.MuMech_ToSI((double)this.nominalRange, 2) + "m\n";  
text += "Maximum Range: " + Tools.MuMech_ToSI((double)this.maxTransmitDistance, 2) + "m\n";  
return text;  
}  
   
// Override ModuleDataTransmitter.CanTransmit to return false when transmission is not possible.  
public new bool CanTransmit()  
{  
if (this.part == null || this.relay == null)  
{  
return false;  
}  
   
PartStates partState = this.part.State;  
if (partState == PartStates.DEAD || partState == PartStates.DEACTIVATED)  
{  
Tools.PostDebugMessage(string.Format(  
"{0}: {1} on {2} cannot transmit: {3}",  
this.GetType().Name,  
this.part.partInfo.title,  
this.vessel.vesselName,  
Enum.GetName(typeof(PartStates), partState)  
));  
return false;  
}  
return this.relay.CanTransmit();  
}  
   
// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit  
// returns false.  
public new void TransmitData(List<ScienceData> dataQueue)  
{  
this.PreTransmit_SetPacketSize();  
this.PreTransmit_SetPacketResourceCost();  
   
if (this.CanTransmit())  
{  
StringBuilder message = new StringBuilder();  
   
message.Append("[");  
message.Append(base.part.partInfo.title);  
message.Append("]: ");  
   
message.Append("Beginning transmission ");  
   
if (this.KerbinDirect)  
{  
message.Append("directly to Kerbin.");  
}  
else  
{  
message.Append("via ");  
message.Append(this.relay.targetRelay);  
}  
   
ScreenMessages.PostScreenMessage(message.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);  
   
base.TransmitData(dataQueue);  
}  
else  
{  
Tools.PostDebugMessage(this, "{0} unable to transmit during TransmitData.", this.part.partInfo.title);  
   
var logger = Tools.DebugLogger.New(this);  
   
foreach (ModuleScienceContainer scienceContainer in this.vessel.getModulesOfType<ModuleScienceContainer>())  
{  
logger.AppendFormat("Checking ModuleScienceContainer in {0}\n", logger.AppendFormat("Checking ModuleScienceContainer in {0}\n",
scienceContainer.part.partInfo.title); scienceContainer.part.partInfo.title);
   
if ( if (
scienceContainer.capacity != 0 && scienceContainer.capacity != 0 &&
scienceContainer.GetScienceCount() >= scienceContainer.capacity scienceContainer.GetScienceCount() >= scienceContainer.capacity
) )
{ {
logger.Append("\tInsufficient capacity, skipping.\n"); logger.Append("\tInsufficient capacity, skipping.\n");
continue; continue;
} }
   
List<ScienceData> dataStored = new List<ScienceData>(); List<ScienceData> dataStored = new List<ScienceData>();
   
foreach (ScienceData data in dataQueue) ScienceData data;
  for (int dIdx = 0; dIdx < dataQueue.Count; dIdx++)
{ {
  data = dataQueue[dIdx];
if (!scienceContainer.allowRepeatedSubjects && scienceContainer.HasData(data)) if (!scienceContainer.allowRepeatedSubjects && scienceContainer.HasData(data))
{ {
logger.Append("\tAlready contains subject and repeated subjects not allowed, skipping.\n"); logger.Append("\tAlready contains subject and repeated subjects not allowed, skipping.\n");
continue; continue;
} }
   
logger.AppendFormat("\tAcceptable, adding data on subject {0}... ", data.subjectID); logger.AppendFormat("\tAcceptable, adding data on subject {0}... ", data.subjectID);
if (scienceContainer.AddData(data)) if (scienceContainer.AddData(data))
{ {
logger.Append("done, removing from queue.\n"); logger.Append("done, removing from queue.\n");
   
dataStored.Add(data); dataStored.Add(data);
} }
#if DEBUG #if DEBUG
else else
{ {
logger.Append("failed.\n"); logger.Append("failed.\n");
} }
#endif #endif
} }
   
dataQueue.RemoveAll(i => dataStored.Contains(i)); dataQueue.RemoveAll(i => dataStored.Contains(i));
   
logger.AppendFormat("\t{0} data left in queue.", dataQueue.Count); logger.AppendFormat("\t{0} data left in queue.", dataQueue.Count);
} }
   
logger.Print(); logger.Print();
   
if (dataQueue.Count > 0) if (dataQueue.Count > 0)
{ {
StringBuilder msg = new StringBuilder(); using (PooledStringBuilder sb = PooledStringBuilder.Get())
   
msg.Append('[');  
msg.Append(this.part.partInfo.title);  
msg.AppendFormat("]: {0} data items could not be saved: no space available in data containers.\n");  
msg.Append("Data to be discarded:\n");  
   
foreach (ScienceData data in dataQueue)  
{ {
msg.AppendFormat("\n{0}\n", data.title); sb.Append('[');
  sb.Append(this.part.partInfo.title);
  sb.AppendFormat("]: {0} data items could not be saved: no space available in data containers.\n");
  sb.Append("Data to be discarded:\n");
   
  ScienceData data;
  for (int dIdx = 0; dIdx < dataQueue.Count; dIdx++)
  {
  data = dataQueue[dIdx];
  sb.AppendFormat("\t{0}\n", data.title);
  }
   
  ScreenMessages.PostScreenMessage(sb.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);
   
  this.LogDebug(sb.ToString());
} }
  }
ScreenMessages.PostScreenMessage(msg.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);  
  this.PostCannotTransmitError();
Tools.PostDebugMessage(msg.ToString()); }
}  
  this.LogDebug(
this.PostCannotTransmitError (); "distance: " + this.CurrentLinkSqrDistance
}  
   
Tools.PostDebugMessage (  
"distance: " + this.transmitDistance  
+ " packetSize: " + this.packetSize + " packetSize: " + this.packetSize
+ " packetResourceCost: " + this.packetResourceCost + " packetResourceCost: " + this.packetResourceCost
); );
} }
   
// Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit /// <summary>
// returns false. /// Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit
  /// returns false.
  /// </summary>
public new void StartTransmission() public new void StartTransmission()
{ {
PreTransmit_SetPacketSize (); this.LogDebug(
PreTransmit_SetPacketResourceCost (); "distance: " + this.CurrentLinkSqrDistance
   
Tools.PostDebugMessage (  
"distance: " + this.transmitDistance  
+ " packetSize: " + this.packetSize + " packetSize: " + this.packetSize
+ " packetResourceCost: " + this.packetResourceCost + " packetResourceCost: " + this.packetResourceCost
); );
   
if (this.CanTransmit()) if (this.CanTransmit())
{ {
StringBuilder message = new StringBuilder(); ScreenMessages.PostScreenMessage(this.buildTransmitMessage(), 4f, ScreenMessageStyle.UPPER_LEFT);
   
message.Append("[");  
message.Append(base.part.partInfo.title);  
message.Append("]: ");  
   
message.Append("Beginning transmission ");  
   
if (this.KerbinDirect)  
{  
message.Append("directly to Kerbin.");  
}  
else  
{  
message.Append("via ");  
message.Append(this.relay.targetRelay);  
}  
   
ScreenMessages.PostScreenMessage(message.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT);  
   
base.StartTransmission(); base.StartTransmission();
} }
else else
{ {
this.PostCannotTransmitError (); this.PostCannotTransmitError ();
} }
} }
   
  /// <summary>
  /// MonoBehaviour Update
  /// </summary>
public void Update() public void Update()
{ {
if (this.actionUIUpdate) if (this.actionUIUpdate)
{ {
  this.UImaxTransmitDistance = TextTools.Format("{0:S3}m",
  Math.Sqrt(this.MaximumLinkSqrDistance));
  this.UInominalLinkDistance = TextTools.Format("{0:S3}m",
  Math.Sqrt(this.NominalLinkSqrDistance));
   
if (this.CanTransmit()) if (this.CanTransmit())
{ {
this.UIrelayStatus = "Connected"; this.UIrelayStatus = this.LinkStatus.ToString();
this.UItransmitDistance = Tools.MuMech_ToSI(this.transmitDistance) + "m"; this.UItransmitDistance = TextTools.Format("{0:S3}m",
this.UIpacketSize = Tools.MuMech_ToSI(this.DataRate) + "MiT"; Math.Sqrt(this.CurrentLinkSqrDistance));
this.UIpacketCost = Tools.MuMech_ToSI(this.DataResourceCost) + "E"; this.UIpacketSize = TextTools.Format("{0:S3}MiT", this.DataRate);
  this.UIpacketCost = TextTools.Format("{0:S3}EC", this.DataResourceCost);
} }
else else
{ {
if (this.relay.firstOccludingBody == null) if (this.relay.firstOccludingBody == null)
{ {
  this.UItransmitDistance = TextTools.Format("{0:S3}m",
  Math.Sqrt(this.CurrentLinkSqrDistance));
this.UIrelayStatus = "Out of range"; this.UIrelayStatus = "Out of range";
} }
else else
{ {
this.UIrelayStatus = string.Format("Blocked by {0}", this.relay.firstOccludingBody.bodyName); this.UItransmitDistance = "N/A";
  this.UIrelayStatus = TextTools.Format("Blocked by {0}", this.relay.firstOccludingBody.bodyName);
} }
this.UImaxTransmitDistance = "N/A";  
this.UIpacketSize = "N/A"; this.UIpacketSize = "N/A";
this.UIpacketCost = "N/A"; this.UIpacketCost = "N/A";
} }
   
if (this.KerbinDirect) if (this.KerbinDirect)
{ {
this.UIrelayTarget = AntennaRelay.Kerbin.bodyName; this.UIrelayTarget = AntennaRelay.Kerbin.bodyName;
} }
else else
{ {
this.UIrelayTarget = this.targetRelay.ToString(); if (this.targetRelay != null)
} {
} this.UIrelayTarget = this.targetRelay.ToString();
} }
  else
public void onPartActionUICreate(Part eventPart) {
  this.UIrelayTarget = "A mysterious null entity";
  }
  }
  }
  }
   
  /// <summary>
  /// Recalculates the max range; useful for making sure we're using additive ranges when enabled.
  /// </summary>
  public void RecalculateMaxRange()
  {
  this.maxTransmitDistance = Math.Sqrt(this.maxPowerFactor) * this.nominalTransmitDistance;
   
  #if DEBUG
  this.Log("Recalculated max range: sqrt({0}) * {1} = {2}",
  this.maxPowerFactor, this.nominalTransmitDistance, this.maxTransmitDistance);
  #endif
  }
   
  /// <summary>
  /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.ModuleLimitedDataTransmitter"/>.
  /// </summary>
  /// <returns>A <see cref="System.String"/> that represents the current <see cref="AntennaRange.ModuleLimitedDataTransmitter"/>.</returns>
  public override string ToString()
  {
  using (PooledStringBuilder sb = PooledStringBuilder.Get())
  {
  string msg;
   
  if (this.part != null && this.part.partInfo != null)
  {
  sb.Append(this.part.partInfo.title);
  }
  else
  {
  sb.Append(this.GetType().Name);
  }
   
  if (vessel != null)
  {
  sb.Append(" on ");
  sb.Append(vessel.vesselName);
  }
  else if (
  this.part != null &&
  this.part.protoPartSnapshot != null &&
  this.part.protoPartSnapshot != null &&
  this.part.protoPartSnapshot.pVesselRef != null)
  {
  sb.Append(" on ");
  sb.Append(this.part.protoPartSnapshot.pVesselRef.vesselName);
  }
   
  msg = sb.ToString();
   
  return msg;
  }
  }
   
  // When we catch an onPartActionUICreate event for our part, go ahead and update every frame to look pretty.
  private void onPartActionUICreate(Part eventPart)
{ {
if (eventPart == base.part) if (eventPart == base.part)
{ {
this.actionUIUpdate = true; this.actionUIUpdate = true;
} }
} }
   
public void onPartActionUIDismiss(Part eventPart) // When we catch an onPartActionUIDismiss event for our part, stop updating every frame to look pretty.
  private void onPartActionUIDismiss(Part eventPart)
{ {
if (eventPart == base.part) if (eventPart == base.part)
{ {
this.actionUIUpdate = false; this.actionUIUpdate = false;
} }
} }
   
public override string ToString() // Post an error in the communication messages describing the reason transmission has failed. Currently there
{ // is only one reason for this.
StringBuilder msg = new StringBuilder(); private void PostCannotTransmitError()
  {
msg.Append(this.part.partInfo.title); string ErrorText = string.Intern("Unable to transmit: no visible receivers in range!");
   
if (vessel != null) this.ErrorMsg.message = string.Format(
{ "<color='#{0}{1}{2}{3}'><b>{4}</b></color>",
msg.Append(" on "); ((int)(XKCDColors.OrangeRed.r * 255f)).ToString("x2"),
msg.Append(vessel.vesselName); ((int)(XKCDColors.OrangeRed.g * 255f)).ToString("x2"),
} ((int)(XKCDColors.OrangeRed.b * 255f)).ToString("x2"),
else if ( ((int)(XKCDColors.OrangeRed.a * 255f)).ToString("x2"),
this.part != null && ErrorText
this.part.protoPartSnapshot != null && );
this.part.protoPartSnapshot != null &&  
this.part.protoPartSnapshot.pVesselRef != null this.LogDebug(this.ErrorMsg.message);
)  
{ ScreenMessages.PostScreenMessage(this.ErrorMsg);
msg.Append(" on "); }
msg.Append(this.part.protoPartSnapshot.pVesselRef.vesselName);  
} private string buildTransmitMessage()
  {
return msg.ToString(); using (PooledStringBuilder sb = PooledStringBuilder.Get())
} {
  string msg;
   
  sb.Append("[");
  sb.Append(base.part.partInfo.title);
  sb.Append("]: ");
   
  sb.Append("Beginning transmission ");
   
  if (this.KerbinDirect)
  {
  sb.Append("directly to Kerbin.");
  }
  else
  {
  sb.Append("via ");
  sb.Append(this.relay.targetRelay);
  }
   
  msg = sb.ToString();
   
  return msg;
  }
  }
   
  #if DEBUG
// When debugging, it's nice to have a button that just tells you everything. // When debugging, it's nice to have a button that just tells you everything.
   
[KSPEvent (guiName = "Show Debug Info", active = true, guiActive = true)] [KSPEvent (guiName = "Show Debug Info", active = true, guiActive = true)]
public void DebugInfo() public void DebugInfo()
{ {
PreTransmit_SetPacketSize (); if (this.relay != null)
PreTransmit_SetPacketResourceCost (); this.relay.RecalculateTransmissionRates();
   
string msg = string.Format( DebugPartModule.DumpClassObject(this);
"'{0}'\n" +  
"_basepacketSize: {1}\n" +  
"packetSize: {2}\n" +  
"_basepacketResourceCost: {3}\n" +  
"packetResourceCost: {4}\n" +  
"maxTransmitDistance: {5}\n" +  
"transmitDistance: {6}\n" +  
"nominalRange: {7}\n" +  
"CanTransmit: {8}\n" +  
"DataRate: {9}\n" +  
"DataResourceCost: {10}\n" +  
"TransmitterScore: {11}\n" +  
"NearestRelay: {12}\n" +  
"BestOccludedRelay: {13}\n" +  
"KerbinDirect: {14}\n" +  
"Vessel ID: {15}",  
this.name,  
this._basepacketSize,  
base.packetSize,  
this._basepacketResourceCost,  
base.packetResourceCost,  
this.maxTransmitDistance,  
this.transmitDistance,  
this.nominalRange,  
this.CanTransmit(),  
this.DataRate,  
this.DataResourceCost,  
ScienceUtil.GetTransmitterScore(this),  
this.relay.nearestRelay == null ? "null" : this.relay.nearestRelay.ToString(),  
this.relay.bestOccludedRelay == null ? "null" : this.relay.bestOccludedRelay.ToString(),  
this.KerbinDirect,  
this.vessel.id  
);  
   
Tools.PostLogMessage(msg);  
} }
   
[KSPEvent (guiName = "Dump Vessels", active = true, guiActive = true)] [KSPEvent (guiName = "Dump Vessels", active = true, guiActive = true)]
public void PrintAllVessels() public void PrintAllVessels()
{ {
StringBuilder sb = new StringBuilder(); using (PooledStringBuilder sb = PooledStringBuilder.Get())
  {
sb.Append("Dumping FlightGlobals.Vessels:"); sb.Append("Dumping FlightGlobals.Vessels:");
   
foreach (Vessel vessel in FlightGlobals.Vessels) Vessel vessel;
{ for (int i = 0; i < FlightGlobals.Vessels.Count; i++)
sb.AppendFormat("\n'{0} ({1})'", vessel.vesselName, vessel.id); {
} vessel = FlightGlobals.Vessels[i];
  sb.AppendFormat("\n'{0} ({1})'", vessel.vesselName, vessel.id);
Tools.PostDebugMessage(sb.ToString()); }
}  
  ToadicusTools.Logging.PostDebugMessage(sb.ToString());
  }
  }
   
/*[KSPEvent (guiName = "Dump RelayDB", active = true, guiActive = true)] /*[KSPEvent (guiName = "Dump RelayDB", active = true, guiActive = true)]
public void DumpRelayDB() public void DumpRelayDB()
{ {
RelayDatabase.Instance.Dump(); RelayDatabase.Instance.Dump();
}*/ }*/
  #endif
} }
} }
// AntennaRange // AntennaRange
// //
// AssemblyInfo.cs // AssemblyInfo.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
using System.Reflection; using System.Reflection;
using System.Runtime.CompilerServices; using System.Runtime.CompilerServices;
   
[assembly: KSPAssemblyDependency("ToadicusTools", 0, 0)] [assembly: KSPAssemblyDependency("ToadicusTools", 0, 0)]
   
// Information about this assembly is defined by the following attributes. // Information about this assembly is defined by the following attributes.
// Change them to the values specific to your project. // Change them to the values specific to your project.
[assembly: AssemblyTitle("AntennaRange")] [assembly: AssemblyTitle("AntennaRange")]
[assembly: AssemblyDescription("Enforce and Encourage Antenna Diversity")] [assembly: AssemblyDescription("Enforce and Encourage Antenna Diversity")]
[assembly: AssemblyCopyright("toadicus")] [assembly: AssemblyCopyright("toadicus")]
// The assembly version has the format "{Major}.{Minor}.{Build}.{Revision}". // The assembly version has the format "{Major}.{Minor}.{Build}.{Revision}".
// The form "{Major}.{Minor}.*" will automatically update the build and revision, // The form "{Major}.{Minor}.*" will automatically update the build and revision,
// and "{Major}.{Minor}.{Build}.*" will update just the revision. // and "{Major}.{Minor}.{Build}.*" will update just the revision.
[assembly: AssemblyVersion("1.8.*")] [assembly: AssemblyVersion("1.10.3.*")]
// The following attributes are used to specify the signing key for the assembly, // The following attributes are used to specify the signing key for the assembly,
// if desired. See the Mono documentation for more information about signing. // if desired. See the Mono documentation for more information about signing.
//[assembly: AssemblyDelaySign(false)] //[assembly: AssemblyDelaySign(false)]
//[assembly: AssemblyKeyFile("")] //[assembly: AssemblyKeyFile("")]
   
// AntennaRange // AntennaRange
// //
// ProtoAntennaRelay.cs // ProtoAntennaRelay.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
using KSP; using KSP;
using System; using System;
using System.Linq;  
using ToadicusTools; using ToadicusTools;
  using ToadicusTools.Text;
   
namespace AntennaRange namespace AntennaRange
{ {
/* /// <summary>
* Wrapper class for ProtoPartModuleSnapshot extending AntennaRelay and implementing IAntennaRelay. /// Wrapper class for ProtoPartModuleSnapshot extending AntennaRelay and implementing IAntennaRelay.
* This is used for finding relays in unloaded Vessels. /// This is used for finding relays in unloaded Vessels.
* */ /// </summary>
public class ProtoAntennaRelay : AntennaRelay, IAntennaRelay public class ProtoAntennaRelay : AntennaRelay, IAntennaRelay
{ {
// Stores the prototype part so we can make sure we haven't exploded or so. // Stores the prototype part so we can make sure we haven't exploded or so.
protected ProtoPartSnapshot protoPart; private ProtoPartSnapshot protoPart;
   
  /// <summary>
  /// Gets the parent Vessel.
  /// </summary>
public override Vessel vessel public override Vessel vessel
{ {
get get
{ {
return this.protoPart.pVesselRef.vesselRef; if (
} this.protoPart != null &&
} this.protoPart.pVesselRef != null &&
  this.protoPart.pVesselRef.vesselRef != null
  )
  {
  return this.protoPart.pVesselRef.vesselRef;
  }
  else
  {
  this.LogError("Could not fetch vessel! {0}{1}{2}",
  this.protoPart == null ? "\n\tprotoPart=null" : string.Empty,
  this.protoPart != null && this.protoPart.pVesselRef == null ?
  "\n\tthis.protoPart.pVesselRef=null" : string.Empty,
  this.protoPart != null && this.protoPart.pVesselRef != null &&
  this.protoPart.pVesselRef.vesselRef == null ?
  "\n\tthis.protoPart.pVesselRef.vesselRef=null" : string.Empty
  );
  return null;
  }
  }
  }
   
  /// <summary>
  /// Gets or sets the data capacity of a packet, in MiT/packet
  /// </summary>
  /// <value>The data capacity of a packet, in MiT/packet</value>
  public float PacketSize
  {
  get
  {
  if (this.moduleRef == null)
  {
  return float.NaN;
  }
   
  return this.moduleRef.PacketSize;
  }
  set
  {
  if (this.moduleRef == null)
  {
  return;
  }
   
  this.moduleRef.PacketSize = value;
  }
  }
   
  /// <summary>
  /// Gets the base data capacity of a packet, in MiT/packet
  /// </summary>
  /// <value>The base data capacity of a packet, in MiT/packet</value>
  public float BasePacketSize
  {
  get
  {
  if (this.moduleRef == null)
  {
  return float.NaN;
  }
   
  return this.moduleRef.BasePacketSize;
  }
  }
   
  /// <summary>
  /// Gets or sets the resource cost of a packet, in EC/packet
  /// </summary>
  /// <value>The resource cost of a packet, in EC/packet</value>
  public float PacketResourceCost
  {
  get
  {
  if (this.moduleRef == null)
  {
  return float.NaN;
  }
   
  return this.moduleRef.PacketResourceCost;
  }
  set
  {
  if (this.moduleRef == null)
  {
  return;
  }
   
  this.moduleRef.PacketResourceCost = value;
  }
  }
   
  /// <summary>
  /// Gets the base resource cost of a packet, in EC/packet
  /// </summary>
  /// <value>The base resource cost of a packet, in EC/packet</value>
  public float BasePacketResourceCost
  {
  get
  {
  if (this.moduleRef == null)
  {
  return float.NaN;
  }
   
  return this.moduleRef.BasePacketResourceCost;
  }
  }
   
  /// <summary>
  /// Gets the packet throttle.
  /// </summary>
  /// <value>The packet throttle in range [0..100].</value>
  public float PacketThrottle
  {
  get
  {
  if (this.moduleRef == null)
  {
  return float.NaN;
  }
   
  return this.moduleRef.PacketThrottle;
  }
  }
   
  /// <summary>
  /// Gets the max data factor.
  /// </summary>
  /// <value>The max data factor.</value>
  public float MaxDataFactor
  {
  get
  {
  if (this.moduleRef == null)
  {
  return float.NaN;
  }
   
  return this.moduleRef.MaxDataFactor;
  }
  }
   
  /// <summary>
  /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config.
  /// </summary>
public override double nominalTransmitDistance public override double nominalTransmitDistance
{ {
get get
{ {
return this.moduleRef.nominalTransmitDistance; return this.moduleRef.nominalTransmitDistance;
} }
} }
   
/// <summary> /// <summary>
/// The maximum distance at which this transmitter can operate. /// The maximum distance at which this relay can operate.
/// </summary> /// </summary>
/// <value>The max transmit distance.</value> public override double maxTransmitDistance
public override float maxTransmitDistance  
{ {
get get
{ {
return moduleRef.maxTransmitDistance; return moduleRef.maxTransmitDistance;
} }
} }
   
/// <summary> /// <summary>
/// Gets the underlying part's title. /// Gets the underlying part's title.
/// </summary> /// </summary>
/// <value>The title.</value> /// <value>The title.</value>
public string Title public string Title
{ {
get get
{ {
if (this.protoPart != null && this.protoPart.partInfo != null) if (this.protoPart != null && this.protoPart.partInfo != null)
{ {
return this.protoPart.partInfo.title; return this.protoPart.partInfo.title;
} }
   
return string.Empty; return string.Empty;
} }
} }
   
  /// <summary>
  /// Determines whether this instance can transmit.
  /// <c>true</c> if this instance can transmit; otherwise, <c>false</c>.
  /// </summary>
public override bool CanTransmit() public override bool CanTransmit()
{ {
PartStates partState = (PartStates)this.protoPart.state; PartStates partState = (PartStates)this.protoPart.state;
if (partState == PartStates.DEAD || partState == PartStates.DEACTIVATED) if (partState == PartStates.DEAD || partState == PartStates.DEACTIVATED)
{ {
Tools.PostDebugMessage(string.Format( Logging.PostDebugMessage(string.Format(
"{0}: {1} on {2} cannot transmit: {3}", "{0}: {1} on {2} cannot transmit: {3}",
this.GetType().Name, this.GetType().Name,
this.Title, this.Title,
this.vessel.vesselName, this.vessel.vesselName,
Enum.GetName(typeof(PartStates), partState) Enum.GetName(typeof(PartStates), partState)
)); ));
return false; return false;
} }
return base.CanTransmit(); return base.CanTransmit();
} }
   
  /// <summary>
  /// Recalculates the max range; useful for making sure we're using additive ranges when enabled.
  /// </summary>
  public void RecalculateMaxRange()
  {
  if (this.moduleRef != null)
  {
  this.moduleRef.RecalculateMaxRange();
  }
  }
   
  /// <summary>
  /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.ProtoAntennaRelay"/>.
  /// </summary>
  /// <returns>A <see cref="System.String"/> that represents the current <see cref="AntennaRange.ProtoAntennaRelay"/>.</returns>
public override string ToString() public override string ToString()
{ {
return string.Format( using (PooledStringBuilder sb = PooledStringBuilder.Get())
"{0} on {1}", {
this.Title, sb.Append(this.Title);
this.protoPart.pVesselRef.vesselName  
); if (this.protoPart != null && this.protoPart.pVesselRef != null)
} {
  sb.AppendFormat(" on {0}", this.protoPart.pVesselRef.vesselName);
/// <summary> }
/// Initializes a new instance of the <see cref="AntennaRange.ProtoAntennaRelay"/> class.  
/// </summary> return sb.ToString();
/// <param name="ms">The ProtoPartModuleSnapshot to wrap</param> }
/// <param name="vessel">The parent Vessel</param> }
   
  /// <summary>
  /// Initializes a new instance of the <see cref="AntennaRange.AntennaRelay"/> class.
  /// </summary>
  /// <param name="prefabRelay">The module reference underlying this AntennaRelay,
  /// as an <see cref="AntennaRange.IAntennaRelay"/></param>
  /// <param name="pps">The prototype partreference on which the module resides.</param>
public ProtoAntennaRelay(IAntennaRelay prefabRelay, ProtoPartSnapshot pps) : base(prefabRelay) public ProtoAntennaRelay(IAntennaRelay prefabRelay, ProtoPartSnapshot pps) : base(prefabRelay)
{ {
this.protoPart = pps; this.protoPart = pps;
}  
  this.Log("constructed ({0})", this.GetType().Name);
~ProtoAntennaRelay()  
{ this.RecalculateMaxRange();
Tools.PostDebugMessage(string.Format(  
"{0}: destroyed",  
this.ToString()  
));  
} }
} }
} }
   
   
file:b/README.md (new)
  # AntennaRange
  A KSP mod that enforces and encourages the use of the bigger antennas.
 
  # For Part Developers
  ## The Fields
  AntennaRange extends and augments the functionality of the stock ModuleDataTransmitter through the new `ModuleLimitedDataTransmitter` class. This class uses four additional configurable fields to define the part's behavior.
 
  `nominalRange` is the range, in meters, at which the part should function identically to the stock module, i.e. without any modification to the power cost or packet size. This is used along with maxPowerFactor to calculate the maximum range of the part.
  `simpleRange` is the same as nominalRange, but is used when the mod is in "simple" mode. In general it will probably need to be a much larger number than nominalRange.
  `maxPowerFactor` effectively sets the maximum range of the antenna by essentially capping how much the power may be "turned up" to get better range. I originally used 8 for this number, because it felt right. I've since used 4 (for my DTS) and 16 (for my Comm. 88-88). You don't want this number to be too high, or small probes will go uncontrollable a lot when transmitting.
  `maxDataFactor` defines the maximum "speed up" bonus that comes from using antennas at less their nominal range. I originally used 4 for this number for all parts; the DTS has a higher bonus now.
 
  Note that all of the fields needed for Squad's `ModuleDataTransmitter` still need to be filled out. Depending on how you're defining your parts, they might need to go in your AntennaRange patch, or they might already be defined on the base part.
 
  ## The Mechanic
  In general, the scaling functions assume the relation `D² α P/R,` where D is the total transmission distance, P is the transmission power, and R is the data rate. Data rate increases as range decreases below nominalRange: `R α nominalRange² / D²`. By default, power use increases as range increases above `nominalRange`: `P α D² / nominalRange²`. Optionally, power use may remain fixed, and data rate instead decreases as range increases above `nominalRange`: `R α nominalRange² / D²`.
 
  ## Patch Conventions
  To maximize cross-compatibility, please consider the following conventions for ModuleManager patches regarding AntennaRange:
 
  When providing new definitions for your own parts, always specify a `:FOR[YourModHere]` pass name.
  Whenever changing default AntennaRange definitions (e.g. if you were going to rebalance my antennas to suit your mod), please do so in the `:AFTER[AntennaRange]` pass.
  I recommend providing all optional functionality (e.g. enabling RemoteTech vs. AntennaRange modules) in separate patches using `:NEEDS[]` blocks.
 
  A sample AntennaRange configuration for an all-new mod part might look like this:
  ```
  @PART[modPartName]:FOR[YourModName]:NEEDS[AntennaRange,!RemoteTech]
  {
  MODULE
  {
  // ### Module Definition ###
  name = ModuleLimitedDataTransmitter
 
  // ### Squad Definitions ###
  // Delay between transmission packets, in seconds
  packetInterval = 0.10
 
  // Data capacity of nominal transmission packets, in MiT
  packetSize = 2
 
  // Resource cost of nominal transmission packets, in units
  packetResourceCost = 20.0
 
  // Resource name to be consumed by transmission
  requiredResource = ElectricCharge
 
  // Animation module index, 0-based, of the antenna extend/retract animation
  DeployFxModules = 0
 
  // ### AntennaRange Defintions ###
  // Range, in meters, at which the antenna behaves per the "nominal" characteristics above
  // Used with "additive" ranges.
  nominalRange = 10000000000
 
  // Range, in meters, at which the antenna behaves per the "nominal" characteristics above
  // Used with "simple" ranges.
  simpleRange = 56250000000
 
  // The maxmimum multiplier on packetResourceCost, essentially defining the maximum power output of the
  // transmitter. Maximum range is defined as: maxTransmitDistance = nominalRange * sqrt(maxPowerFactor)
  maxPowerFactor = 16
 
  // The maximum multiplier on packetSize, essentially defining the maximum data throughput of the
  // transmitter.
  maxDataFactor = 2
  }
 
  // We add this ModuleScienceContainer so that when transmission fails the antennas can try to stash the data instead of dumping it to the void.
  MODULE
  {
  name = ModuleScienceContainer
 
  dataIsCollectable = true
  dataIsStorable = false
 
  storageRange = 2
  }
  }
  ```
 
  This example assumes that the base part definition does not include a `ModuleDataTransmitter` module, or any RT modules. If the base part definition includes a `ModuleDataTransmitter` module, a sample AntennaRange patch could look like this:
  ```
  @PART[modPartName]:FOR[YourModName]:NEEDS[AntennaRange,!RemoteTech]
  {
  @MODULE[ModuleDataTransmitter]
  {
  @name = ModuleLimitedDataTransmitter
  nominalRange = 10000000000
  simpleRange = 56250000000
  maxPowerFactor = 16
  maxDataFactor = 2
  }
 
  // We add this ModuleScienceContainer so that when transmission fails the antennas can try to stash the data instead of dumping it to the void.
  MODULE
  {
  name = ModuleScienceContainer
 
  dataIsCollectable = true
  dataIsStorable = false
 
  storageRange = 2
  }
  }
  ```
 
  IIRC, RemoteTech parts should not have `ModuleDataTransmitter` definitions. In that case, to facilitate RT, AR, and Stock compatibility, a suite of patches like this might be appropriate:
 
  ```
  // If we don't have RemoteTech, add a stock ModuleDataTransmitter first.
  @PART[modPartName]:NEEDS[!RemoteTech]:BEFORE[YourModName]
  {
  MODULE
  {
  // ### Module Definition ###
  name = ModuleDataTransmitter
 
  // ### Squad Definitions ###
  // Delay between transmission packets, in seconds
  packetInterval = 0.10
 
  // Data capacity of nominal transmission packets, in MiT
  packetSize = 2
 
  // Resource cost of nominal transmission packets, in units
  packetResourceCost = 20.0
 
  // Resource name to be consumed by transmission
  requiredResource = ElectricCharge
 
  // Animation module index, 0-based, of the antenna extend/retract animation
  DeployFxModules = 0
  }
  }
 
  // If AntennaRange is installed, convert that to a ModuleLimitedDataTransmitter
  @PART[modPartName]:NEEDS[AntennaRange,!RemoteTech]:FOR[YourModName]
  {
  @MODULE[ModuleDataTransmitter]
  {
  // ### Module Redefinition ###
  @name = ModuleLimitedDataTransmitter
 
  // ### AntennaRange Defintions ###
  // Range, in meters, at which the antenna behaves per the "nominal" characteristics above
  // Used with "additive" ranges.
  nominalRange = 10000000000
 
  // Range, in meters, at which the antenna behaves per the "nominal" characteristics above
  // Used with "simple" ranges.
  simpleRange = 56250000000
 
  // The maxmimum multiplier on packetResourceCost, essentially defining the maximum power output of the
  // transmitter. Maximum range is defined as: maxTransmitDistance = nominalRange * sqrt(maxPowerFactor)
  maxPowerFactor = 16
 
  // The maximum multiplier on packetSize, essentially defining the maximum data throughput of the
  // transmitter.
  maxDataFactor = 2
  }
 
  // We add this ModuleScienceContainer so that when transmission fails the antennas can try to stash the data instead of dumping it to the void.
  MODULE
  {
  name = ModuleScienceContainer
 
  dataIsCollectable = true
  dataIsStorable = false
 
  storageRange = 2
  }
  }
 
  // If RemoteTech is installed, do their module(s) instead
  @PART[modPartName]:NEEDS[RemoteTech]:FOR[YourModName]
  {
  // RemoteTech module(s) here
  }
  ```
 
  ## Useful Formulas
 
  ### Per Antenna
  `nominalRange` is a given, and is never calculated
  `maxPowerFactor` is a given, and is never calculated
  `maxTransmitDistance = nominalRange * sqrt(maxPowerFactor)`
 
  ### Per Link
  A "link" is any connected pair of antennas.
  `NominalLinkDistance = sqrt(nominalRange1 * nominalRange2)`
  `MaxLinkDistance = sqrt(maxTransmitDistance1 * maxTransmitDistance2)`
 
  Therefore, to find the `MaxLinkDistance` from two sets of `nominalRange` and `maxPowerFactor`:
  `MaxLinkDistance = sqrt(nominalRange1 * sqrt(maxPowerFactor1) * nominalRange2 * sqrt(maxPowerFactor2))`
 
  To find a single antenna's `nominalRange` from a desired `maxTransmitDistance` given its `maxPowerFactor`:
  `nominalRange = maxTransmitDistance / sqrt(maxPowerFactor)`
 
  To find a single antenna's desired maximum range given the desired maximum link distance and another set `maxTransmitDistance`:
  `maxTransmitDistance1 = MaxLinkDistance * MaxLinkDistance / maxTransmitDistance2`
 
  Remember that `maxPowerFactor` may differ between antennas (and does, in my lastest configs: longAntenna is 8, mediumDish is 4, commDish is 16).
 
  Currently Kerbin's `maxPowerFactor` is hard-coded as 8.
 
  Feel free to use this spreadsheet for balancing antennas if it's useful to you: https://goo.gl/ChsbfL
 
  ## On Balance
  In my configs I've balanced the three stock antennas to cover all of the stock solar system. Since you're introducing five more antennas and working with OPM, you will probably want to change the behavior of the stock parts and diversify the range to gradually cover the whole OPM system. Since you have some parts specifically designed for use in planetary subsystems, their balance when transmitting to other parts is probably more important than their balance when transmitting to Kerbin. For longer range parts designed to make the whole interplanetary leap, the inverse is probably true.
 
  Feel free to ask questions! If anything's unclear or you just want to bounce balance ideas off of me, don't be shy. I'm always happy to help.
 
file:b/RelayDataCost.cs (new)
  // AntennaRange
  //
  // RelayLinkCost.cs
  //
  // Copyright © 2016, toadicus
  // All rights reserved.
  //
  // Redistribution and use in source and binary forms, with or without modification,
  // are permitted provided that the following conditions are met:
  //
  // 1. Redistributions of source code must retain the above copyright notice,
  // this list of conditions and the following disclaimer.
  //
  // 2. Redistributions in binary form must reproduce the above copyright notice,
  // this list of conditions and the following disclaimer in the documentation and/or other
  // materials provided with the distribution.
  //
  // 3. Neither the name of the copyright holder nor the names of its contributors may be used
  // to endorse or promote products derived from this software without specific prior written permission.
  //
  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
  using System;
  using UnityEngine;
 
  namespace AntennaRange
  {
  /// <summary>
  /// A struct representing the cost of sending data through a relay.
  /// </summary>
  public struct RelayDataCost : IComparable, IComparable<RelayDataCost>
  {
  /// <summary>
  /// A RelayDataCost object representing infinitely high cost.
  /// </summary>
  public static readonly RelayDataCost Infinity = new RelayDataCost(float.PositiveInfinity, 0f);
 
  /// <param name="one">Left</param>
  /// <param name="two">Right</param>
  public static RelayDataCost operator+ (RelayDataCost one, RelayDataCost two)
  {
  RelayDataCost gcd, lcd;
 
  if (one.PacketSize > two.PacketSize) {
  gcd = one;
  lcd = two;
  }
  else
  {
  gcd = two;
  lcd = one;
  }
 
  if (lcd.PacketSize != 0f)
  {
  float mul = gcd.PacketSize / lcd.PacketSize;
 
  lcd.PacketSize *= mul;
  lcd.PacketResourceCost *= mul;
  }
 
  return new RelayDataCost(gcd.PacketResourceCost + lcd.PacketResourceCost, gcd.PacketSize + lcd.PacketSize);
  }
 
  /// <param name="only">RelayDataCost to be negated</param>
  public static RelayDataCost operator- (RelayDataCost only)
  {
  return new RelayDataCost(-only.PacketResourceCost, only.PacketSize);
  }
 
  /// <param name="left">Left.</param>
  /// <param name="right">Right.</param>
  public static RelayDataCost operator- (RelayDataCost left, RelayDataCost right)
  {
  return left + -right;
  }
 
  /// <param name="left">Left.</param>
  /// <param name="right">Right.</param>
  public static bool operator> (RelayDataCost left, RelayDataCost right)
  {
  return (left.CompareTo(right) > 0);
  }
 
  /// <param name="left">Left.</param>
  /// <param name="right">Right.</param>
  public static bool operator>= (RelayDataCost left, RelayDataCost right)
  {
  return (left.CompareTo(right) >= 0);
  }
 
  /// <param name="left">Left.</param>
  /// <param name="right">Right.</param>
  public static bool operator== (RelayDataCost left, RelayDataCost right)
  {
  return (left.CompareTo(right) == 0);
  }
 
  /// <param name="left">Left.</param>
  /// <param name="right">Right.</param>
  public static bool operator<= (RelayDataCost left, RelayDataCost right)
  {
  return (left.CompareTo(right) <= 0);
  }
 
  /// <param name="left">Left.</param>
  /// <param name="right">Right.</param>
  public static bool operator< (RelayDataCost left, RelayDataCost right)
  {
  return (left.CompareTo(right) < 0);
  }
 
  /// <param name="left">Left.</param>
  /// <param name="right">Right.</param>
  public static bool operator!= (RelayDataCost left, RelayDataCost right)
  {
  return (left.CompareTo(right) != 0);
  }
 
  /// <summary>
  /// The resource cost of a packet, in EC/packet
  /// </summary>
  public float PacketResourceCost;
 
  /// <summary>
  /// The data capacity of a packet, MiT/packet
  /// </summary>
  public float PacketSize;
 
  /// <summary>
  /// Gets the resource cost per unit data, in EC/MiT
  /// </summary>
  /// <value>The resource cost per unit data, in EC/MiT</value>
  public double ResourceCostPerData
  {
  get
  {
  if (this.PacketSize == 0f || float.IsInfinity(this.PacketResourceCost))
  {
  return double.PositiveInfinity;
  }
 
  return (double)this.PacketResourceCost / (double)this.PacketSize;
  }
  }
 
  /// <summary>
  /// Initializes a new instance of the <see cref="AntennaRange.RelayDataCost"/> struct.
  /// </summary>
  /// <param name="cost">resource cost of a packet, in EC/packet</param>
  /// <param name="size">data capacity of a packet, MiT/packet</param>
  public RelayDataCost(float cost, float size)
  {
  this.PacketResourceCost = cost;
  this.PacketSize = size;
  }
 
  /// <summary>
  /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.RelayDataCost"/>.
  /// </summary>
  /// <returns>A <see cref="System.String"/> that represents the current <see cref="AntennaRange.RelayDataCost"/>.</returns>
  public override string ToString()
  {
  return string.Format("{0} EC/MiT", this.ResourceCostPerData);
  }
 
  /// <summary>
  /// Determines whether the specified <see cref="System.Object"/> is equal to the current <see cref="AntennaRange.RelayDataCost"/>.
  /// </summary>
  /// <param name="obj">The <see cref="System.Object"/> to compare with the current <see cref="AntennaRange.RelayDataCost"/>.</param>
  /// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to the current
  /// <see cref="AntennaRange.RelayDataCost"/>; otherwise, <c>false</c>.</returns>
  public override bool Equals(object obj)
  {
  if (obj is RelayDataCost)
  {
  return ((RelayDataCost)obj == this);
  }
  else
  {
  return false;
  }
  }
 
  /// <summary>
  /// Serves as a hash function for a <see cref="AntennaRange.RelayDataCost"/> object.
  /// </summary>
  /// <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
  public override int GetHashCode()
  {
  int hash = 137;
 
  hash = (hash * 61) + this.PacketResourceCost.GetHashCode();
  hash = (hash * 61) + this.PacketSize.GetHashCode();
 
  return hash;
  }
 
  /// <summary>
  /// Compares this RelayDataCost to another object. Throws NotImplementedException for objects
  /// that are not RelayDataCost objects
  /// </summary>
  /// <returns>-1 if this is less than o, 0 if this equals o, 1 if this is greater than o</returns>
  /// <param name="o">Another object</param>
  public int CompareTo(object o)
  {
  if (o is RelayDataCost)
  {
  return this.CompareTo((RelayDataCost)o);
  }
 
  throw new NotImplementedException(
  string.Format(
  "Cannot compare {0} to foreign type {1}",
  this.GetType().Name,
  o.GetType().Name
  )
  );
  }
 
  /// <summary>
  /// Compares this RelayDataCost to another object. Throws NotImplementedException for objects
  /// that are not RelayDataCost objects
  /// </summary>
  /// <returns>-1 if this is less than o, 0 if this equals o, 1 if this is greater than o</returns>
  /// <param name="o">Another RelayDataCost</param>
  public int CompareTo(RelayDataCost o)
  {
  int val;
 
  if (this.ResourceCostPerData > o.ResourceCostPerData)
  {
  val = 1;
  }
  else if (this.ResourceCostPerData < o.ResourceCostPerData)
  {
  val = -1;
  }
  else
  {
  val = 0;
  }
 
  #if DEBUG
  Debug.LogErrorFormat("RelayLinkCost comparing {0} to {1}, returning {2}", this, o, val);
  #endif
 
  return val;
  }
  }
  }
 
 
// AntennaRange // AntennaRange
// //
// RelayDatabase.cs // RelayDatabase.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
  #pragma warning disable 1591
   
using KSP; using KSP;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Text; using System.Text;
using ToadicusTools; using ToadicusTools;
using UnityEngine; using UnityEngine;
   
namespace AntennaRange namespace AntennaRange
{ {
public class RelayDatabase public class RelayDatabase : Singleton<RelayDatabase>
{ {
/*  
* Static members  
* */  
// Singleton storage  
protected static RelayDatabase _instance;  
// Gets the singleton  
public static RelayDatabase Instance  
{  
get  
{  
if (_instance == null)  
{  
_instance = new RelayDatabase();  
}  
   
return _instance;  
}  
}  
   
/* /*
* Instance members * Instance members
* */ * */
   
/* /*
* Fields * Fields
* */ * */
// Vessel.id-keyed hash table of Part.GetHashCode()-keyed tables of relay objects. // Vessel.id-keyed hash table of Part.GetHashCode()-keyed tables of relay objects.
protected Dictionary<Guid, Dictionary<int, IAntennaRelay>> relayDatabase; private Dictionary<Guid, List<IAntennaRelay>> relayDatabase;
  private Dictionary<Guid, IAntennaRelay> bestRelayTable;
   
// Vessel.id-keyed hash table of part counts, used for caching // Vessel.id-keyed hash table of part counts, used for caching
protected Dictionary<Guid, int> vesselPartCountTable; private Dictionary<Guid, int> vesselPartCountTable;
   
// Vessel.id-keyed hash table of booleans to track what vessels have been checked so far this time. private int cacheHits;
public Dictionary<Guid, bool> CheckedVesselsTable; private int cacheMisses;
   
protected int cacheHits;  
protected int cacheMisses;  
   
/* /*
* Properties * Properties
* */ * */
// Gets the Part-hashed table of relays in a given vessel // Gets the Part-hashed table of relays in a given vessel
public Dictionary<int, IAntennaRelay> this [Vessel vessel] public IList<IAntennaRelay> this [Vessel vessel]
{ {
get get
{ {
// If we don't have an entry for this vessel... // If we don't have an entry for this vessel...
if (!this.ContainsKey(vessel.id)) if (!this.ContainsKey(vessel.id))
{ {
// ...Generate an entry for this vessel. // ...Generate an entry for this vessel.
this.AddVessel(vessel); this.AddVessel(vessel);
this.cacheMisses++; this.cacheMisses++;
} }
// If our part count disagrees with the vessel's part count... // If our part count disagrees with the vessel's part count...
else if (this.vesselPartCountTable[vessel.id] != vessel.Parts.Count) else if (this.vesselPartCountTable[vessel.id] != vessel.Parts.Count)
{ {
// ...Update the our vessel in the cache // ...Update the our vessel in the cache
this.UpdateVessel(vessel); this.UpdateVessel(vessel);
this.cacheMisses++; this.cacheMisses++;
} }
// Otherwise, it's a hit // Otherwise, it's a hit
else else
{ {
this.cacheHits++; this.cacheHits++;
} }
   
// Return the Part-hashed table of relays for this vessel // Return the Part-hashed table of relays for this vessel
return relayDatabase[vessel.id]; return relayDatabase[vessel.id].AsReadOnly();
} }
} }
   
/* /*
* Methods * Methods
* */ * */
  // Remove a vessel from the cache, if it exists.
  public void DirtyVessel(Vessel vessel)
  {
  #if DEBUG
  Logging.PostDebugMessage("RelayDatabase: Dirtying cache for vessel {0} in frame {1}",
  vessel, new System.Diagnostics.StackTrace().ToString());
  #else
  Logging.PostLogMessage("RelayDatabase: Dirtying cache for vessel {0}", vessel.vesselName);
  #endif
   
  this.relayDatabase.Remove(vessel.id);
  this.vesselPartCountTable.Remove(vessel.id);
  this.bestRelayTable.Remove(vessel.id);
  }
   
  public void ClearCache()
  {
  Logging.PostLogMessage("RelayDatabase: onSceneChange clearing entire cache.");
   
  this.relayDatabase.Clear();
  this.bestRelayTable.Clear();
  this.vesselPartCountTable.Clear();
  }
   
  // Returns true if both the relayDatabase and the vesselPartCountDB contain the vessel id.
  public bool ContainsKey(Guid key)
  {
  return this.relayDatabase.ContainsKey(key);
  }
   
  // Returns true if both the relayDatabase and the vesselPartCountDB contain the vessel.
  public bool ContainsKey(Vessel vessel)
  {
  return this.ContainsKey(vessel.id);
  }
   
  public IAntennaRelay GetBestVesselRelay(Vessel vessel)
  {
  IAntennaRelay relay;
  if (this.bestRelayTable.TryGetValue(vessel.id, out relay))
  {
  return relay;
  }
  else
  {
  var dump = this[vessel];
  return null;
  }
  }
   
// Adds a vessel to the database // Adds a vessel to the database
// The return for this function isn't used yet, but seems useful for potential future API-uses // The return for this function isn't used yet, but seems useful for potential future API-uses
public bool AddVessel(Vessel vessel) private bool AddVessel(Vessel vessel)
{ {
// If this vessel is already here... // If this vessel is already here...
if (this.ContainsKey(vessel)) if (this.ContainsKey(vessel))
{ {
// ...post an error // ...post an error
Debug.LogWarning(string.Format( Debug.LogWarning(string.Format(
"{0}: Cannot add vessel '{1}' (id: {2}): Already in database.", "{0}: Cannot add vessel '{1}' (id: {2}): Already in database.",
this.GetType().Name, this.GetType().Name,
vessel.vesselName, vessel.vesselName,
vessel.id vessel.id
)); ));
   
// ...and refuse to add // ...and refuse to add
return false; return false;
} }
// otherwise, add the vessel to our tables... // otherwise, add the vessel to our tables...
else else
{ {
// Build an empty table... // Build an empty table...
this.relayDatabase[vessel.id] = new Dictionary<int, IAntennaRelay>(); this.relayDatabase[vessel.id] = new List<IAntennaRelay>();
   
// Update the empty index // Update the empty index
this.UpdateVessel(vessel); this.UpdateVessel(vessel);
   
// Return success // Return success
return true; return true;
} }
} }
   
// Update the vessel's entry in the table // Update the vessel's entry in the table
public void UpdateVessel(Vessel vessel) private void UpdateVessel(Vessel vessel)
{ {
// Squak if the database doesn't have the vessel // Squak if the database doesn't have the vessel
if (!this.ContainsKey(vessel)) if (!this.ContainsKey(vessel))
{ {
throw new InvalidOperationException(string.Format( throw new InvalidOperationException(string.Format(
"{0}: Update called for vessel '{1}' (id: {2}) not in database: vessel will be added.", "{0}: Update called for vessel '{1}' (id: {2}) not in database: vessel will be added.",
this.GetType().Name, this.GetType().Name,
vessel.vesselName, vessel.vesselName,
vessel.id vessel.id
)); ));
} }
   
Dictionary<int, IAntennaRelay> vesselTable = this.relayDatabase[vessel.id]; List<IAntennaRelay> vesselTable = this.relayDatabase[vessel.id];
   
// Actually build and assign the table // Actually build and assign the table
this.getVesselRelays(vessel, ref vesselTable); this.getVesselRelays(vessel, ref vesselTable);
// Set the part count // Set the part count
this.vesselPartCountTable[vessel.id] = vessel.Parts.Count; this.vesselPartCountTable[vessel.id] = vessel.Parts.Count;
} }
   
// Remove a vessel from the cache, if it exists.  
public void DirtyVessel(Vessel vessel)  
{  
if (this.relayDatabase.ContainsKey(vessel.id))  
{  
this.relayDatabase.Remove(vessel.id);  
}  
if (this.vesselPartCountTable.ContainsKey(vessel.id))  
{  
this.vesselPartCountTable.Remove(vessel.id);  
}  
}  
   
// Returns true if both the relayDatabase and the vesselPartCountDB contain the vessel id.  
public bool ContainsKey(Guid key)  
{  
return this.relayDatabase.ContainsKey(key);  
}  
   
// Returns true if both the relayDatabase and the vesselPartCountDB contain the vessel.  
public bool ContainsKey(Vessel vessel)  
{  
return this.ContainsKey(vessel.id);  
}  
   
// Runs when a vessel is modified (or when we switch to one, to catch docking events) // Runs when a vessel is modified (or when we switch to one, to catch docking events)
public void onVesselEvent(Vessel vessel) public void onVesselEvent(Vessel vessel)
{ {
// If we have this vessel in our cache... // If we have this vessel in our cache...
if (this.ContainsKey(vessel)) if (this.ContainsKey(vessel))
{ {
// If our part counts disagree (such as if a part has been added or broken off, // If our part counts disagree (such as if a part has been added or broken off,
// or if we've just docked or undocked)... // or if we've just docked or undocked)...
if (this.vesselPartCountTable[vessel.id] != vessel.Parts.Count || vessel.loaded) if (this.vesselPartCountTable[vessel.id] != vessel.Parts.Count || vessel.loaded)
{ {
Tools.PostDebugMessage(string.Format( Logging.PostDebugMessage(string.Format(
"{0}: dirtying cache for vessel '{1}' ({2}).", "{0}: dirtying cache for vessel '{1}' ({2}).",
this.GetType().Name, this.GetType().Name,
vessel.vesselName, vessel.vesselName,
vessel.id vessel.id
)); ));
   
// Dirty the cache (real vessels will never have negative part counts) // Dirty the cache (real vessels will never have negative part counts)
this.DirtyVessel(vessel); this.DirtyVessel(vessel);
} }
} }
} }
   
// Runs when the player requests a scene change, such as when changing vessels or leaving flight. // Runs when the player requests a scene change, such as when changing vessels or leaving flight.
public void onSceneChange(GameScenes scene) private void onSceneChange(GameScenes scene)
{ {
// If the active vessel is a real thing... Logging.PostDebugMessage(
if (FlightGlobals.ActiveVessel != null) "RelayDatabase: caught onSceneChangeRequested in scene {0} to scene {1}. ActiveVessel is {2}",
{ HighLogic.LoadedScene,
// ... dirty its cache scene,
this.onVesselEvent(FlightGlobals.ActiveVessel); FlightGlobals.ActiveVessel == null ? "null" : FlightGlobals.ActiveVessel.vesselName
} );
   
  if (scene == GameScenes.FLIGHT)
  {
  if (scene == HighLogic.LoadedScene)
  {
  if (FlightGlobals.ActiveVessel != null)
  {
  Logging.PostDebugMessage("RelayDatabase: onSceneChange clearing {0} from cache.",
  FlightGlobals.ActiveVessel.vesselName);
   
  this.onVesselEvent(FlightGlobals.ActiveVessel);
  }
  }
  else
  {
  this.ClearCache();
  }
  }
  }
   
  private void onGameLoaded(object data)
  {
  this.ClearCache();
} }
   
// Runs when parts are undocked // Runs when parts are undocked
public void onPartEvent(Part part) private void onPartEvent(Part part)
{ {
if (part != null && part.vessel != null) if (part != null && part.vessel != null)
{ {
this.onVesselEvent(part.vessel); this.onVesselEvent(part.vessel);
} }
} }
   
// Runs when parts are coupled, as in docking // Runs when parts are coupled, as in docking
public void onFromPartToPartEvent(GameEvents.FromToAction<Part, Part> data) private void onFromPartToPartEvent(GameEvents.FromToAction<Part, Part> data)
{ {
this.onPartEvent(data.from); this.onPartEvent(data.from);
this.onPartEvent(data.to); this.onPartEvent(data.to);
} }
   
// Produce a Part-hashed table of relays for the given vessel // Produce a Part-hashed table of relays for the given vessel
protected void getVesselRelays(Vessel vessel, ref Dictionary<int, IAntennaRelay> relays) private void getVesselRelays(Vessel vessel, ref List<IAntennaRelay> relays)
{ {
// We're going to completely regen this table, so dump the current contents. // We're going to completely regen this table, so dump the current contents.
relays.Clear(); relays.Clear();
   
Tools.PostDebugMessage(string.Format( Logging.PostDebugMessage(string.Format(
"{0}: Getting antenna relays from vessel {1}.", "{0}: Getting antenna relays from vessel {1}.",
"IAntennaRelay", "IAntennaRelay",
vessel.vesselName vessel.vesselName
)); ));
   
  double bestRelayRange = double.NegativeInfinity;
  IAntennaRelay bestRelay = null;
  IAntennaRelay relay;
   
// If the vessel is loaded, we can fetch modules implementing IAntennaRelay directly. // If the vessel is loaded, we can fetch modules implementing IAntennaRelay directly.
if (vessel.loaded) { if (vessel.loaded) {
Tools.PostDebugMessage(string.Format( Logging.PostDebugMessage(string.Format(
"{0}: vessel {1} is loaded, searching for modules in loaded parts.", "{0}: vessel {1} is loaded, searching for modules in loaded parts.",
"IAntennaRelay", "IAntennaRelay",
vessel.vesselName vessel.vesselName
)); ));
   
// Loop through the Parts in the Vessel... // Loop through the Parts in the Vessel...
foreach (Part part in vessel.Parts) Part part;
{ for (int partIdx = 0; partIdx < vessel.Parts.Count; partIdx++)
  {
  part = vessel.Parts[partIdx];
   
// ...loop through the PartModules in the Part... // ...loop through the PartModules in the Part...
foreach (PartModule module in part.Modules) PartModule module;
  for (int modIdx = 0; modIdx < part.Modules.Count; modIdx++)
{ {
  module = part.Modules[modIdx];
   
// ...if the module is a relay... // ...if the module is a relay...
if (module is IAntennaRelay) if (module is IAntennaRelay)
{ {
  relay = (module as IAntennaRelay);
   
  if (relay.maxTransmitDistance > bestRelayRange)
  {
  bestRelayRange = relay.maxTransmitDistance;
  bestRelay = relay;
  }
   
// ...add the module to the table // ...add the module to the table
relays.Add(part.GetHashCode(), module as IAntennaRelay); relays.Add(relay);
// ...neglect relay objects after the first in each part. // ...neglect relay objects after the first in each part.
break; break;
} }
} }
} }
} }
// If the vessel is not loaded, we need to build ProtoAntennaRelays when we find relay ProtoPartSnapshots. // If the vessel is not loaded, we need to build ProtoAntennaRelays when we find relay ProtoPartSnapshots.
else else
{ {
Tools.PostDebugMessage(string.Format( Logging.PostDebugMessage(string.Format(
"{0}: vessel {1} is not loaded, searching for modules in prototype parts.", "{0}: vessel {1} is not loaded, searching for modules in prototype parts.",
this.GetType().Name, this.GetType().Name,
vessel.vesselName vessel.vesselName
)); ));
   
// Loop through the ProtoPartModuleSnapshots in the Vessel... // Loop through the ProtoPartModuleSnapshots in the Vessel...
foreach (ProtoPartSnapshot pps in vessel.protoVessel.protoPartSnapshots) ProtoPartSnapshot pps;
{ for (int ppsIdx = 0; ppsIdx < vessel.protoVessel.protoPartSnapshots.Count; ppsIdx++)
Tools.PostDebugMessage(string.Format( {
  pps = vessel.protoVessel.protoPartSnapshots[ppsIdx];
   
  Logging.PostDebugMessage(string.Format(
"{0}: Searching in protopartsnapshot {1}", "{0}: Searching in protopartsnapshot {1}",
this.GetType().Name, this.GetType().Name,
pps pps
)); ));
   
// ...Fetch the prefab, because it's more useful for what we're doing. // ...Fetch the prefab, because it's more useful for what we're doing.
Part partPrefab = PartLoader.getPartInfoByName(pps.partName).partPrefab; Part partPrefab = PartLoader.getPartInfoByName(pps.partName).partPrefab;
   
Tools.PostDebugMessage(string.Format( Logging.PostDebugMessage(string.Format(
"{0}: Got partPrefab {1} in protopartsnapshot {2}", "{0}: Got partPrefab {1} in protopartsnapshot {2}",
this.GetType().Name, this.GetType().Name,
partPrefab, partPrefab,
pps pps
)); ));
   
// ...loop through the PartModules in the prefab... // ...loop through the PartModules in the prefab...
foreach (PartModule module in partPrefab.Modules) PartModule module;
  for (int modIdx = 0; modIdx < partPrefab.Modules.Count; modIdx++)
{ {
Tools.PostDebugMessage(string.Format( module = partPrefab.Modules[modIdx];
   
  Logging.PostDebugMessage(string.Format(
"{0}: Searching in partmodule {1}", "{0}: Searching in partmodule {1}",
this.GetType().Name, this.GetType().Name,
module module
)); ));
   
// ...if the module is a relay... // ...if the module is a relay...
if (module is IAntennaRelay) if (module is IAntennaRelay)
{ {
Tools.PostDebugMessage(string.Format( Logging.PostDebugMessage(string.Format(
"{0}: partmodule {1} is antennarelay", "{0}: partmodule {1} is antennarelay",
this.GetType().Name, this.GetType().Name,
module module
)); ));
   
  relay = new ProtoAntennaRelay(module as IAntennaRelay, pps);
   
  if (relay.maxTransmitDistance > bestRelayRange)
  {
  bestRelayRange = relay.maxTransmitDistance;
  bestRelay = relay;
  }
   
// ...build a new ProtoAntennaRelay and add it to the table // ...build a new ProtoAntennaRelay and add it to the table
relays.Add(pps.GetHashCode(), new ProtoAntennaRelay(module as IAntennaRelay, pps)); relays.Add(relay);
// ...neglect relay objects after the first in each part. // ...neglect relay objects after the first in each part.
break; break;
} }
} }
} }
} }
   
Tools.PostDebugMessage(string.Format( this.bestRelayTable[vessel.id] = bestRelay;
   
  Logging.PostDebugMessage(string.Format(
"{0}: vessel '{1}' ({2}) has {3} transmitters.", "{0}: vessel '{1}' ({2}) has {3} transmitters.",
"IAntennaRelay", "IAntennaRelay",
vessel.vesselName, vessel.vesselName,
vessel.id, vessel.id,
relays.Count relays.Count
)); ));
} }
   
// Construct the singleton // Construct the singleton
protected RelayDatabase() private RelayDatabase()
{ {
// Initialize the databases // Initialize the databases
this.relayDatabase = new Dictionary<Guid, Dictionary<int, IAntennaRelay>>(); this.relayDatabase = new Dictionary<Guid, List<IAntennaRelay>>();
  this.bestRelayTable = new Dictionary<Guid, IAntennaRelay>();
this.vesselPartCountTable = new Dictionary<Guid, int>(); this.vesselPartCountTable = new Dictionary<Guid, int>();
this.CheckedVesselsTable = new Dictionary<Guid, bool>();  
   
this.cacheHits = 0; this.cacheHits = 0;
this.cacheMisses = 0; this.cacheMisses = 0;
   
// Subscribe to some events // Subscribe to some events
GameEvents.onVesselWasModified.Add(this.onVesselEvent); GameEvents.onVesselWasModified.Add(this.onVesselEvent);
GameEvents.onVesselChange.Add(this.onVesselEvent); GameEvents.onVesselChange.Add(this.onVesselEvent);
GameEvents.onVesselDestroy.Add(this.onVesselEvent); GameEvents.onVesselDestroy.Add(this.onVesselEvent);
GameEvents.onGameSceneLoadRequested.Add(this.onSceneChange); GameEvents.onGameSceneLoadRequested.Add(this.onSceneChange);
GameEvents.onPartCouple.Add(this.onFromPartToPartEvent); GameEvents.onPartCouple.Add(this.onFromPartToPartEvent);
GameEvents.onPartUndock.Add(this.onPartEvent); GameEvents.onPartUndock.Add(this.onPartEvent);
  GameEvents.onGameStateLoad.Add(this.onGameLoaded);
} }
   
~RelayDatabase() ~RelayDatabase()
{ {
// Unsubscribe from the events // Unsubscribe from the events
GameEvents.onVesselWasModified.Remove(this.onVesselEvent); GameEvents.onVesselWasModified.Remove(this.onVesselEvent);
GameEvents.onVesselChange.Remove(this.onVesselEvent); GameEvents.onVesselChange.Remove(this.onVesselEvent);
GameEvents.onVesselDestroy.Remove(this.onVesselEvent); GameEvents.onVesselDestroy.Remove(this.onVesselEvent);
GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChange); GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChange);
GameEvents.onPartCouple.Remove(this.onFromPartToPartEvent); GameEvents.onPartCouple.Remove(this.onFromPartToPartEvent);
GameEvents.onPartUndock.Remove(this.onPartEvent); GameEvents.onPartUndock.Remove(this.onPartEvent);
  GameEvents.onGameStateLoad.Remove(this.onGameLoaded);
Tools.PostDebugMessage(this.GetType().Name + " destroyed.");  
  Logging.PostDebugMessage(this.GetType().Name + " destroyed.");
   
KSPLog.print(string.Format( KSPLog.print(string.Format(
"{0} destructed. Cache hits: {1}, misses: {2}, hit rate: {3:P1}", "{0} destructed. Cache hits: {1}, misses: {2}, hit rate: {3:P1}",
this.GetType().Name, this.GetType().Name,
this.cacheHits, this.cacheHits,
this.cacheMisses, this.cacheMisses,
(float)this.cacheHits / (float)(this.cacheMisses + this.cacheHits) (float)this.cacheHits / (float)(this.cacheMisses + this.cacheHits)
)); ));
} }
   
#if DEBUG #if DEBUG
public void Dump() public void Dump()
{ {
StringBuilder sb = new StringBuilder(); using (ToadicusTools.Text.PooledStringBuilder sb = ToadicusTools.Text.PooledStringBuilder.Get())
  {
sb.Append("Dumping RelayDatabase:"); sb.Append("Dumping RelayDatabase:");
   
foreach (Guid id in this.relayDatabase.Keys) var dbEnum = this.relayDatabase.GetEnumerator();
{ IList<IAntennaRelay> vesselRelays;
sb.AppendFormat("\nVessel {0}:", id); while (dbEnum.MoveNext())
  {
foreach (IAntennaRelay relay in this.relayDatabase[id].Values) sb.AppendFormat("\nVessel {0}:", dbEnum.Current.Key);
{  
sb.AppendFormat("\n\t{0}", relay.ToString()); vesselRelays = dbEnum.Current.Value;
} IAntennaRelay relay;
} for (int rIdx = 0; rIdx < vesselRelays.Count; rIdx++)
  {
Tools.PostDebugMessage(sb.ToString()); relay = vesselRelays[rIdx];
  sb.AppendFormat("\n\t{0}", relay.ToString());
  }
  }
   
  Logging.PostDebugMessage(sb.ToString());
  }
} }
#endif #endif
} }
} }
   
   
// AntennaRange // AntennaRange
// //
// Extensions.cs // Extensions.cs
// //
// Copyright © 2014, toadicus // Copyright © 2014-2015, toadicus
// All rights reserved. // All rights reserved.
// //
// Redistribution and use in source and binary forms, with or without modification, // Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met: // are permitted provided that the following conditions are met:
// //
// 1. Redistributions of source code must retain the above copyright notice, // 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer. // this list of conditions and the following disclaimer.
// //
// 2. Redistributions in binary form must reproduce the above copyright notice, // 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation and/or other // this list of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution. // materials provided with the distribution.
// //
// 3. Neither the name of the copyright holder nor the names of its contributors may be used // 3. Neither the name of the copyright holder nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific prior written permission. // to endorse or promote products derived from this software without specific prior written permission.
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using ToadicusTools.Extensions;
using ToadicusTools;  
   
namespace AntennaRange namespace AntennaRange
{ {
/* /// <summary>
* A class of utility extensions for Vessels and Relays to help find a relay path back to Kerbin. /// A class of utility extensions for Vessels and Relays to help find a relay path back to Kerbin.
* */ /// </summary>
public static class RelayExtensions public static class RelayExtensions
{ {
  /// <summary>
  /// Returns the distance between two IAntennaRelays.
  /// </summary>
  /// <param name="relayOne">Relay one.</param>
  /// <param name="relayTwo">Relay two.</param>
  public static double DistanceTo(this IAntennaRelay relayOne, IAntennaRelay relayTwo)
  {
  return relayOne.vessel.DistanceTo(relayTwo.vessel);
  }
   
  /// <summary>
  /// Returns the distance from this IAntennaRelay to the given CelestialBody
  /// </summary>
  /// <param name="relay">Relay.</param>
  /// <param name="body">Body.</param>
  public static double SqrDistanceTo(this IAntennaRelay relay, CelestialBody body)
  {
  double range = relay.vessel.DistanceTo(body) - body.Radius;
   
  return range * range;
  }
   
  /// <summary>
  /// Returns the distance between two IAntennaRelays.
  /// </summary>
  /// <param name="relayOne">Relay one.</param>
  /// <param name="relayTwo">Relay two.</param>
  public static double SqrDistanceTo(this IAntennaRelay relayOne, IAntennaRelay relayTwo)
  {
  return relayOne.vessel.sqrDistanceTo(relayTwo.vessel);
  }
   
  /// <summary>
  /// Returns the distance from this IAntennaRelay to the given CelestialBody
  /// </summary>
  /// <param name="relay">Relay.</param>
  /// <param name="body">Body.</param>
  public static double DistanceTo(this IAntennaRelay relay, CelestialBody body)
  {
  double range = relay.vessel.DistanceTo(body) - body.Radius;
   
  return range;
  }
   
/// <summary> /// <summary>
/// Returns the distance between this IAntennaRelay and a Vessel /// Returns the distance between this IAntennaRelay and a Vessel
/// </summary> /// </summary>
/// <param name="relay">This <see cref="IAntennaRelay"/></param> /// <param name="relay">This <see cref="IAntennaRelay"/></param>
/// <param name="Vessel">A <see cref="Vessel"/></param> /// <param name="Vessel">A <see cref="Vessel"/></param>
public static double DistanceTo(this AntennaRelay relay, Vessel Vessel) public static double DistanceTo(this AntennaRelay relay, Vessel Vessel)
{ {
return relay.vessel.DistanceTo(Vessel); return relay.vessel.DistanceTo(Vessel);
} }
   
/// <summary> /// <summary>
/// Returns the distance between this IAntennaRelay and a CelestialBody /// Returns the distance between this IAntennaRelay and a CelestialBody
/// </summary> /// </summary>
/// <param name="relay">This <see cref="IAntennaRelay"/></param> /// <param name="relay">This <see cref="IAntennaRelay"/></param>
/// <param name="body">A <see cref="CelestialBody"/></param> /// <param name="body">A <see cref="CelestialBody"/></param>
public static double DistanceTo(this AntennaRelay relay, CelestialBody body) public static double DistanceTo(this AntennaRelay relay, CelestialBody body)
{ {
return relay.vessel.DistanceTo(body) - body.Radius; return relay.vessel.DistanceTo(body) - body.Radius;
} }
   
/// <summary> /// <summary>
/// Returns the distance between this IAntennaRelay and another IAntennaRelay /// Returns the distance between this IAntennaRelay and another IAntennaRelay
/// </summary> /// </summary>
/// <param name="relayOne">This <see cref="IAntennaRelay"/></param> /// <param name="relayOne">This <see cref="IAntennaRelay"/></param>
/// <param name="relayTwo">Another <see cref="IAntennaRelay"/></param> /// <param name="relayTwo">Another <see cref="IAntennaRelay"/></param>
public static double DistanceTo(this AntennaRelay relayOne, IAntennaRelay relayTwo) public static double DistanceTo(this AntennaRelay relayOne, IAntennaRelay relayTwo)
{ {
return relayOne.DistanceTo(relayTwo.vessel); return relayOne.DistanceTo(relayTwo.vessel);
} }
   
public static double sqrDistanceTo(this AntennaRelay relay, Vessel vessel) /// <summary>
  /// Returns the square of the distance between this IAntennaRelay and a Vessel
  /// </summary>
  /// <param name="relay">This <see cref="IAntennaRelay"/></param>
  /// <param name="vessel">A <see cref="Vessel"/></param>
  public static double SqrDistanceTo(this AntennaRelay relay, Vessel vessel)
{ {
return relay.vessel.sqrDistanceTo(vessel); return relay.vessel.sqrDistanceTo(vessel);
} }
   
public static double sqrDistanceTo(this AntennaRelay relay, CelestialBody body) /// <summary>
{ /// Returns the square of the distance between this IAntennaRelay and a CelestialBody
return relay.vessel.sqrDistanceTo(body); /// </summary>
} /// <param name="relay">This <see cref="IAntennaRelay"/></param>
  /// <param name="body">A <see cref="CelestialBody"/></param>
public static double sqrDistanceTo(this AntennaRelay relayOne, IAntennaRelay relayTwo) public static double SqrDistanceTo(this AntennaRelay relay, CelestialBody body)
  {
  double dist = (relay.vessel.GetWorldPos3D() - body.position).magnitude - body.Radius;
   
  return dist * dist;
  }
   
  /// <summary>
  /// Returns the square of the distance between this IAntennaRelay and another IAntennaRelay
  /// </summary>
  /// <param name="relayOne">This <see cref="IAntennaRelay"/></param>
  /// <param name="relayTwo">Another <see cref="IAntennaRelay"/></param>
  public static double SqrDistanceTo(this AntennaRelay relayOne, IAntennaRelay relayTwo)
{ {
return relayOne.vessel.sqrDistanceTo(relayTwo.vessel); return relayOne.vessel.sqrDistanceTo(relayTwo.vessel);
} }
   
/// <summary> /// <summary>
  /// Returns the square of the maximum link range between two relays.
  /// </summary>
  /// <returns>The maximum link range between two relays.</returns>
  /// <param name="relayOne">Relay one.</param>
  /// <param name="relayTwo">Relay two.</param>
  public static double MaxLinkSqrDistanceTo(this AntennaRelay relayOne, IAntennaRelay relayTwo)
  {
  if (ARConfiguration.UseAdditiveRanges)
  {
  return relayOne.maxTransmitDistance * relayTwo.maxTransmitDistance;
  }
  else
  {
  return relayOne.maxTransmitDistance * relayOne.maxTransmitDistance;
  }
  }
   
  /// <summary>
  /// Returns the square of the maximum link range between a relay and Kerbin.
  /// </summary>
  /// <returns>The maximum link range between a relay and Kerbin.</returns>
  /// <param name="relayOne">Relay one.</param>
  /// <param name="body">A CelestialBody (must be Kerbin).</param>
  public static double MaxLinkSqrDistanceTo(this AntennaRelay relayOne, CelestialBody body)
  {
  if (body != AntennaRelay.Kerbin)
  {
  return 0d;
  }
   
  if (ARConfiguration.UseAdditiveRanges)
  {
  return relayOne.maxTransmitDistance * ARConfiguration.KerbinRelayRange;
  }
  else
  {
  return relayOne.maxTransmitDistance * relayOne.maxTransmitDistance;
  }
  }
   
  /// <summary>
  /// Determines if relayOne is in range of the specified relayTwo.
  /// </summary>
  /// <returns><c>true</c> if relayOne is in range of the specifie relayTwo; otherwise, <c>false</c>.</returns>
  /// <param name="relayOne">Relay one.</param>
  /// <param name="relayTwo">Relay two.</param>
  public static bool IsInRangeOf(this AntennaRelay relayOne, IAntennaRelay relayTwo)
  {
  if (relayOne == null || relayTwo == null)
  {
  return false;
  }
   
  return relayOne.SqrDistanceTo(relayTwo) <= relayOne.MaxLinkSqrDistanceTo(relayTwo);
  }
   
  /// <summary>
  /// Determines if relayOne is in range of the specified body.
  /// </summary>
  /// <returns><c>true</c> if relayOne is in range of the specified body; otherwise, <c>false</c>.</returns>
  /// <param name="relayOne">Relay one.</param>
  /// <param name="body">Body.</param>
  public static bool IsInRangeOf(this AntennaRelay relayOne, CelestialBody body)
  {
  if (relayOne == null || body == null)
  {
  return false;
  }
   
  return relayOne.SqrDistanceTo(body) <= relayOne.MaxLinkSqrDistanceTo(body);
  }
   
  /// <summary>
/// Returns all of the PartModules or ProtoPartModuleSnapshots implementing IAntennaRelay in this Vessel. /// Returns all of the PartModules or ProtoPartModuleSnapshots implementing IAntennaRelay in this Vessel.
/// </summary> /// </summary>
/// <param name="vessel">This <see cref="Vessel"/></param> /// <param name="vessel">This <see cref="Vessel"/></param>
public static IEnumerable<IAntennaRelay> GetAntennaRelays (this Vessel vessel) public static IList<IAntennaRelay> GetAntennaRelays (this Vessel vessel)
{ {
return RelayDatabase.Instance[vessel].Values.ToList().AsReadOnly(); return RelayDatabase.Instance[vessel];
} }
   
/// <summary> /// <summary>
/// Determines if the specified vessel has a connected relay. /// Determines if the specified vessel has a connected relay.
/// </summary> /// </summary>
/// <returns><c>true</c> if the specified vessel has a connected relay; otherwise, <c>false</c>.</returns> /// <returns><c>true</c> if the specified vessel has a connected relay; otherwise, <c>false</c>.</returns>
/// <param name="vessel"></param> /// <param name="vessel"></param>
public static bool HasConnectedRelay(this Vessel vessel) public static bool HasConnectedRelay(this Vessel vessel)
{ {
foreach (IAntennaRelay relay in RelayDatabase.Instance[vessel].Values) IList<IAntennaRelay> vesselRelays = RelayDatabase.Instance[vessel];
{ IAntennaRelay relay;
  for (int rIdx = 0; rIdx < vesselRelays.Count; rIdx++)
  {
  relay = vesselRelays[rIdx];
if (relay.CanTransmit()) if (relay.CanTransmit())
{ {
return true; return true;
} }
} }
   
return false; return false;
} }
   
  /// <summary>
  /// Gets the <see cref="AntennaRange.ConnectionStatus"/> for this <see cref="Vessel"/>
  /// </summary>
  /// <param name="vessel">This <see cref="Vessel"/></param>
public static ConnectionStatus GetConnectionStatus(this Vessel vessel) public static ConnectionStatus GetConnectionStatus(this Vessel vessel)
{ {
bool canTransmit = false; bool canTransmit = false;
   
foreach (IAntennaRelay relay in RelayDatabase.Instance[vessel].Values) IList<IAntennaRelay> vesselRelays = RelayDatabase.Instance[vessel];
{ IAntennaRelay relay;
if (relay.CanTransmit()) for (int rIdx = 0; rIdx < vesselRelays.Count; rIdx++)
  {
  relay = vesselRelays[rIdx];
  if (relay.LinkStatus > ConnectionStatus.None)
{ {
canTransmit = true; canTransmit = true;
if (relay.transmitDistance <= relay.nominalTransmitDistance)  
  if (relay.LinkStatus == ConnectionStatus.Optimal)
{ {
return ConnectionStatus.Optimal; return ConnectionStatus.Optimal;
} }
} }
} }
   
if (canTransmit) if (canTransmit)
{ {
return ConnectionStatus.Suboptimal; return ConnectionStatus.Suboptimal;
} }
else else
{ {
return ConnectionStatus.None; return ConnectionStatus.None;
} }
} }
   
  /// <summary>
  /// Gets the best relay on this Vessel. The best relay may not be able to transmit.
  /// </summary>
  /// <param name="vessel">This <see cref="Vessel"/></param>
  public static IAntennaRelay GetBestRelay(this Vessel vessel)
  {
  return RelayDatabase.Instance.GetBestVesselRelay(vessel);
  }
   
  /// <summary>
  /// Logs a message on behalf of this relay
  /// </summary>
  public static void Log(this AntennaRelay relay, string format, params object[] args)
  {
  ToadicusTools.Logging.PostLogMessage(string.Format("[{0}] {1}", relay.ToString(), format), args);
  }
   
  /// <summary>
  /// Logs a message on behalf of this relay
  /// </summary>
  public static void Log(this AntennaRelay relay, string msg)
  {
  ToadicusTools.Logging.PostLogMessage("[{0}] {1}", relay.ToString(), msg);
  }
   
  /// <summary>
  /// Logs a warning message on behalf of this relay
  /// </summary>
  public static void LogWarning(this AntennaRelay relay, string format, params object[] args)
  {
  ToadicusTools.Logging.PostWarningMessage(string.Format("[{0}] {1}", relay.ToString(), format), args);
  }
   
  /// <summary>
  /// Logs a warning message on behalf of this relay
  /// </summary>
  public static void LogWarning(this AntennaRelay relay, string msg)
  {
  ToadicusTools.Logging.PostWarningMessage("[{0}] {1}", relay.ToString(), msg);
  }
   
  /// <summary>
  /// Logs an error message on behalf of this relay
  /// </summary>
  public static void LogError(this AntennaRelay relay, string format, params object[] args)
  {
  ToadicusTools.Logging.PostErrorMessage(string.Format("[{0}] {1}", relay.ToString(), format), args);
  }
   
  /// <summary>
  /// Logs an error message on behalf of this relay
  /// </summary>
  public static void LogError(this AntennaRelay relay, string msg)
  {
  ToadicusTools.Logging.PostErrorMessage("[{0}] {1}", relay.ToString(), msg);
  }
   
  /// <summary>
  /// Logs a debug-only message on behalf of this relay
  /// </summary>
  [System.Diagnostics.Conditional("DEBUG")]
  public static void LogDebug(this AntennaRelay relay, string format, params object[] args)
  {
  ToadicusTools.Logging.PostDebugMessage(string.Format("[{0}] {1}", relay.ToString(), format), args);
  }
   
  /// <summary>
  /// Logs a debug-only message on behalf of this relay
  /// </summary>
  [System.Diagnostics.Conditional("DEBUG")]
  public static void LogDebug(this AntennaRelay relay, string msg)
  {
  ToadicusTools.Logging.PostDebugMessage("[{0}] {1}", relay.ToString(), msg);
  }
} }
   
  #pragma warning disable 1591
  /// <summary>
  /// An Enum describing the connection status of a vessel or relay.
  /// </summary>
public enum ConnectionStatus public enum ConnectionStatus
{ {
None, None,
Suboptimal, Suboptimal,
Optimal Optimal
} }
} }