Added a configuration window to the spacecenter for the toggling of options, and cleaned up some failure reporting a bit.
[AntennaRange.git] / RelayExtensions.cs
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
// AntennaRange
//
// Extensions.cs
//
// Copyright © 2014, 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 System.Linq;
using ToadicusTools;
 
namespace AntennaRange
{
        /*
         * A class of utility extensions for Vessels and Relays to help find a relay path back to Kerbin.
         * */
        public static class RelayExtensions
        {
                /// <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);
                }
 
                /// <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 all of the PartModules or ProtoPartModuleSnapshots implementing IAntennaRelay in this Vessel.
                /// </summary>
                /// <param name="vessel">This <see cref="Vessel"/></param>
                public static IEnumerable<IAntennaRelay> GetAntennaRelays (this Vessel vessel)
                {
                        return RelayDatabase.Instance[vessel].Values.ToList();
                }
        }
}