-
Notifications
You must be signed in to change notification settings - Fork 47
/
Particles.cpp
391 lines (323 loc) · 16.8 KB
/
Particles.cpp
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
#include "RadiantTest.h"
#include "iparticles.h"
#include "iparticlestage.h"
#include "os/path.h"
#include "string/replace.h"
#include "algorithm/FileUtils.h"
#include "parser/DefBlockTokeniser.h"
#include "string/case_conv.h"
#include "testutil/TemporaryFile.h"
namespace test
{
class ParticlesTest :
public RadiantTest
{
public:
const char* const TEST_PARTICLE_FILE = "testparticles.prt";
void preStartup() override
{
// Remove the physical override_test.prt file
fs::remove(_context.getTestProjectPath() + "particles/override_test.prt");
// Create a backup of the testparticles file
fs::path testFile = _context.getTestProjectPath() + "particles/" + TEST_PARTICLE_FILE;
fs::path bakFile = testFile;
bakFile.replace_extension(".bak");
fs::remove(bakFile);
fs::copy(testFile, bakFile);
}
void preShutdown() override
{
fs::path testFile = _context.getTestProjectPath() + "particles/" + TEST_PARTICLE_FILE;
fs::remove(testFile);
fs::path bakFile = testFile;
bakFile.replace_extension(".bak");
fs::rename(bakFile, testFile);
}
};
// #5853: Two files define the same particle def:
// 1) in VFS: particles/z_precedence.prt
// 2) in PK4: test_particles.pk4/particles/precedence.prt
// Even though the filesystem folder has higher priority, the file
// in the PK4 should be parsed first, since the lexicographical order
// is considered when looking for .prt files. That's why the
// declaration in the filesystem should not take effect.
TEST_F(ParticlesTest, ParticleFilenamePrecedence)
{
auto decl = GlobalParticlesManager().getDefByName("precedencecheck");
EXPECT_TRUE(decl) << "Could not find the particle 'precedencecheck'";
// The decl in the PK4 should be processed first, the one in the filesystem just produces a warning
EXPECT_EQ(decl->getStage(0)->getMaterialName(), "textures/common/caulk")
<< "The particle using the caulk texture should have taken precedence";
}
// Prove that the ignored, duplicate particleDef is not stopping the parser from processing the rest of the file
TEST_F(ParticlesTest, ParticleBelowDuplicatedIsParsed)
{
auto decl = GlobalParticlesManager().getDefByName("particle_after_precedencecheck");
EXPECT_TRUE(decl) << "Could not locate the particleDef that should go below the precedencecheck in z_precedence.prt";
EXPECT_EQ(decl->getStage(0)->getMaterialName(), "textures/common/nodraw")
<< "The particle using the caulk texture should have taken precedence";
}
TEST_F(ParticlesTest, FindParticle)
{
EXPECT_TRUE(GlobalParticlesManager().getDefByName("tdm_fire_torch")) << "tdm_fire_torch not found";
EXPECT_TRUE(GlobalParticlesManager().getDefByName("firefly_blue")) << "firefly_blue not found";
EXPECT_TRUE(GlobalParticlesManager().getDefByName("firefly_yellow")) << "mixed case typename particle firefly_yellow not found";
EXPECT_TRUE(GlobalParticlesManager().getDefByName("firefly_green")) << "particle without typename firefly_green not found";
EXPECT_TRUE(GlobalParticlesManager().getDefByName("flamejet"));
EXPECT_TRUE(GlobalParticlesManager().getDefByName("flamejet_in_pk4"));
EXPECT_TRUE(GlobalParticlesManager().getDefByName("tdm_fire_torch_in_pk4"));
EXPECT_FALSE(GlobalParticlesManager().getDefByName("flamejet_nonexisting")) << "flamejet_nonexisting doesn't exist";
}
TEST_F(ParticlesTest, ParticleMetadata)
{
auto flamejet = GlobalParticlesManager().getDefByName("flamejet");
EXPECT_EQ(flamejet->getDeclName(), "flamejet");
EXPECT_EQ(flamejet->getDeclType(), decl::Type::Particle);
EXPECT_EQ(flamejet->getModName(), RadiantTest::DefaultGameType);
EXPECT_EQ(flamejet->getDeclFilePath(), "particles/testparticles.prt");
auto flamejetInPk4 = GlobalParticlesManager().getDefByName("flamejet_in_pk4");
EXPECT_EQ(flamejetInPk4->getDeclName(), "flamejet_in_pk4");
EXPECT_EQ(flamejetInPk4->getDeclType(), decl::Type::Particle);
EXPECT_EQ(flamejetInPk4->getModName(), RadiantTest::DefaultGameType);
EXPECT_EQ(flamejetInPk4->getDeclFilePath(), "particles/override_test.prt");
}
TEST_F(ParticlesTest, DefProperties)
{
auto decl = GlobalParticlesManager().getDefByName("flamejet");
EXPECT_EQ(decl->getDepthHack(), 0.001f);
EXPECT_EQ(decl->getNumStages(), 3);
EXPECT_EQ(decl->getStage(0)->getCount(), 20);
EXPECT_EQ(decl->getStage(0)->getMaterialName(), "textures/particles/pfirebig2");
EXPECT_EQ(decl->getStage(0)->getDuration(), 0.7f);
EXPECT_EQ(decl->getStage(0)->getCycles(), 0.0f);
EXPECT_EQ(decl->getStage(0)->getBunching(), 1.0f);
EXPECT_EQ(decl->getStage(0)->getDistributionType(), particles::IStageDef::DISTRIBUTION_CYLINDER);
EXPECT_EQ(decl->getStage(0)->getDistributionParm(0), 4);
EXPECT_EQ(decl->getStage(0)->getDistributionParm(1), 4);
EXPECT_EQ(decl->getStage(0)->getDistributionParm(2), 10);
EXPECT_EQ(decl->getStage(0)->getDistributionParm(3), 0);
EXPECT_EQ(decl->getStage(0)->getDirectionType(), particles::IStageDef::DIRECTION_CONE);
EXPECT_EQ(decl->getStage(0)->getDirectionParm(0), 10.0);
EXPECT_EQ(decl->getStage(0)->getOrientationType(), particles::IStageDef::ORIENTATION_VIEW);
EXPECT_EQ(decl->getStage(0)->getSpeed().getFrom(), 86);
EXPECT_EQ(decl->getStage(0)->getSpeed().getTo(), -4);
EXPECT_EQ(decl->getStage(0)->getSize().getFrom(), 16.5f);
EXPECT_EQ(decl->getStage(0)->getSize().getTo(), 28.5f);
EXPECT_EQ(decl->getStage(0)->getAspect().getFrom(), 1.0f);
EXPECT_EQ(decl->getStage(0)->getAspect().getTo(), 1.0f);
EXPECT_EQ(decl->getStage(0)->getRotationSpeed().getFrom(), 24.0f);
EXPECT_EQ(decl->getStage(0)->getRotationSpeed().getTo(), 29.0f);
EXPECT_EQ(decl->getStage(0)->getFadeInFraction(), 0.35f);
EXPECT_EQ(decl->getStage(0)->getFadeOutFraction(), 0.2f);
EXPECT_EQ(decl->getStage(0)->getColour(), Vector4(0.92, 0.92, 0.92, 1));
EXPECT_EQ(decl->getStage(0)->getFadeColour(), Vector4(0, 0, 0, 1));
EXPECT_EQ(decl->getStage(0)->getOffset(), Vector3(0, 0, 0));
EXPECT_EQ(decl->getStage(0)->getGravity(), 10.0f);
EXPECT_EQ(decl->getStage(0)->getWorldGravityFlag(), false);
EXPECT_EQ(decl->getStage(1)->getCount(), 4);
EXPECT_EQ(decl->getStage(1)->getMaterialName(), "textures/particles/dust");
EXPECT_EQ(decl->getStage(1)->getDuration(), 1.6f);
EXPECT_EQ(decl->getStage(1)->getCycles(), 0.0f);
EXPECT_EQ(decl->getStage(1)->getBunching(), 1.0f);
EXPECT_EQ(decl->getStage(1)->getDistributionType(), particles::IStageDef::DISTRIBUTION_CYLINDER);
EXPECT_EQ(decl->getStage(1)->getDistributionParm(0), 2);
EXPECT_EQ(decl->getStage(1)->getDistributionParm(1), 2);
EXPECT_EQ(decl->getStage(1)->getDistributionParm(2), 2);
EXPECT_EQ(decl->getStage(1)->getDistributionParm(3), 0);
EXPECT_EQ(decl->getStage(1)->getDirectionType(), particles::IStageDef::DIRECTION_CONE);
EXPECT_EQ(decl->getStage(1)->getDirectionParm(0), 90.0);
EXPECT_EQ(decl->getStage(1)->getOrientationType(), particles::IStageDef::ORIENTATION_VIEW);
EXPECT_EQ(decl->getStage(1)->getSpeed().getFrom(), 47);
EXPECT_EQ(decl->getStage(1)->getSpeed().getTo(), 0);
EXPECT_EQ(decl->getStage(1)->getSize().getFrom(), 13.0f);
EXPECT_EQ(decl->getStage(1)->getSize().getTo(), 38.5f);
EXPECT_EQ(decl->getStage(1)->getAspect().getFrom(), 1.5f);
EXPECT_EQ(decl->getStage(1)->getAspect().getTo(), 1.0f);
EXPECT_EQ(decl->getStage(1)->getRotationSpeed().getFrom(), 50.0f);
EXPECT_EQ(decl->getStage(1)->getRotationSpeed().getTo(), 85.0f);
EXPECT_EQ(decl->getStage(1)->getFadeInFraction(), 1.0f);
EXPECT_EQ(decl->getStage(1)->getFadeOutFraction(), 0.6f);
EXPECT_EQ(decl->getStage(1)->getColour(), Vector4(1, 1, 1, 1));
EXPECT_EQ(decl->getStage(1)->getFadeColour(), Vector4(0, 0, 1, 0));
EXPECT_EQ(decl->getStage(1)->getOffset(), Vector3(0, 0, 4));
EXPECT_EQ(decl->getStage(1)->getGravity(), -29.0f);
EXPECT_EQ(decl->getStage(1)->getWorldGravityFlag(), true);
// Test a few key properties of stage #3 that are not covered by stages #1 and #2
EXPECT_EQ(decl->getStage(2)->getDistributionType(), particles::IStageDef::DISTRIBUTION_RECT);
EXPECT_EQ(decl->getStage(2)->getDistributionParm(0), 3);
EXPECT_EQ(decl->getStage(2)->getDistributionParm(1), 3);
EXPECT_EQ(decl->getStage(2)->getDistributionParm(2), 0);
EXPECT_EQ(decl->getStage(2)->getDirectionType(), particles::IStageDef::DIRECTION_OUTWARD);
EXPECT_EQ(decl->getStage(2)->getDirectionParm(0), 100.0);
EXPECT_EQ(decl->getStage(2)->getRotationSpeed().getFrom(), 100.0f);
EXPECT_EQ(decl->getStage(2)->getRotationSpeed().getTo(), 100.0f);
EXPECT_EQ(decl->getStage(2)->getOffset(), Vector3(0, 0, -20));
}
TEST_F(ParticlesTest, ForeachParticleDef)
{
std::set<std::string> visitedDefs;
GlobalParticlesManager().forEachParticleDef([&](const particles::IParticleDef& def)
{
visitedDefs.insert(def.getDeclName());
});
EXPECT_EQ(visitedDefs.count("tdm_fire_torch"), 1) << "A particle didn't appear in the list of visited particles";
EXPECT_EQ(visitedDefs.count("firefly_blue"), 1) << "A particle didn't appear in the list of visited particles";
EXPECT_EQ(visitedDefs.count("firefly_yellow"), 1) << "A particle didn't appear in the list of visited particles";
EXPECT_EQ(visitedDefs.count("firefly_green"), 1) << "A particle didn't appear in the list of visited particles";
EXPECT_EQ(visitedDefs.count("flamejet"), 1) << "A particle didn't appear in the list of visited particles";
EXPECT_EQ(visitedDefs.count("flamejet_in_pk4"), 1) << "A particle didn't appear in the list of visited particles";
EXPECT_EQ(visitedDefs.count("tdm_fire_torch_in_pk4"), 1) << "A particle didn't appear in the list of visited particles";
EXPECT_NE(visitedDefs.count("not_existing"), 1) << "This particle shouldn't appear in the list of visited particles";
}
TEST_F(ParticlesTest, FindOrInsertParticleDef)
{
EXPECT_TRUE(GlobalParticlesManager().findOrInsertParticleDef("tdm_fire_torch")) << "tdm_fire_torch not found";
EXPECT_TRUE(GlobalParticlesManager().findOrInsertParticleDef("firefly_blue")) << "firefly_blue not found";
EXPECT_TRUE(GlobalParticlesManager().findOrInsertParticleDef("firefly_yellow")) << "mixed case typename particle firefly_yellow not found";
EXPECT_TRUE(GlobalParticlesManager().findOrInsertParticleDef("firefly_green")) << "particle without typename firefly_green not found";
EXPECT_TRUE(GlobalParticlesManager().findOrInsertParticleDef("flamejet"));
auto inserted = GlobalParticlesManager().findOrInsertParticleDef("flamejet_nonexisting");
EXPECT_TRUE(inserted) << "Nonexistent def should have been inserted";
EXPECT_EQ(inserted->getName(), "flamejet_nonexisting");
EXPECT_EQ(inserted->getDeclType(), decl::Type::Particle);
EXPECT_EQ(inserted->getBlockSyntax().contents, "");
}
constexpr const char* ParticleSourceTemplate = R"(
depthHack 0.001
{
count 20
material textures/particles/pfirebig2
time 0.700
cycles 0.000
bunching 1.000
distribution cylinder 4.000 4.000 10.000 0.000
direction cone 10.000
orientation view
speed 86.000 to "-4.000"
size 16.500 to 28.500
aspect 1.000
rotation 24.000 to 29.000
fadeIn 0.350
fadeOut 0.200
color 0.920 0.920 0.920 1.000
fadeColor 0.000 0.000 0.000 1.000
offset 0.000 0.000 0.000
gravity 10.000
}
)";
inline std::string createParticleSource()
{
return ParticleSourceTemplate;
}
inline particles::IParticleDef::Ptr createParticleFromSource(const std::string& defName)
{
auto decl = GlobalParticlesManager().findOrInsertParticleDef(defName);
auto source = createParticleSource();
decl::DeclarationBlockSyntax syntax;
syntax.typeName = "particle";
syntax.name = defName;
syntax.contents = source;
syntax.fileInfo = vfs::FileInfo("particles/", "export_particle_test.prt", vfs::Visibility::NORMAL);
decl->setBlockSyntax(syntax);
decl->getDepthHack(); // ensure the particle is parsed
decl->setFilename(os::getFilename(syntax.fileInfo.fullPath()));
return decl;
}
// Filename is the leaf name, relative to the particles/ folder
inline void setParticleFilename(const particles::IParticleDef::Ptr& decl, const std::string& filename)
{
auto syntax = decl->getBlockSyntax();
syntax.fileInfo = vfs::FileInfo("particles/", filename, vfs::Visibility::NORMAL);
decl->setBlockSyntax(syntax);
// Legacy invocation
decl->setFilename(os::getFilename(syntax.fileInfo.fullPath()));
}
inline void expectParticleIsPresentInFile(const particles::IParticleDef::Ptr& decl, const std::string& path, bool expectPresent)
{
auto contents = algorithm::loadTextFromVfsFile(path);
parser::BasicDefBlockTokeniser<std::string> tokeniser(contents);
std::vector<parser::BlockTokeniser::Block> foundBlocks;
auto particleName = string::to_lower_copy(decl->getName());
while (tokeniser.hasMoreBlocks())
{
auto block = tokeniser.nextBlock();
auto header = string::to_lower_copy(block.name);
if (decl->getNumStages() > 0 &&
string::starts_with(block.name, "particle") &&
string::ends_with(block.name, particleName))
{
if (block.contents.find(decl->getStage(0)->getMaterialName()) == std::string::npos)
{
continue;
}
foundBlocks.push_back(block);
}
}
if (expectPresent)
{
EXPECT_EQ(foundBlocks.size(), 1) << "Expected exactly one particle " << particleName << " in the contents in the file";
}
else
{
EXPECT_TRUE(foundBlocks.empty()) << "Expected no particle " << particleName << " in the contents in the file";
}
}
// Save a new particle to a file on disk
TEST_F(ParticlesTest, SaveNewParticleToNewFile)
{
auto decl = createParticleFromSource("some_def");
const auto& syntax = decl->getBlockSyntax();
auto outputPath = _context.getTestProjectPath() + syntax.fileInfo.fullPath();
EXPECT_FALSE(fs::exists(outputPath)) << "Output file shouldn't exist yet";
// Auto-remove the file that is going to be written
TemporaryFile outputFile(outputPath);
GlobalParticlesManager().saveParticleDef(decl->getDeclName());
EXPECT_TRUE(fs::exists(outputPath)) << "Output file should exist now";
expectParticleIsPresentInFile(decl, decl->getBlockSyntax().fileInfo.fullPath(), true);
}
// Save the particle to a file that already exists (but doesn't contain the def)
TEST_F(ParticlesTest, SaveNewParticleToExistingFile)
{
auto decl = createParticleFromSource("some_def346");
setParticleFilename(decl, TEST_PARTICLE_FILE);
// Def file should not have that particle def yet
expectParticleIsPresentInFile(decl, decl->getBlockSyntax().fileInfo.fullPath(), false);
GlobalParticlesManager().saveParticleDef(decl->getDeclName());
expectParticleIsPresentInFile(decl, decl->getBlockSyntax().fileInfo.fullPath(), true);
}
// Save a particle to the same physical file that originally declared the decl
TEST_F(ParticlesTest, SaveExistingParticleToExistingFile)
{
auto decl = GlobalParticlesManager().getDefByName("firefly_blue");
// Swap the material name of this particle
auto syntax = decl->getBlockSyntax();
EXPECT_NE(syntax.contents.find("firefly_blue"), std::string::npos) << "Expected the material name in the block";
string::replace_all(syntax.contents, "firefly_blue", "modified_material");
decl->setBlockSyntax(syntax);
// This modified particle should not be present
expectParticleIsPresentInFile(decl, decl->getBlockSyntax().fileInfo.fullPath(), false);
// Save, it should be there now
GlobalParticlesManager().saveParticleDef(decl->getDeclName());
expectParticleIsPresentInFile(decl, decl->getBlockSyntax().fileInfo.fullPath(), true);
// The test fixture will restore the original file contents in TearDown
}
// Save particle originally defined in a PK4 file to a new physical file that overrides the PK4
TEST_F(ParticlesTest, SaveExistingParticleToNewFileOverridingPk4)
{
auto decl = GlobalParticlesManager().getDefByName("firefly_blue_in_pk4");
// Swap the material name of this particle
auto syntax = decl->getBlockSyntax();
EXPECT_NE(syntax.contents.find("firefly_blue"), std::string::npos) << "Expected the material name in the block";
string::replace_all(syntax.contents, "firefly_blue", "modified_material");
decl->setBlockSyntax(syntax);
// The overriding file should not be present
auto outputPath = _context.getTestProjectPath() + decl->getBlockSyntax().fileInfo.fullPath();
// Let the file be deleted when we're done here
TemporaryFile outputFile(outputPath);
EXPECT_FALSE(fs::exists(outputPath));
expectParticleIsPresentInFile(decl, decl->getBlockSyntax().fileInfo.fullPath(), false);
// Save, it should be there now
GlobalParticlesManager().saveParticleDef(decl->getDeclName());
expectParticleIsPresentInFile(decl, decl->getBlockSyntax().fileInfo.fullPath(), true);
}
}