File: LightingPresets.cpp

package info (click to toggle)
freespace2-launcher-wxlauncher 0.11.0%2Bdfsg-1
  • links: PTS, VCS
  • area: contrib
  • in suites: stretch
  • size: 2,372 kB
  • ctags: 1,443
  • sloc: cpp: 13,446; python: 797; makefile: 13; sh: 12
file content (278 lines) | stat: -rw-r--r-- 12,151 bytes parent folder | download | duplicates (7)
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
/*
 Copyright (C) 2009-2011 wxLauncher Team
 
 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 2
 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, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#include "controls/LightingPresets.h"

#include "apis/ProfileProxy.h"
#include "apis/TCManager.h"

#include "controls/ModList.h"

#include "global/ids.h"
#include "global/MemoryDebugging.h"
#include "global/ModDefaults.h"

#include "generated/configure_launcher.h"

#include <wx/gbsizer.h>
#include <wx/hyperlink.h>

Preset::Preset(const wxString& name, const int buttonId, const wxString& flagSet):
	name(name), buttonId(buttonId), flagSet(flagSet) {
}

void Preset::SetFlagSet(const wxString& flagSet) {
	wxCHECK_RET(!flagSet.IsEmpty(), _T("SetFlagSet() given empty flag set!"));
	
	this->flagSet = flagSet;
}

// vertical spacing between radio buttons is platform-specific
#if IS_WIN32
const int RADIOBUTTON_SPACING = 20;
#elif IS_LINUX
const int RADIOBUTTON_SPACING = 5;
#else
const int RADIOBUTTON_SPACING = 10;
#endif

const int DEFAULT_PRESET_ID = ID_PRESETS_OFF;
PresetHashMap LightingPresets::presets;

LightingPresets::LightingPresets(wxWindow* parent) : wxPanel(parent, wxID_ANY) {
	if (presets.size() == 0) {
		InitializePresets();
	}
	
	TCManager::RegisterTCActiveModChanged(this);
	ProfileProxy::GetProxy()->RegisterProxyFlagDataReady(this);
	
	wxStaticBox* lightingPresetsBox = new wxStaticBox(this, wxID_ANY, _("Lighting presets"));
	
	wxHyperlinkCtrl* presetDescsUrl =
		new wxHyperlinkCtrl(this, wxID_ANY, _T("Preset descriptions"),
							_T("http://www.hard-light.net/wiki/index.php/Sample_Lighting_Settings"));
	wxButton* customFlagsCopyButton =
		new wxButton(this, ID_COPY_PRESET_BUTTON, _T("Copy selected preset to custom flags"));
	wxRadioButton* radioButton1 = new wxRadioButton (this, ID_PRESETS_OFF, _T("Presets off"),
													 wxDefaultPosition, wxDefaultSize, wxRB_GROUP);
	wxRadioButton* radioButton2 =
		new wxRadioButton (this, ID_PRESET_BASELINE,
						   DEFAULT_MOD_RECOMMENDED_LIGHTING_NAME);
	wxRadioButton* radioButton3 = new wxRadioButton (this, ID_PRESET_DABRAIN, _T("DaBrain's"));
	wxRadioButton* radioButton4 = new wxRadioButton (this, ID_PRESET_HERRA_TOHTORI, _T("Herra Tohtori's"));
	wxRadioButton* radioButton5 = new wxRadioButton (this, ID_PRESET_CKID, _T("CKid's"));
	wxRadioButton* radioButton6 = new wxRadioButton (this, ID_PRESET_COLECAMPBELL666, _T("ColeCampbell666's"));
	wxRadioButton* radioButton7 = new wxRadioButton (this, ID_PRESET_CASTOR, _T("Castor's"));
	wxRadioButton* radioButton8 = new wxRadioButton (this, ID_PRESET_SPIDEY, _T("Spidey's"));
	wxRadioButton* radioButton9 = new wxRadioButton (this, ID_PRESET_WOOLIE_WOOL, _T("Woolie Wool's"));

	this->Initialize();

	wxGridBagSizer* lightingInsideSizer = new wxGridBagSizer();
	lightingInsideSizer->Add(presetDescsUrl, wxGBPosition(0,0), wxGBSpan(1,1),
		wxALIGN_CENTER_HORIZONTAL|wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(customFlagsCopyButton, wxGBPosition(1,0), wxGBSpan(1,1),
		wxALIGN_CENTER_HORIZONTAL|wxBOTTOM, RADIOBUTTON_SPACING + 5);
	lightingInsideSizer->Add(radioButton1, wxGBPosition(2,0), wxGBSpan(1,1), wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton2, wxGBPosition(3,0), wxGBSpan(1,1), wxEXPAND|wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton3, wxGBPosition(4,0), wxGBSpan(1,1), wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton4, wxGBPosition(5,0), wxGBSpan(1,1), wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton5, wxGBPosition(6,0), wxGBSpan(1,1), wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton6, wxGBPosition(7,0), wxGBSpan(1,1), wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton7, wxGBPosition(8,0), wxGBSpan(1,1), wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton8, wxGBPosition(9,0), wxGBSpan(1,1), wxBOTTOM, RADIOBUTTON_SPACING);
	lightingInsideSizer->Add(radioButton9, wxGBPosition(10,0), wxGBSpan(1,1));

	wxStaticBoxSizer* lightingPresetsSizer = new wxStaticBoxSizer(lightingPresetsBox, wxHORIZONTAL);
	lightingPresetsSizer->Add(lightingInsideSizer, wxSizerFlags().Expand().Border(wxALL, 5));
	
	this->SetSizer(lightingPresetsSizer);
}

void LightingPresets::InitializePresets() {
	wxASSERT_MSG(presets.size() == 0, _T("presets have already been initialized"));

	presets[ID_PRESETS_OFF] = Preset(_T("Off"), ID_PRESETS_OFF, wxEmptyString);
	presets[ID_PRESET_BASELINE] =
		Preset(_T("BaselineRecommended"), ID_PRESET_BASELINE,
			   DEFAULT_MOD_RECOMMENDED_LIGHTING_FLAGSET);
	presets[ID_PRESET_DABRAIN] =
		Preset(_T("DaBrain"), ID_PRESET_DABRAIN,
			   _T("-ambient_factor 10 -no_emissive_light -spec_exp 7.0 -spec_point 8.6 -spec_static 12.8 -spec_tube 5.0"));
	presets[ID_PRESET_HERRA_TOHTORI] =
		Preset(_T("HerraTohtori"), ID_PRESET_HERRA_TOHTORI,
			   _T("-ambient_factor 35 -no_emissive_light -spec_exp 15 -spec_point 1.2 -spec_static 1.5 -spec_tube 1.5 -ogl_spec 20"));
	presets[ID_PRESET_CKID] =
		Preset(_T("CKid"), ID_PRESET_CKID,
			   _T("-ambient_factor 35 -no_emissive_light -spec_exp 16.7 -spec_point 0.6 -spec_static 0.9 -spec_tube 1"));
	presets[ID_PRESET_COLECAMPBELL666] =
		Preset(_T("ColeCampbell666"), ID_PRESET_COLECAMPBELL666,
			   _T("-ambient_factor 0 -no_emissive_light -spec_exp 11 -spec_point .6 -spec_static .8 -spec_tube .4 -ogl_spec 80"));
	presets[ID_PRESET_CASTOR] =
		Preset(_T("Castor"), ID_PRESET_CASTOR,
			   _T("-ambient_factor 75 -spec_exp 7.0 -spec_point 8.6 -spec_static 3.0 -spec_tube 5.0"));
	presets[ID_PRESET_SPIDEY] =
		Preset(_T("Spidey"), ID_PRESET_SPIDEY,
			   _T("-ambient_factor 5 -spec_exp 15 -spec_point 1.2 -spec_static 1.7 -spec_tube 1.5 -ogl_spec 50"));
	presets[ID_PRESET_WOOLIE_WOOL] =
		Preset(_T("WoolieWool"), ID_PRESET_WOOLIE_WOOL,
		   _T("-ambient_factor 105 -no_emissive_light -spec_exp 9 -spec_point 0.3 -spec_static 0.8 -spec_tube 0.7 -ogl_spec 120"));
}

BEGIN_EVENT_TABLE(LightingPresets, wxPanel)
EVT_BUTTON(ID_COPY_PRESET_BUTTON, LightingPresets::OnCopyLightingPreset)
EVT_RADIOBUTTON(ID_PRESETS_OFF, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_BASELINE, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_DABRAIN, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_HERRA_TOHTORI, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_CKID, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_COLECAMPBELL666, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_CASTOR, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_SPIDEY, LightingPresets::OnSelectLightingPreset)
EVT_RADIOBUTTON(ID_PRESET_WOOLIE_WOOL, LightingPresets::OnSelectLightingPreset)
EVT_COMMAND(wxID_NONE, EVT_TC_ACTIVE_MOD_CHANGED, LightingPresets::OnActiveModChanged)
EVT_COMMAND(wxID_NONE, EVT_PROXY_FLAG_DATA_READY, LightingPresets::OnProxyFlagDataReady)
END_EVENT_TABLE()

void LightingPresets::OnSelectLightingPreset(wxCommandEvent &event) {
	int id = event.GetId();
	const wxString& presetName = PresetButtonIdToPresetName(id);
	
	wxLogDebug(_T("lighting preset %s selected"), presetName.c_str());
	
	wxButton* copyPresetButton =
		dynamic_cast<wxButton*>(wxWindow::FindWindowById(ID_COPY_PRESET_BUTTON, this));
	wxCHECK_RET( copyPresetButton != NULL, _T("Unable to find copy lighting preset button"));
	
	if (id == ID_PRESETS_OFF) {
		copyPresetButton->Disable();
	} else {
		copyPresetButton->Enable();
	}
	
	ProfileProxy::GetProxy()->SetLightingPreset(presetName);
}

void LightingPresets::OnCopyLightingPreset(wxCommandEvent &WXUNUSED(event)) {
	wxASSERT_MSG(presets.size() != 0, _T("presets have not been initialized"));

	wxCHECK_RET(ProfileProxy::GetProxy()->HasLightingPreset(),
		_T("copy lighting preset button pressed with no preset stored in profile"));
	
	wxString presetName(ProfileProxy::GetProxy()->GetLightingPresetName());

	wxCHECK_RET(presetName != presets[ID_PRESETS_OFF].GetName(),
				_T("copy lighting preset button pressed when 'presets off' is selected"));

	wxLogDebug(_T("attempting to copy preset named %s to custom flags"), presetName.c_str());

	ProfileProxy::GetProxy()->CopyPresetToCustomFlags();

	this->Reset();
}

void LightingPresets::OnActiveModChanged(wxCommandEvent &WXUNUSED(event)) {
	const ModItem* activeMod = ModList::GetActiveMod();
	wxCHECK_RET(activeMod != NULL,
		_T("LightingPresets::OnActiveModChanged(): activeMod is NULL!"));
	
	presets[ID_PRESET_BASELINE].SetFlagSet(activeMod->recommendedlightingflagset);
	
	wxRadioButton* radioButtonRecommended = dynamic_cast<wxRadioButton*>(
		wxWindow::FindWindowById(ID_PRESET_BASELINE, this));
	wxCHECK_RET(radioButtonRecommended != NULL,
		_T("Could not find recommended preset radio button"));
	
	radioButtonRecommended->SetLabel(activeMod->recommendedlightingname);
}

void LightingPresets::OnProxyFlagDataReady(wxCommandEvent &WXUNUSED(event)) {
	this->Initialize();
}

const wxString& LightingPresets::PresetNameToPresetFlagSet(const wxString& presetName) {
	if (presets.size() == 0) { // for registry_helper, so that it can write cmdline_fso.cfg
		InitializePresets();
	}

	for (PresetHashMap::iterator it = presets.begin(), end = presets.end(); it != end; ++it) {
		if (it->second.GetName() == presetName) {
			return it->second.GetFlagSet();
		}
	}
	
	wxLogWarning(_T("PresetNameToPresetFlagSet: unknown preset name %s, returning default (%s)"),
		presetName.c_str(), presets[DEFAULT_PRESET_ID].GetName().c_str());
	return presets[DEFAULT_PRESET_ID].GetFlagSet();
}
	
void LightingPresets::Initialize() {
	wxString presetName;
	
	if (ProfileProxy::GetProxy()->HasLightingPreset()) {
		presetName = ProfileProxy::GetProxy()->GetLightingPresetName();
	} else {
		presetName = PresetButtonIdToPresetName(DEFAULT_PRESET_ID);
	}

	int presetButtonId = PresetNameToPresetButtonId(presetName);

	wxRadioButton *selectedPresetButton =
		dynamic_cast<wxRadioButton*>(wxWindow::FindWindowById(presetButtonId, this));
	wxCHECK_RET( selectedPresetButton != NULL, _T("Cannot find selected preset button"));
	selectedPresetButton->SetValue(true);

	wxCommandEvent presetSelectionEvent(wxEVT_COMMAND_RADIOBUTTON_SELECTED, presetButtonId);
	this->OnSelectLightingPreset(presetSelectionEvent);
}

void LightingPresets::Reset() {
	wxRadioButton* presetsOffButton =
		dynamic_cast<wxRadioButton*>(wxWindow::FindWindowById(ID_PRESETS_OFF, this));
	wxCHECK_RET( presetsOffButton != NULL, _T("Unable to find lighting presets off radio button"));
	presetsOffButton->SetValue(true);
	
	wxCommandEvent resetEvent(wxEVT_COMMAND_RADIOBUTTON_SELECTED, ID_PRESETS_OFF);
	this->OnSelectLightingPreset(resetEvent);
}

int LightingPresets::PresetNameToPresetButtonId(const wxString& presetName) {
	wxASSERT_MSG(presets.size() != 0, _T("presets have not been initialized"));

	for (PresetHashMap::iterator it = presets.begin(), end = presets.end(); it != end; ++it) {
		if (it->second.GetName() == presetName) {
			return it->second.GetButtonId();
		}
	}
	
	wxLogWarning(_T("PresetNameToPresetButtonId: unknown preset name %s, returning default (%s)"),
		presetName.c_str(), presets[DEFAULT_PRESET_ID].GetName().c_str());
	return DEFAULT_PRESET_ID;
}

const wxString& LightingPresets::PresetButtonIdToPresetName(int buttonId) {
	wxASSERT_MSG(presets.size() != 0, _T("presets have not been initialized"));

	PresetHashMap::iterator it = presets.find(buttonId);
	
	wxCHECK_MSG(it != presets.end(), presets[DEFAULT_PRESET_ID].GetName(),
		wxString::Format(_T("PresetButtonIdToPresetName given invalid button ID %d"), buttonId));
	
	return it->second.GetName();
}