ARFlightController: Trying to tweak the ordering of things to help networks resolve more neatly.
[AntennaRange.git] /
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
// AntennaRange
//
// Extensions.cs
//
// Copyright © 2014-2015, 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 System.Collections.Generic;
using ToadicusTools.Extensions;

namespace AntennaRange
{
	/// <summary>
	/// A class of utility extensions for Vessels and Relays to help find a relay path back to Kerbin.
	/// </summary>
	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>
		/// Returns 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 DistanceTo(this AntennaRelay relay, Vessel Vessel)
		{
			return relay.vessel.DistanceTo(Vessel);
		}

		/// <summary>
		/// Returns the distance between this IAntennaRelay and a CelestialBody
		/// </summary>
		/// <param name="relay">This <see cref="IAntennaRelay"/></param>
		/// <param name="body">A <see cref="CelestialBody"/></param>
		public static double DistanceTo(this AntennaRelay relay, CelestialBody body)
		{
			return relay.vessel.DistanceTo(body) - body.Radius;
		}

		/// <summary>
		/// Returns 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 DistanceTo(this AntennaRelay relayOne, IAntennaRelay relayTwo)
		{
			return relayOne.DistanceTo(relayTwo.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);
		}

		/// <summary>
		/// Returns the square of the distance between this IAntennaRelay and a CelestialBody
		/// </summary>
		/// <param name="relay">This <see cref="IAntennaRelay"/></param>
		/// <param name="body">A <see cref="CelestialBody"/></param>
		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);
		}

		/// <summary>
		/// Returns all of the PartModules or ProtoPartModuleSnapshots implementing IAntennaRelay in this Vessel.
		/// </summary>
		/// <param name="vessel">This <see cref="Vessel"/></param>
		public static IList<IAntennaRelay> GetAntennaRelays (this Vessel vessel)
		{
			return RelayDatabase.Instance[vessel];
		}

		/// <summary>
		/// Determines if the specified vessel has a connected relay.
		/// </summary>
		/// <returns><c>true</c> if the specified vessel has a connected relay; otherwise, <c>false</c>.</returns>
		/// <param name="vessel"></param>
		public static bool HasConnectedRelay(this Vessel vessel)
		{
			IList<IAntennaRelay> vesselRelays = RelayDatabase.Instance[vessel];
			IAntennaRelay relay;
			for (int rIdx = 0; rIdx < vesselRelays.Count; rIdx++)
			{
				relay = vesselRelays[rIdx];
				if (relay.CanTransmit())
				{
					return true;
				}
			}

			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)
		{
			bool canTransmit = false;

			IList<IAntennaRelay> vesselRelays = RelayDatabase.Instance[vessel];
			IAntennaRelay relay;
			for (int rIdx = 0; rIdx < vesselRelays.Count; rIdx++)
			{
				relay = vesselRelays[rIdx];
				if (relay.LinkStatus > ConnectionStatus.None)
				{
					canTransmit = true;

					if (relay.LinkStatus == ConnectionStatus.Optimal)
					{
						return ConnectionStatus.Optimal;
					}
				}
			}

			if (canTransmit)
			{
				return ConnectionStatus.Suboptimal;
			}
			else
			{
				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
	{
		None,
		Suboptimal,
		Optimal
	}
}