/
Entity.cpp
1902 lines (1499 loc) · 67.8 KB
/
Entity.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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "RadiantTest.h"
#include "ieclass.h"
#include "ientity.h"
#include "irendersystemfactory.h"
#include "iselectable.h"
#include "iselection.h"
#include "iundo.h"
#include "ishaders.h"
#include "icolourscheme.h"
#include "ieclasscolours.h"
#include "render/NopVolumeTest.h"
#include "string/convert.h"
#include "transformlib.h"
#include "registry/registry.h"
#include "eclass.h"
#include "string/join.h"
#include "scenelib.h"
#include "algorithm/Entity.h"
#include "algorithm/Scene.h"
namespace test
{
using EntityTest = RadiantTest;
namespace
{
// Create an entity from a simple classname string
IEntityNodePtr createByClassName(const std::string& className)
{
auto cls = GlobalEntityClassManager().findClass(className);
return GlobalEntityModule().createEntity(cls);
}
// Container for an entity under test. Stores the entity and adds it to the
// global map to enable undo.
struct TestEntity
{
IEntityNodePtr node;
Entity* spawnArgs = nullptr;
// Create an entity with the given class name
static TestEntity create(const std::string& className)
{
TestEntity result;
result.node = createByClassName(className);
result.spawnArgs = &result.node->getEntity();
// Enable undo
scene::addNodeToContainer(result.node, GlobalMapModule().getRoot());
return result;
}
// Access the spawnargs
Entity& args() { return *spawnArgs; }
};
// Obtain entity attachments as a simple std::list
std::list<Entity::Attachment> getAttachments(const IEntityNodePtr& node)
{
std::list<Entity::Attachment> attachments;
if (node)
{
node->getEntity().forEachAttachment(
[&](const Entity::Attachment& a) { attachments.push_back(a); }
);
}
return attachments;
}
}
using StringMap = std::map<std::string, std::string>;
TEST_F(EntityTest, LookupEntityClass)
{
// Nonexistent class should return null (but not throw or crash)
auto cls = GlobalEntityClassManager().findClass("notAnEntityClass");
EXPECT_FALSE(cls);
// Real entity class should return a valid pointer
auto lightCls = GlobalEntityClassManager().findClass("light");
EXPECT_TRUE(lightCls);
}
TEST_F(EntityTest, LightEntitiesRecognisedAsLights)
{
// The 'light' class should be recognised as an actual light
auto lightCls = GlobalEntityClassManager().findClass("light");
EXPECT_TRUE(lightCls->isLight());
// Things which are not lights should also be correctly identified
auto notLightCls = GlobalEntityClassManager().findClass("dr:entity_using_modeldef");
EXPECT_TRUE(notLightCls);
EXPECT_FALSE(notLightCls->isLight());
// Anything deriving from the light class should also be a light
auto derived1 = GlobalEntityClassManager().findClass("atdm:light_base");
EXPECT_TRUE(derived1->isLight());
// Second level derivations too
auto derived2 = GlobalEntityClassManager().findClass("light_extinguishable");
EXPECT_TRUE(derived2->isLight());
// torch_brazier is not a light itself, but has a light attached, so it
// should not have isLight() == true
auto brazier = GlobalEntityClassManager().findClass("atdm:torch_brazier");
EXPECT_FALSE(brazier->isLight());
}
TEST_F(EntityTest, EntityClassInheritsAttributes)
{
auto cls = GlobalEntityClassManager().findClass("light_extinguishable");
ASSERT_TRUE(cls);
// Inherited from 'light'
EXPECT_EQ(cls->getAttribute("editor_color").getValue(), "0 1 0");
EXPECT_EQ(cls->getAttribute("spawnclass").getValue(), "idLight");
// Inherited from 'atdm:light_base'
EXPECT_EQ(cls->getAttribute("AIUse").getValue(), "AIUSE_LIGHTSOURCE");
EXPECT_EQ(cls->getAttribute("shouldBeOn").getValue(), "0");
// Inherited but overridden on 'light_extinguishable' itself
EXPECT_EQ(cls->getAttribute("editor_displayFolder").getValue(),
"Lights/Base Entities, DoNotUse");
// Lookup without considering inheritance
EXPECT_EQ(cls->getAttribute("editor_color", false).getValue(), "");
EXPECT_EQ(cls->getAttribute("spawnclass", false).getValue(), "");
}
TEST_F(EntityTest, VisitInheritedClassAttributes)
{
auto cls = GlobalEntityClassManager().findClass("light_extinguishable");
ASSERT_TRUE(cls);
// Map of attribute names to inherited flag
std::map<std::string, bool> attributes;
// Visit all attributes and store in the map
cls->forEachAttribute(
[&attributes](const EntityClassAttribute& a, bool inherited) {
attributes.insert({a.getName(), inherited});
},
true /* editorKeys */
);
// Confirm inherited flags set correctly
EXPECT_EQ(attributes.at("spawnclass"), true);
EXPECT_EQ(attributes.at("AIUse"), true);
EXPECT_EQ(attributes.at("maxs"), false);
EXPECT_EQ(attributes.at("clipmodel_contents"), false);
EXPECT_EQ(attributes.at("editor_displayFolder"), false);
}
// #5621: When the classname key is selected in the entity inspector, the description of that
// attribute should deliver the text that is stored in the editor_usage attributes
TEST_F(EntityTest, MultiLineEditorUsage)
{
auto eclass = GlobalEntityClassManager().findClass("eclass_with_usage_attribute");
ASSERT_TRUE(eclass);
// Assume we have non-empty editor_usage/1/2 attributes
EXPECT_NE(eclass->getAttribute("editor_usage").getValue(), "");
EXPECT_NE(eclass->getAttribute("editor_usage1").getValue(), "");
EXPECT_NE(eclass->getAttribute("editor_usage2").getValue(), "");
auto editor_usage = eclass::getUsage(*eclass);
std::vector<std::string> singleAttributes =
{
eclass->getAttribute("editor_usage").getValue(),
eclass->getAttribute("editor_usage1").getValue(),
eclass->getAttribute("editor_usage2").getValue()
};
EXPECT_EQ(editor_usage, string::join(singleAttributes, "\n"));
}
void checkBucketEntityDef(const IEntityClassPtr& eclass)
{
// These spawnargs are all defined directly on bucket_metal
EXPECT_EQ(eclass->getAttribute("editor_usage").getValue(), "So you can kick the bucket.");
EXPECT_EQ(eclass->getAttribute("editor_displayFolder").getValue(), "Moveables/Containers");
EXPECT_EQ(eclass->getAttribute("mass").getValue(), "8");
EXPECT_EQ(eclass->getAttribute("inherit").getValue(), "bucket_base");
EXPECT_EQ(eclass->getAttribute("model").getValue(), "models/darkmod/containers/bucket.lwo");
EXPECT_EQ(eclass->getAttribute("friction").getValue(), "0.2");
EXPECT_EQ(eclass->getAttribute("clipmodel").getValue(), "models/darkmod/misc/clipmodels/bucket_cm.lwo");
EXPECT_EQ(eclass->getAttribute("bouncyness").getValue(), "0.5");
EXPECT_EQ(eclass->getAttribute("snd_bounce").getValue(), "tdm_impact_metal_bucket");
EXPECT_EQ(eclass->getAttribute("snd_bounce_carpet").getValue(), "tdm_impact_metal_bucket_on_soft");
EXPECT_EQ(eclass->getAttribute("snd_bounce_cloth").getValue(), "tdm_impact_metal_bucket_on_soft");
EXPECT_EQ(eclass->getAttribute("snd_bounce_grass").getValue(), "tdm_impact_metal_bucket_on_soft");
EXPECT_EQ(eclass->getAttribute("snd_bounce_dirt").getValue(), "tdm_impact_metal_bucket_on_soft");
// This is defined in the parent entityDef:
EXPECT_EQ(eclass->getAttribute("snd_bounce_snow").getValue(), "tdm_impact_dirt");
}
// #5652: Reloading DEFs must not mess up the eclass attributes
TEST_F(EntityTest, ReloadDefsOnUnchangedFiles)
{
auto eclass = GlobalEntityClassManager().findClass("bucket_metal");
auto parent = eclass->getParent();
// Check the parent, it defines an editor_usage which will mess up the child (when the #5652 problem was unfixed)
EXPECT_TRUE(parent != nullptr);
EXPECT_EQ(parent->getAttribute("editor_usage").getValue(), "Don't use. Base class for all TDM moveables.");
checkBucketEntityDef(eclass);
// Reload the defs and re-use the same eclass reference we got above, it ought to be still valid
GlobalEntityClassManager().reloadDefs();
checkBucketEntityDef(eclass);
}
TEST_F(EntityTest, CannotCreateEntityWithoutClass)
{
// Creating with a null entity class should throw an exception
EXPECT_THROW(GlobalEntityModule().createEntity({}), std::runtime_error);
}
TEST_F(EntityTest, CreateBasicLightEntity)
{
// Create a basic light
auto lightCls = GlobalEntityClassManager().findClass("light");
auto light = GlobalEntityModule().createEntity(lightCls);
// Light has a sensible autogenerated name
EXPECT_EQ(light->name(), "light_1");
// Entity should have a "classname" key matching the actual entity class we
// created
auto clsName = light->getEntity().getKeyValue("classname");
EXPECT_EQ(clsName, "light");
// Entity should have an IEntityClass pointer which matches the one we
// looked up
EXPECT_EQ(light->getEntity().getEntityClass().get(), lightCls.get());
// This basic light entity should have no attachments
auto attachments = getAttachments(light);
EXPECT_EQ(attachments.size(), 0);
}
TEST_F(EntityTest, EnumerateEntitySpawnargs)
{
auto light = createByClassName("light");
auto& spawnArgs = light->getEntity();
// Visit spawnargs by key and value string
StringMap keyValuesInit;
spawnArgs.forEachKeyValue([&](const std::string& k, const std::string& v) {
keyValuesInit.insert({k, v});
});
// Initial entity should have a name and a classname value and no other
// properties
EXPECT_EQ(keyValuesInit.size(), 2);
EXPECT_EQ(keyValuesInit["name"], light->name());
EXPECT_EQ(keyValuesInit["classname"], "light");
// Add some new properties of our own
spawnArgs.setKeyValue("origin", "128 256 -1024");
spawnArgs.setKeyValue("_color", "0.5 0.5 0.5");
// Ensure that our new properties are also enumerated
StringMap keyValuesAll;
spawnArgs.forEachKeyValue([&](const std::string& k, const std::string& v) {
keyValuesAll.insert({k, v});
});
EXPECT_EQ(keyValuesAll.size(), 4);
EXPECT_EQ(keyValuesAll["origin"], "128 256 -1024");
EXPECT_EQ(keyValuesAll["_color"], "0.5 0.5 0.5");
// Enumerate as full EntityKeyValue objects as well as strings
StringMap keyValuesByObj;
spawnArgs.forEachEntityKeyValue(
[&](const std::string& k, const EntityKeyValue& v) {
keyValuesByObj.insert({k, v.get()});
}
);
EXPECT_EQ(keyValuesAll, keyValuesByObj);
}
TEST_F(EntityTest, EnumerateInheritedSpawnargs)
{
auto light = createByClassName("atdm:light_base");
auto& spawnArgs = light->getEntity();
// Enumerate all keyvalues including the inherited ones
StringMap keyValues;
spawnArgs.forEachKeyValue(
[&](const std::string& k, const std::string& v) {
keyValues.insert({k, v});
},
true /* includeInherited */
);
// Check we have some inherited properties from the entitydef (including
// spawnclass from the entitydef's own parent def)
EXPECT_EQ(keyValues["spawnclass"], "idLight");
EXPECT_EQ(keyValues["shouldBeOn"], "0");
EXPECT_EQ(keyValues["AIUse"], "AIUSE_LIGHTSOURCE");
EXPECT_EQ(keyValues["noshadows"], "0");
}
TEST_F(EntityTest, GetKeyValuePairs)
{
auto torch = createByClassName("atdm:torch_brazier");
auto& spawnArgs = torch->getEntity();
using Pair = Entity::KeyValuePairs::value_type;
// Retrieve single spawnargs as single-element lists of pairs
auto classNamePairs = spawnArgs.getKeyValuePairs("classname");
EXPECT_EQ(classNamePairs.size(), 1);
EXPECT_EQ(classNamePairs[0], Pair("classname", "atdm:torch_brazier"));
auto namePairs = spawnArgs.getKeyValuePairs("name");
EXPECT_EQ(namePairs.size(), 1);
EXPECT_EQ(namePairs[0], Pair("name", "atdm_torch_brazier_1"));
// Add some spawnargs with a common prefix
const StringMap SR_KEYS{
{"sr_type_1", "blah"},
{"sr_type_2", "bleh"},
{"sR_tYpE_a", "123"},
{"SR_type_1a", "0 123 -120"},
};
for (const auto& pair: SR_KEYS)
spawnArgs.setKeyValue(pair.first, pair.second);
// Confirm all added prefix keys are found regardless of case
auto srPairs = spawnArgs.getKeyValuePairs("sr_type");
EXPECT_EQ(srPairs.size(), SR_KEYS.size());
for (const auto& pair: srPairs)
EXPECT_EQ(SR_KEYS.at(pair.first), pair.second);
}
TEST_F(EntityTest, CopySpawnargs)
{
auto light = createByClassName("atdm:light_base");
auto& spawnArgs = light->getEntity();
// Add some custom spawnargs to copy
const StringMap EXTRA_SPAWNARGS{{"first", "1"},
{"second", "two"},
{"THIRD", "3333"},
{"_color", "1 0 1"}};
for (const auto& pair: EXTRA_SPAWNARGS)
spawnArgs.setKeyValue(pair.first, pair.second);
// Clone the entity node
auto lightCopy = light->clone();
Entity* clonedEnt = Node_getEntity(lightCopy);
ASSERT_TRUE(clonedEnt);
// Clone should have all the same spawnarg strings
std::size_t count = 0;
clonedEnt->forEachKeyValue([&](const std::string& k, const std::string& v) {
EXPECT_EQ(spawnArgs.getKeyValue(k), v);
++count;
});
EXPECT_EQ(count, EXTRA_SPAWNARGS.size() + 2 /* name and classname */);
// Clone should NOT have the same actual KeyValue object pointers, although
// the count should be the same
std::set<EntityKeyValue*> origPointers;
std::set<EntityKeyValue*> copiedPointers;
spawnArgs.forEachEntityKeyValue(
[&](const std::string& k, EntityKeyValue& v) {
origPointers.insert(&v);
});
clonedEnt->forEachEntityKeyValue(
[&](const std::string& k, EntityKeyValue& v) {
copiedPointers.insert(&v);
});
EXPECT_EQ(origPointers.size(), count);
EXPECT_EQ(copiedPointers.size(), count);
std::vector<EntityKeyValue*> overlap;
std::set_intersection(origPointers.begin(), origPointers.end(),
copiedPointers.begin(), copiedPointers.end(),
std::back_inserter(overlap));
EXPECT_EQ(overlap.size(), 0);
}
TEST_F(EntityTest, UndoRedoSpawnargValueChange)
{
// Create entity with initial default args.
auto entity = TestEntity::create("bucket_metal");
// Make a simple value change
EXPECT_EQ(entity.args().getKeyValue("name"), "bucket_metal_1");
{
UndoableCommand cmd("changeKeyValue");
entity.args().setKeyValue("name", "another_bucket");
}
// Confirm we can undo this change
EXPECT_EQ(entity.args().getKeyValue("name"), "another_bucket");
GlobalUndoSystem().undo();
EXPECT_EQ(entity.args().getKeyValue("name"), "bucket_metal_1");
// Confirm we can redo the change
GlobalUndoSystem().redo();
EXPECT_EQ(entity.args().getKeyValue("name"), "another_bucket");
}
TEST_F(EntityTest, SelectEntity)
{
auto light = createByClassName("light");
// Confirm that setting entity node's selection status propagates to the
// selection system
EXPECT_EQ(GlobalSelectionSystem().countSelected(), 0);
scene::node_cast<ISelectable>(light)->setSelected(true);
EXPECT_EQ(GlobalSelectionSystem().countSelected(), 1);
scene::node_cast<ISelectable>(light)->setSelected(false);
EXPECT_EQ(GlobalSelectionSystem().countSelected(), 0);
}
TEST_F(EntityTest, DestroySelectedEntity)
{
auto light = createByClassName("light");
// Confirm that setting entity node's selection status propagates to the
// selection system
EXPECT_EQ(GlobalSelectionSystem().countSelected(), 0);
scene::node_cast<ISelectable>(light)->setSelected(true);
EXPECT_EQ(GlobalSelectionSystem().countSelected(), 1);
// Destructor called here and should not crash
}
namespace
{
// A simple RenderableCollector which just logs/stores whatever is submitted
struct TestRenderableCollector: public RenderableCollector
{
// Count of submitted renderables and lights
int renderables = 0;
int lights = 0;
// List of actual RendererLight objects
std::list<const RendererLight*> lightPtrs;
// List of renderables and their shaders
std::vector< std::pair<const Shader*, const OpenGLRenderable*> > renderablePtrs;
void addRenderable(Shader& shader, const OpenGLRenderable& renderable,
const Matrix4& localToWorld,
const LitObject* litObject = nullptr,
const IRenderEntity* entity = nullptr) override
{
++renderables;
renderablePtrs.push_back(std::make_pair(&shader, &renderable));
}
void addLight(const RendererLight& light) override
{
++lights;
lightPtrs.push_back(&light);
}
bool supportsFullMaterials() const override { return true; }
void setHighlightFlag(Highlight::Flags flags, bool enabled) override
{}
};
// Collection of objects needed for rendering. Since not all tests require
// rendering, these objects are in an auxiliary fixture created when needed
// rather than part of the EntityTest fixture used by every test. This class
// also implements scene::NodeVisitor enabling it to visit trees of nodes
// for rendering.
struct RenderFixture: public scene::NodeVisitor
{
RenderSystemPtr backend = GlobalRenderSystemFactory().createRenderSystem();
render::NopVolumeTest volumeTest;
TestRenderableCollector collector;
// Whether to render solid or wireframe
const bool renderSolid;
// Keep track of nodes visited
int nodesVisited = 0;
// Construct
RenderFixture(bool solid = false): renderSolid(solid)
{}
// Convenience method to set render backend and traverse a node and its
// children for rendering
void renderSubGraph(const scene::INodePtr& node)
{
node->setRenderSystem(backend);
node->traverse(*this);
}
// NodeVisitor implementation
bool pre(const scene::INodePtr& node) override
{
// Count the node itself
++nodesVisited;
// Render the node in appropriate mode
if (renderSolid)
node->renderSolid(collector, volumeTest);
else
node->renderWireframe(collector, volumeTest);
// Continue traversing
return true;
}
};
}
TEST_F(EntityTest, ModifyEntityClass)
{
auto cls = GlobalEntityClassManager().findClass("light");
auto light = GlobalEntityModule().createEntity(cls);
auto& spawnArgs = light->getEntity();
// Light doesn't initially have a colour set
RenderFixture rf;
light->setRenderSystem(rf.backend);
const ShaderPtr origWireShader = light->getWireShader();
ASSERT_TRUE(origWireShader);
// The shader shouldn't just change by itself (this would invalidate the
// test)
EXPECT_EQ(light->getWireShader(), origWireShader);
// Set a new colour value on the entity *class* (not the entity)
cls->setColour(Vector3(0.5, 0.24, 0.87));
// Shader should have changed due to the entity class update (although there
// aren't currently any public Shader properties that we can examine to
// confirm its contents)
EXPECT_NE(light->getWireShader(), origWireShader);
}
TEST_F(EntityTest, LightLocalToWorldFromOrigin)
{
auto light = createByClassName("light");
// Initial localToWorld should be identity
EXPECT_EQ(light->localToWorld(), Matrix4::getIdentity());
// Set an origin
const Vector3 ORIGIN(123, 456, -10);
light->getEntity().setKeyValue("origin", string::to_string(ORIGIN));
// localToParent should reflect the new origin
auto transformNode = std::dynamic_pointer_cast<ITransformNode>(light);
ASSERT_TRUE(transformNode);
EXPECT_EQ(transformNode->localToParent(), Matrix4::getTranslation(ORIGIN));
// Since there is no parent, the final localToWorld should be the same as
// localToParent
EXPECT_EQ(light->localToWorld(), Matrix4::getTranslation(ORIGIN));
}
TEST_F(EntityTest, LightWireframeShader)
{
auto light = createByClassName("light");
// Initially there is no shader because there is no rendersystem
auto wireSh = light->getWireShader();
EXPECT_FALSE(wireSh);
// Set a render system
RenderSystemPtr backend = GlobalRenderSystemFactory().createRenderSystem();
light->setRenderSystem(backend);
// There should be a shader now
auto newWireSh = light->getWireShader();
ASSERT_TRUE(newWireSh);
// Get the name for the shader. Since this is a simple built-in wireframe
// shader, this should be an internally-constructed name based on the entity
// colour. Note that this colour is derived from the entity *class*, which
// for "light" is a default green. Actual lights will be rendered with a
// colour based on their _color key.
EXPECT_EQ(newWireSh->getName(), "<0.000000 1.000000 0.000000>");
}
TEST_F(EntityTest, LightVolumeColorFromColorKey)
{
// Create a default light
auto light = createByClassName("light");
{
// Render the default light
RenderFixture rf;
rf.renderSubGraph(light);
// Shader should have been submitted. Since a light's default _color is
// white, this is the shader we should get for rendering.
EXPECT_EQ(rf.collector.renderables, 1);
const Shader* shader = rf.collector.renderablePtrs.at(0).first;
ASSERT_TRUE(shader);
EXPECT_EQ(shader->getName(), "<1.000000 1.000000 1.000000>");
}
// Set a different colour on the light
light->getEntity().setKeyValue("_color", "0.75 0.25 0.1");
{
// Re-render the light
RenderFixture rf;
rf.renderSubGraph(light);
// The shader should have changed to match the new _color
EXPECT_EQ(rf.collector.renderables, 1);
const Shader* shader = rf.collector.renderablePtrs.at(0).first;
ASSERT_TRUE(shader);
EXPECT_EQ(shader->getName(), "<0.750000 0.250000 0.100000>");
}
}
TEST_F(EntityTest, OverrideLightVolumeColour)
{
// Create a light with an arbitrary colour
auto light = createByClassName("light");
light->getEntity().setKeyValue("_color", "0.25 0.55 0.9");
// Set the "override light volume colour" key
registry::setValue(colours::RKEY_OVERRIDE_LIGHTCOL, true);
{
RenderFixture rf;
rf.renderSubGraph(light);
// The shader should ignore the _color key and render based on the entity
// class colour
EXPECT_EQ(rf.collector.renderables, 1);
const Shader* shader = rf.collector.renderablePtrs.at(0).first;
ASSERT_TRUE(shader);
EXPECT_EQ(shader->getName(), "<0.000000 1.000000 0.000000>");
}
// Unset the override key
registry::setValue(colours::RKEY_OVERRIDE_LIGHTCOL, false);
{
RenderFixture rf;
rf.renderSubGraph(light);
// Light should be rendered with its original _color key again
EXPECT_EQ(rf.collector.renderables, 1);
const Shader* shader = rf.collector.renderablePtrs.at(0).first;
ASSERT_TRUE(shader);
EXPECT_EQ(shader->getName(), "<0.250000 0.550000 0.900000>");
}
// Changing the override key after deleting the light must not crash
// (because the LightNode's CachedKey is sigc::trackable)
light.reset();
registry::setValue(colours::RKEY_OVERRIDE_LIGHTCOL, true);
registry::setValue(colours::RKEY_OVERRIDE_LIGHTCOL, false);
}
TEST_F(EntityTest, OverrideEClassColour)
{
auto light = createByClassName("light");
auto torch = createByClassName("light_torchflame_small");
auto lightCls = light->getEntity().getEntityClass();
auto torchCls = torch->getEntity().getEntityClass();
static const Vector3 GREEN(0, 1, 0);
static const Vector3 YELLOW(1, 0, 1);
// Light has an explicit green editor_color
EXPECT_EQ(lightCls->getColour(), GREEN);
// This class does not have an explicit editor_color value, but should
// inherit the one from 'light'.
EXPECT_EQ(torchCls->getColour(), GREEN);
// Set an override for the 'light' class
GlobalEclassColourManager().addOverrideColour("light", YELLOW);
// Both 'light' and its subclasses should have the new colour
EXPECT_EQ(lightCls->getColour(), YELLOW);
EXPECT_EQ(torchCls->getColour(), YELLOW);
}
TEST_F(EntityTest, FuncStaticLocalToWorld)
{
auto funcStatic = createByClassName("func_static");
auto& spawnArgs = funcStatic->getEntity();
spawnArgs.setKeyValue("origin", "0 0 0");
// Initial localToWorld should be an identity matrix
EXPECT_EQ(funcStatic->localToWorld(), Matrix4::getIdentity());
// Set a new origin and make sure the localToWorld reflects the
// corresponding translation
const Vector3 MOVED(46, -128, 4096);
spawnArgs.setKeyValue("origin", string::to_string(MOVED));
EXPECT_EQ(funcStatic->localToWorld(),
Matrix4::getTranslation(MOVED));
// Clear transformation and get back to identity
spawnArgs.setKeyValue("origin", "0 0 0");
EXPECT_EQ(funcStatic->localToWorld(), Matrix4::getIdentity());
}
TEST_F(EntityTest, TranslateFuncStatic)
{
auto torch = TestEntity::create("func_static");
torch.args().setKeyValue("origin", "0 0 0");
torch.args().setKeyValue("model", "models/torch.lwo");
// Set translation via the ITransformable interface
auto transformable = scene::node_cast<ITransformable>(torch.node);
ASSERT_TRUE(transformable);
transformable->setTranslation(Vector3(128, 56, -64));
// Translation does not appear in origin spawnarg until frozen
EXPECT_EQ(torch.args().getKeyValue("origin"), "0 0 0");
transformable->freezeTransform();
EXPECT_EQ(torch.args().getKeyValue("origin"), "128 56 -64");
}
TEST_F(EntityTest, RotateFuncStatic)
{
auto torch = TestEntity::create("func_static");
torch.args().setKeyValue("origin", "0 0 0");
torch.args().setKeyValue("model", "models/torch.lwo");
// Set rotation via the ITransformable interface
auto transformable = scene::node_cast<ITransformable>(torch.node);
ASSERT_TRUE(transformable);
transformable->setRotation(Quaternion::createForEulerXYZDegrees(Vector3(0, 0, 45)));
// Should not appear in spawnargs until frozen
EXPECT_EQ(torch.args().getKeyValue("rotation"), "");
transformable->freezeTransform();
EXPECT_EQ(torch.args().getKeyValue("rotation"),
"0.707107 0.707107 0 -0.707107 0.707107 0 0 0 1");
// Applying the transform should be idempotent
transformable->freezeTransform();
EXPECT_EQ(torch.args().getKeyValue("rotation"),
"0.707107 0.707107 0 -0.707107 0.707107 0 0 0 1");
// Rotation does not change origin
EXPECT_EQ(torch.args().getKeyValue("origin"), "0 0 0");
}
TEST_F(EntityTest, RotateLight)
{
auto light = TestEntity::create("light");
light.args().setKeyValue("origin", "0 0 0");
// Rotate the light via ITransformable
auto transformable = scene::node_cast<ITransformable>(light.node);
ASSERT_TRUE(transformable);
transformable->setRotation(Quaternion::createForEulerXYZDegrees(Vector3(0, 0, 75)));
// Rotation appears after freezing transform
EXPECT_EQ(light.args().getKeyValue("rotation"), "");
transformable->freezeTransform();
EXPECT_EQ(light.args().getKeyValue("rotation"),
"0.258819 0.965926 0 -0.965926 0.258819 0 0 0 1");
}
TEST_F(EntityTest, TranslateFuncStaticAfterRotation)
{
auto torch = TestEntity::create("func_static");
torch.args().setKeyValue("origin", "0 0 0");
torch.args().setKeyValue("model", "models/torch.lwo");
// Set rotation via the ITransformable interface and freeze the transform
auto transformable = scene::node_cast<ITransformable>(torch.node);
ASSERT_TRUE(transformable);
transformable->setRotation(Quaternion::createForEulerXYZDegrees(Vector3(0, 0, 90)));
transformable->freezeTransform();
EXPECT_EQ(torch.args().getKeyValue("rotation"), "0 1 0 -1 0 0 0 0 1");
// Now add a translation
transformable->setTranslation(Vector3(-1200, 45, 962));
transformable->freezeTransform();
EXPECT_EQ(torch.args().getKeyValue("origin"), "-1200 45 962");
// Rotation must not have changed
EXPECT_EQ(torch.args().getKeyValue("rotation"), "0 1 0 -1 0 0 0 0 1");
}
TEST_F(EntityTest, TranslateLightAfterRotation)
{
auto light = TestEntity::create("light");
light.args().setKeyValue("origin", "0 0 0");
// Set rotation via the ITransformable interface and freeze the transform
auto transformable = scene::node_cast<ITransformable>(light.node);
ASSERT_TRUE(transformable);
transformable->setRotation(Quaternion::createForEulerXYZDegrees(Vector3(0, 0, 90)));
transformable->freezeTransform();
EXPECT_EQ(light.args().getKeyValue("rotation"), "0 1 0 -1 0 0 0 0 1");
// Now add a translation
transformable->setTranslation(Vector3(565.25, -450, 35.2));
transformable->freezeTransform();
EXPECT_EQ(light.args().getKeyValue("origin"), "565.25 -450 35.2");
// Rotation must not have changed
EXPECT_EQ(light.args().getKeyValue("rotation"), "0 1 0 -1 0 0 0 0 1");
}
TEST_F(EntityTest, LightTransformedByParent)
{
// Parent a light to another entity (this isn't currently how the attachment
// system is implemented, but it should validate that a light node can
// inherit the transformation of its parent).
auto light = createByClassName("light");
auto parentModel = createByClassName("func_static");
parentModel->addChildNode(light);
// Parenting should automatically set the parent pointer of the child
EXPECT_EQ(light->getParent(), parentModel);
// Set an offset for the parent model
const Vector3 ORIGIN(1024, 512, -320);
parentModel->getEntity().setKeyValue("origin", string::to_string(ORIGIN));
// Parent entity should have a transform matrix corresponding to its
// translation
EXPECT_EQ(parentModel->localToWorld(), Matrix4::getTranslation(ORIGIN));
// The light itself should have the same transformation as the parent (since
// the method is localToWorld not localToParent).
EXPECT_EQ(light->localToWorld(), Matrix4::getTranslation(ORIGIN));
// Render the light to obtain the RendererLight pointer
RenderFixture renderF(true /* solid */);
renderF.renderSubGraph(parentModel);
EXPECT_EQ(renderF.nodesVisited, 2);
EXPECT_EQ(renderF.collector.lights, 1);
ASSERT_FALSE(renderF.collector.lightPtrs.empty());
// Check the rendered light's geometry
const RendererLight* rLight = renderF.collector.lightPtrs.front();
EXPECT_EQ(rLight->getLightOrigin(), ORIGIN);
EXPECT_EQ(rLight->lightAABB().origin, ORIGIN);
EXPECT_EQ(rLight->lightAABB().extents, Vector3(320, 320, 320));
}
TEST_F(EntityTest, RenderUnselectedLightEntity)
{
auto light = createByClassName("light");
RenderFixture renderF;
// Render the light in wireframe mode.
light->setRenderSystem(renderF.backend);
light->renderWireframe(renderF.collector, renderF.volumeTest);
// Only the light origin diamond should be rendered
EXPECT_EQ(renderF.collector.renderables, 1);
EXPECT_EQ(renderF.collector.lights, 0);
}
TEST_F(EntityTest, RenderSelectedLightEntity)
{
auto light = createByClassName("light");
RenderFixture renderF;
// Select the light then render it in wireframe mode
scene::node_cast<ISelectable>(light)->setSelected(true);
light->setRenderSystem(renderF.backend);
light->renderWireframe(renderF.collector, renderF.volumeTest);
// With the light selected, we should get the origin diamond, the radius and
// the center vertex.
EXPECT_EQ(renderF.collector.renderables, 3);
EXPECT_EQ(renderF.collector.lights, 0);
}
TEST_F(EntityTest, RenderLightAsLightSource)
{
auto light = createByClassName("light_torchflame_small");
auto& spawnArgs = light->getEntity();
// Set a non-default origin for the light
static const Vector3 ORIGIN(-64, 128, 963);
spawnArgs.setKeyValue("origin", string::to_string(ORIGIN));
// Render the light in full materials mode
RenderFixture renderF;
light->setRenderSystem(renderF.backend);
light->renderSolid(renderF.collector, renderF.volumeTest);
// We should get one renderable for the origin diamond, and one light source
EXPECT_EQ(renderF.collector.renderables, 1);
EXPECT_EQ(renderF.collector.lights, 1);
// Confirm properties of the submitted RendererLight
ASSERT_EQ(renderF.collector.lightPtrs.size(), 1);
const RendererLight* rLight = renderF.collector.lightPtrs.front();
ASSERT_TRUE(rLight);
EXPECT_EQ(rLight->getLightOrigin(), ORIGIN);
EXPECT_EQ(rLight->lightAABB().origin, ORIGIN);
// Default light properties from the entitydef
EXPECT_EQ(rLight->lightAABB().extents, Vector3(240, 240, 240));
ASSERT_TRUE(rLight->getShader() && rLight->getShader()->getMaterial());
EXPECT_EQ(rLight->getShader()->getMaterial()->getName(),
"lights/biground_torchflicker");
}
TEST_F(EntityTest, RenderEmptyFuncStatic)
{
auto funcStatic = createByClassName("func_static");
// Func static without a model key is empty
RenderFixture rf;
rf.renderSubGraph(funcStatic);
EXPECT_EQ(rf.nodesVisited, 1);
EXPECT_EQ(rf.collector.lights, 0);
EXPECT_EQ(rf.collector.renderables, 0);
}
TEST_F(EntityTest, RenderFuncStaticWithModel)
{
// Create a func_static with a model key
auto funcStatic = createByClassName("func_static");
funcStatic->getEntity().setKeyValue("model", "models/moss_patch.ase");
RenderFixture rf;
rf.renderSubGraph(funcStatic);
// The entity node itself does not render the model; it is a parent node
// with the model as a child (e.g. as a StaticModelNode). Therefore we
// should have visited two nodes in total: the entity and its model child.
EXPECT_EQ(rf.nodesVisited, 2);
// Only one of the nodes should have submitted renderables
EXPECT_EQ(rf.collector.lights, 0);
EXPECT_EQ(rf.collector.renderables, 1);
}
TEST_F(EntityTest, RenderFuncStaticWithMultiSurfaceModel)
{
// Create a func_static with a model key
auto funcStatic = createByClassName("func_static");
funcStatic->getEntity().setKeyValue("model", "models/torch.lwo");
// This torch model has 3 renderable surfaces
RenderFixture rf;
rf.renderSubGraph(funcStatic);
EXPECT_EQ(rf.collector.lights, 0);
EXPECT_EQ(rf.collector.renderables, 3);
}
TEST_F(EntityTest, CreateAttachedLightEntity)
{
// Create the torch entity which has an attached light
auto torch = createByClassName("atdm:torch_brazier");
ASSERT_TRUE(torch);
// Check that the attachment spawnargs are present
const Entity& spawnArgs = torch->getEntity();
EXPECT_EQ(spawnArgs.getKeyValue("def_attach"), "light_cageflame_small");
EXPECT_EQ(spawnArgs.getKeyValue("pos_attach"), "flame");
EXPECT_EQ(spawnArgs.getKeyValue("name_attach"), "flame");
// Spawnargs should be parsed into a single attachment
auto attachments = getAttachments(torch);
EXPECT_EQ(attachments.size(), 1);
// Examine the properties of the single attachment
Entity::Attachment attachment = attachments.front();
EXPECT_EQ(attachment.eclass, "light_cageflame_small");
EXPECT_EQ(attachment.offset, Vector3(0, 0, 10));
}
TEST_F(EntityTest, RenderAttachedLightEntity)
{
auto torch = createByClassName("atdm:torch_brazier");
ASSERT_TRUE(torch);
// Confirm that def has the right model
auto& spawnArgs = torch->getEntity();
EXPECT_EQ(spawnArgs.getKeyValue("model"), "models/torch.lwo");
// We must render in solid mode to get the light source
RenderFixture rf(true /* solid mode */);
rf.renderSubGraph(torch);