Created wrapper for handling the Application Launcher buttons.
[VesselSimulator.git] / KerbalEngineer / AppLauncherButton.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
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
// 
//     Kerbal Engineer Redux
// 
//     Copyright (C) 2016 CYBUTEK
// 
//     This program is free software: you can redistribute it and/or modify
//     it under the terms of the GNU General Public License as published by
//     the Free Software Foundation, either version 3 of the License, or
//     (at your option) any later version.
// 
//     This program is distributed in the hope that it will be useful,
//     but WITHOUT ANY WARRANTY; without even the implied warranty of
//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//     GNU General Public License for more details.
//     You should have received a copy of the GNU General Public License
//     along with this program.  If not, see <http://www.gnu.org/licenses/>.
//  
 
namespace KerbalEngineer
{
    using KSP.UI.Screens;
    using UnityEngine;
 
    public class AppLauncherButton : MonoBehaviour
    {
        public enum ButtonState
        {
            Disabled,
            On,
            Off
        }
 
        private ApplicationLauncherButton m_Button;
 
        /// <summary>
        ///     Sets the state of the button.
        /// </summary>
        public void SetState(ButtonState state)
        {
            if (m_Button == null)
            {
                return;
            }
 
            switch (state)
            {
                case ButtonState.Disabled:
                    Disable();
                    break;
 
                case ButtonState.On:
                    Enable();
                    m_Button.SetTrue();
                    break;
 
                case ButtonState.Off:
                    Enable();
                    m_Button.SetFalse();
                    break;
            }
        }
 
        protected virtual void Awake()
        {
            // subscribe event listeners
            GameEvents.onGUIApplicationLauncherReady.Add(OnGUIApplicationLauncherReady);
            GameEvents.onGUIApplicationLauncherUnreadifying.Add(OnGUIApplicationLauncherUnreadifying);
        }
 
        protected virtual void OnDestroy()
        {
            // unsubscribe event listeners
            GameEvents.onGUIApplicationLauncherReady.Remove(OnGUIApplicationLauncherReady);
            GameEvents.onGUIApplicationLauncherUnreadifying.Remove(OnGUIApplicationLauncherUnreadifying);
        }
 
        /// <summary>
        ///     Called on button being disabled.
        /// </summary>
        protected virtual void OnDisable() { }
 
        /// <summary>
        ///     Called on button being enabled.
        /// </summary>
        protected virtual void OnEnable() { }
 
        /// <summary>
        ///     Called on button being toggled off.
        /// </summary>
        protected virtual void OnFalse() { }
 
        /// <summary>
        ///     Called on mouse hovering.
        /// </summary>
        protected virtual void OnHover() { }
 
        /// <summary>
        ///     Called on mouse exiting hover.
        /// </summary>
        protected virtual void OnHoverOut() { }
 
        /// <summary>
        ///     Called on button being ready.
        /// </summary>
        protected virtual void OnReady() { }
 
        /// <summary>
        ///     Called after the application launcher is ready and the button created.
        /// </summary>
        protected virtual void OnTrue() { }
 
        /// <summary>
        ///     Called after the application launcher is unreadified and the button removed.
        /// </summary>
        protected virtual void OnUnreadifying() { }
 
        /// <summary>
        ///     Disables the button if not already disabled.
        /// </summary>
        private void Disable()
        {
            if (m_Button != null && m_Button.toggleButton.Button.interactable)
            {
                m_Button.Disable();
            }
        }
 
        /// <summary>
        ///     Enables the button if not already enabled.
        /// </summary>
        private void Enable()
        {
            if (m_Button != null && m_Button.toggleButton.Button.interactable == false)
            {
                m_Button.Enable();
            }
        }
 
        private void OnGUIApplicationLauncherReady()
        {
            // create button
            if (ApplicationLauncher.Instance != null)
            {
                Texture iconTexture = GameDatabase.Instance.GetTexture("KerbalEngineer/Textures/ToolbarIcon", false);
                m_Button = ApplicationLauncher.Instance.AddModApplication(OnTrue, OnFalse, OnHover, OnHoverOut, OnEnable, OnDisable, ApplicationLauncher.AppScenes.ALWAYS, iconTexture);
            }
 
            OnReady();
        }
 
        private void OnGUIApplicationLauncherUnreadifying(GameScenes scene)
        {
            // remove button
            if (ApplicationLauncher.Instance != null && m_Button != null)
            {
                ApplicationLauncher.Instance.RemoveModApplication(m_Button);
            }
 
            OnUnreadifying();
        }
    }
}