3
0

EditorLayerComponentTests.cpp 110 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384
  1. /*
  2. * Copyright (c) Contributors to the Open 3D Engine Project.
  3. * For complete copyright and license terms please see the LICENSE at the root of this distribution.
  4. *
  5. * SPDX-License-Identifier: Apache-2.0 OR MIT
  6. *
  7. */
  8. #include <AzTest/AzTest.h>
  9. #include <AzCore/Asset/AssetManagerBus.h>
  10. #include <AzCore/Serialization/Utils.h>
  11. #include <AzCore/UnitTest/TestTypes.h>
  12. #include <AzCore/UnitTest/UnitTest.h>
  13. #include <AzCore/UserSettings/UserSettingsComponent.h>
  14. #include <AzToolsFramework/API/EntityCompositionRequestBus.h>
  15. #include <AzToolsFramework/Entity/EditorEntityActionComponent.h>
  16. #include <AzToolsFramework/Entity/EditorEntityContextComponent.h>
  17. #include <AzToolsFramework/Entity/EditorEntityInfoBus.h>
  18. #include <AzToolsFramework/ToolsComponents/EditorComponentBase.h>
  19. #include <AzToolsFramework/ToolsComponents/EditorLayerComponent.h>
  20. #include <AzToolsFramework/ToolsComponents/EditorLockComponentBus.h>
  21. #include <AzToolsFramework/ToolsComponents/EditorVisibilityBus.h>
  22. #include <AzToolsFramework/UI/PropertyEditor/EntityPropertyEditor.hxx>
  23. #include <AzToolsFramework/UnitTest/AzToolsFrameworkTestHelpers.h>
  24. #include <AzToolsFramework/UnitTest/ToolsTestApplication.h>
  25. #include <AzToolsFramework/API/EntityCompositionRequestBus.h>
  26. #include <QColor>
  27. namespace AzToolsFramework
  28. {
  29. // Used to promote some functions to public so the unit tests can access them.
  30. class EditorLayerComponentTestHelper :
  31. public Layers::EditorLayerComponent
  32. {
  33. public:
  34. AZ_EDITOR_COMPONENT(EditorLayerComponentTestHelper, "{E21CAB65-BFDC-4DFC-B550-A8BF7F235BDA}", Layers::EditorLayerComponent);
  35. static void Reflect(AZ::ReflectContext* context)
  36. {
  37. if (auto serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
  38. {
  39. serializeContext->Class<EditorLayerComponentTestHelper, Layers::EditorLayerComponent>()
  40. ->Version(1);
  41. }
  42. }
  43. void ClearUnsavedChanges() { m_hasUnsavedChanges = false; }
  44. void SetSaveAsBinary(bool saveAsBinary) { m_editableLayerProperties.m_saveAsBinary = saveAsBinary; }
  45. bool GetSaveAsBinary() const { return m_editableLayerProperties.m_saveAsBinary; }
  46. // Forces a state where a layer is written to a stream with 2 entities with the same ID.
  47. // This allows for testing that the layer load logic safely removes duplicates.
  48. Layers::LayerResult CreateLayerStreamWithDuplicateEntity(
  49. AZStd::vector<AZ::Entity*>& entityList,
  50. AZ::SliceComponent::SliceReferenceToInstancePtrs& layerInstances,
  51. AZ::IO::ByteContainerStream<AZStd::vector<char> >& layerStream,
  52. Layers::EditorLayer& layer)
  53. {
  54. Layers::LayerResult layerPrepareResult = PrepareLayerForSaving(layer, entityList, layerInstances);
  55. if (!layerPrepareResult.IsSuccess())
  56. {
  57. return layerPrepareResult;
  58. }
  59. // Add the first entity in the list twice.
  60. layer.m_layerEntities.push_back(layer.m_layerEntities.front());
  61. return WriteLayerToStream(layer, layerStream);
  62. }
  63. // The unit tests are just testing the ability to save and load layers,
  64. // and not the ability to write this information to disk.
  65. // These functions allow this testing to occur.
  66. Layers::LayerResult PopulateLayerWriteToStreamAndGetEntities(
  67. AZStd::vector<AZ::Entity*>& entityList,
  68. AZ::SliceComponent::SliceReferenceToInstancePtrs& layerInstances,
  69. AZ::IO::ByteContainerStream<AZStd::vector<char> >& layerStream,
  70. Layers::EditorLayer& layer)
  71. {
  72. Layers::LayerResult layerPrepareResult = PrepareLayerForSaving(layer, entityList, layerInstances);
  73. if (!layerPrepareResult.IsSuccess())
  74. {
  75. return layerPrepareResult;
  76. }
  77. return WriteLayerToStream(layer, layerStream);
  78. }
  79. Layers::LayerResult ReadFromLayerStream(
  80. AZ::IO::ByteContainerStream<AZStd::vector<char> >& layerStream,
  81. AZ::SliceComponent::SliceAssetToSliceInstancePtrs& sliceInstances,
  82. AZStd::unordered_map<AZ::EntityId, AZ::Entity*>& uniqueEntities)
  83. {
  84. m_loadedLayer = AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(layerStream);
  85. EXPECT_NE(m_loadedLayer, nullptr);
  86. return PopulateFromLoadedLayerData(*m_loadedLayer, sliceInstances, uniqueEntities);
  87. }
  88. };
  89. struct EntityAndLayerComponent
  90. {
  91. AZ::Entity* m_entity = nullptr;
  92. // Not all functions being tested are available on the ebus, some need direct access.
  93. EditorLayerComponentTestHelper* m_layer = nullptr;
  94. };
  95. bool IsEntityInList(const AZStd::vector<AZ::Entity*>& entityList, AZ::Entity* entity)
  96. {
  97. return AZStd::find(entityList.begin(), entityList.end(), entity) != entityList.end();
  98. }
  99. bool IsEntityInLooseEditorEntities(AZ::Entity* entity)
  100. {
  101. AZStd::vector<AZ::Entity*> editorEntities;
  102. AzToolsFramework::EditorEntityContextRequestBus::Broadcast(
  103. &AzToolsFramework::EditorEntityContextRequestBus::Events::GetLooseEditorEntities,
  104. editorEntities);
  105. return IsEntityInList(editorEntities, entity);
  106. }
  107. bool IsInstanceAndReferenceInRootSlice(AZ::SliceComponent* rootSlice, AZ::SliceComponent::SliceInstanceAddress sliceInstance)
  108. {
  109. // See if the rootSlice knows about the asset associated with the passed in instance.
  110. // These checks are round about, and not through FindSlice to make sure the root slice's list of references and instances is used.
  111. AZ::SliceComponent::SliceReference* sliceReference = rootSlice->GetSlice(sliceInstance.GetReference()->GetSliceAsset());
  112. if (!sliceReference)
  113. {
  114. return false;
  115. }
  116. // Checking this way makes sure we're using as much data from the rootSlice as possible.
  117. // When moving instances in and out of the root slice, the slice references can change.
  118. return sliceReference->FindInstance(sliceInstance.GetInstance()->GetId()) != nullptr;
  119. }
  120. bool IsLooseEntityInRootSlice(const AZ::SliceComponent* rootSlice, const AZ::EntityId layerEntityId)
  121. {
  122. const EntityList& looseEntities(rootSlice->GetNewEntities());
  123. for (const auto& entity : looseEntities)
  124. {
  125. if (entity->GetId() == layerEntityId)
  126. {
  127. return true;
  128. }
  129. }
  130. return false;
  131. }
  132. AZ::Entity* CreateEditorReadyEntity(const char* entityName)
  133. {
  134. AZ::EntityId createdEntityId;
  135. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  136. createdEntityId,
  137. &AzToolsFramework::EditorEntityContextRequestBus::Events::CreateNewEditorEntity,
  138. entityName);
  139. EXPECT_TRUE(createdEntityId.IsValid());
  140. AZ::Entity* createdEntity = nullptr;
  141. AZ::ComponentApplicationBus::BroadcastResult(createdEntity, &AZ::ComponentApplicationRequests::FindEntity, createdEntityId);
  142. EXPECT_NE(createdEntity, nullptr);
  143. EXPECT_EQ(createdEntity->GetState(), AZ::Entity::State::Active);
  144. createdEntity->Deactivate();
  145. EXPECT_EQ(createdEntity->GetState(), AZ::Entity::State::Init);
  146. AzToolsFramework::EditorEntityContextRequestBus::Broadcast(
  147. &AzToolsFramework::EditorEntityContextRequestBus::Events::AddRequiredComponents,
  148. *createdEntity);
  149. createdEntity->Activate();
  150. EXPECT_EQ(createdEntity->GetState(), AZ::Entity::State::Active);
  151. return createdEntity;
  152. }
  153. EntityAndLayerComponent CreateEntityWithLayer(const char* entityName)
  154. {
  155. EntityAndLayerComponent result;
  156. result.m_entity = CreateEditorReadyEntity(entityName);
  157. result.m_layer = aznew EditorLayerComponentTestHelper();
  158. AZStd::vector<AZ::Component*> newComponents;
  159. newComponents.push_back(result.m_layer);
  160. Components::EditorEntityActionComponent::AddExistingComponentsOutcome componentAddResult(
  161. AZ::Failure(AZStd::string("No listener on AddExistingComponentsToEntity bus.")));
  162. AzToolsFramework::EntityCompositionRequestBus::BroadcastResult(
  163. componentAddResult,
  164. &AzToolsFramework::EntityCompositionRequests::AddExistingComponentsToEntityById,
  165. result.m_entity->GetId(),
  166. newComponents);
  167. EXPECT_TRUE(componentAddResult.IsSuccess());
  168. // Make sure everything is setup correctly.
  169. EXPECT_NE(result.m_entity, nullptr);
  170. EXPECT_NE(result.m_layer, nullptr);
  171. EXPECT_EQ(result.m_entity->GetState(), AZ::Entity::State::Active);
  172. return result;
  173. }
  174. // Filter used to test component copyability.
  175. // Ensure filter passes everything to ensure layer component copyability is unaffected by filter results.
  176. bool DummyComponentFilter([[maybe_unused]] const AZ::SerializeContext::ClassData& classData)
  177. {
  178. return true;
  179. }
  180. class SliceToolsTestApplication : public UnitTest::ToolsTestApplication
  181. {
  182. public:
  183. explicit SliceToolsTestApplication(AZStd::string applicationName)
  184. : ToolsTestApplication(applicationName)
  185. {
  186. }
  187. protected:
  188. bool IsPrefabSystemEnabled() const override
  189. {
  190. return false;
  191. }
  192. };
  193. class EditorLayerComponentTest
  194. : public UnitTest::LeakDetectionFixture
  195. , public UnitTest::TraceBusRedirector
  196. {
  197. protected:
  198. void SetUp() override
  199. {
  200. AZ::ComponentApplication::StartupParameters startupParameters;
  201. startupParameters.m_loadSettingsRegistry = false;
  202. m_app.Start(m_descriptor, startupParameters);
  203. // Without this, the user settings component would attempt to save on finalize/shutdown. Since the file is
  204. // shared across the whole engine, if multiple tests are run in parallel, the saving could cause a crash
  205. // in the unit tests.
  206. AZ::UserSettingsComponentRequestBus::Broadcast(&AZ::UserSettingsComponentRequests::DisableSaveOnFinalize);
  207. AZ::SerializeContext* context = m_app.GetSerializeContext();
  208. m_editorLayerComponentTestHelperDescriptor = EditorLayerComponentTestHelper::CreateDescriptor();
  209. m_editorLayerComponentTestHelperDescriptor->Reflect(context);
  210. m_layerEntity = CreateEntityWithLayer(m_entityName);
  211. AZ::Debug::TraceMessageBus::Handler::BusConnect();
  212. }
  213. void TearDown() override
  214. {
  215. if (m_layerEntity.m_entity)
  216. {
  217. m_layerEntity.m_layer->CleanupLoadedLayer();
  218. }
  219. m_editorLayerComponentTestHelperDescriptor->ReleaseDescriptor();
  220. m_app.Stop();
  221. AZ::Debug::TraceMessageBus::Handler::BusDisconnect();
  222. }
  223. // A few tests save a layer and want to check the state after saving.
  224. // A separate unit test actually validates all of the behavior in this function.
  225. Layers::LayerResult SaveMainLayer(Layers::EditorLayer& layerOutput)
  226. {
  227. AZStd::vector<char> entitySaveBuffer;
  228. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  229. return SaveMainLayer(layerOutput, entitySaveStream);
  230. }
  231. Layers::LayerResult SaveMainLayer(
  232. Layers::EditorLayer& layerOutput,
  233. AZ::IO::ByteContainerStream<AZStd::vector<char> > &streamOutput,
  234. AZStd::vector<AZ::Entity*>& layerEntities,
  235. AZ::SliceComponent::SliceReferenceToInstancePtrs& instancesInLayers)
  236. {
  237. return m_layerEntity.m_layer->PopulateLayerWriteToStreamAndGetEntities(
  238. layerEntities,
  239. instancesInLayers,
  240. streamOutput,
  241. layerOutput);
  242. }
  243. Layers::LayerResult SaveMainLayer(
  244. Layers::EditorLayer& layerOutput,
  245. AZ::IO::ByteContainerStream<AZStd::vector<char> > &streamOutput)
  246. {
  247. AZStd::vector<AZ::Entity*> layerEntities;
  248. AZ::SliceComponent::SliceReferenceToInstancePtrs instancesInLayers;
  249. return SaveMainLayer(layerOutput, streamOutput, layerEntities, instancesInLayers);
  250. }
  251. AZ::SliceComponent::SliceInstanceAddress CreateSliceInstanceFromSlice(
  252. AZ::SliceComponent* rootSlice,
  253. const AZ::Data::Asset<AZ::SliceAsset>& sliceAsset)
  254. {
  255. EXPECT_NE(rootSlice, nullptr);
  256. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = rootSlice->AddSlice(sliceAsset);
  257. AZ::Entity* instanceEntity = GetEntityFromSliceInstance(instantiatedSlice);
  258. instanceEntity->Init();
  259. EXPECT_EQ(instanceEntity->GetState(), AZ::Entity::State::Init);
  260. instanceEntity->Activate();
  261. EXPECT_EQ(instanceEntity->GetState(), AZ::Entity::State::Active);
  262. return instantiatedSlice;
  263. }
  264. // Creates a slice instance, used to test serialization with layers.
  265. // Note that DeleteSliceInstance must be called.
  266. AZ::SliceComponent::SliceInstanceAddress CreateSliceInstance()
  267. {
  268. AZ::Data::Asset<AZ::SliceAsset> sliceAsset;
  269. AZ::Entity* sliceEntity = aznew AZ::Entity("SliceEntity");
  270. AZ::SliceComponent* sliceComponent = sliceEntity->CreateComponent<AZ::SliceComponent>();
  271. sliceComponent->SetSerializeContext(m_app.GetSerializeContext());
  272. AZ::Entity* entityInSlice = aznew AZ::Entity("EntityInSlice");
  273. AzToolsFramework::EditorEntityContextRequestBus::Broadcast(
  274. &AzToolsFramework::EditorEntityContextRequestBus::Events::AddRequiredComponents,
  275. *entityInSlice);
  276. EntityList entitiesToAddToSlice;
  277. entitiesToAddToSlice.push_back(entityInSlice);
  278. sliceComponent->AddEntities(entitiesToAddToSlice);
  279. AZStd::string sliceAssetFile("Temp/GeneratedSlices/LayerTestSlice.slice");
  280. AZ::Data::AssetId assetId;
  281. AZ::Data::AssetCatalogRequestBus::BroadcastResult(
  282. assetId,
  283. &AZ::Data::AssetCatalogRequestBus::Events::GetAssetIdByPath,
  284. sliceAssetFile.c_str(),
  285. azrtti_typeid<AZ::SliceAsset>(),
  286. true);
  287. sliceAsset.Create(assetId, false);
  288. sliceAsset.Get()->SetData(sliceEntity, sliceComponent, false);
  289. sliceComponent->Instantiate();
  290. AZ::SliceComponent* rootSlice;
  291. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  292. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  293. EXPECT_NE(rootSlice, nullptr);
  294. return CreateSliceInstanceFromSlice(rootSlice, sliceAsset);
  295. }
  296. AZ::Entity* GetEntityFromSliceInstance(AZ::SliceComponent::SliceInstanceAddress instantiatedSlice)
  297. {
  298. EXPECT_TRUE(instantiatedSlice.IsValid());
  299. EXPECT_NE(instantiatedSlice.GetInstance(), nullptr);
  300. EXPECT_NE(instantiatedSlice.GetInstance()->GetInstantiated(), nullptr);
  301. EXPECT_EQ(instantiatedSlice.GetInstance()->GetInstantiated()->m_entities.size(), 1);
  302. return instantiatedSlice.GetInstance()->GetInstantiated()->m_entities[0];
  303. }
  304. void DeleteSliceInstance(AZ::SliceComponent::SliceInstanceAddress instance)
  305. {
  306. AZ::SliceComponent* rootSlice;
  307. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  308. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  309. EXPECT_NE(rootSlice, nullptr);
  310. rootSlice->RemoveSliceInstance(instance);
  311. }
  312. const char* m_entityName = "LayerEntityName";
  313. SliceToolsTestApplication m_app{ "EditorLayerComponentTest" };
  314. EntityAndLayerComponent m_layerEntity;
  315. AZ::ComponentApplication::Descriptor m_descriptor;
  316. AZ::ComponentDescriptor* m_editorLayerComponentTestHelperDescriptor = nullptr;
  317. };
  318. TEST_F(EditorLayerComponentTest, LayerTests_EntityCreatedWithLayer_HasLayerReturnsTrue)
  319. {
  320. bool isLayerEntity = false;
  321. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  322. isLayerEntity,
  323. m_layerEntity.m_entity->GetId(),
  324. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::HasLayer);
  325. EXPECT_TRUE(isLayerEntity);
  326. }
  327. TEST_F(EditorLayerComponentTest, LayerTests_GetLayerColor_ReturnsCorrectColor)
  328. {
  329. // Layers serialize color as an AZ::Color because it works with our serialization system,
  330. // but GetColor returns a QColor because it works with our UI system to render with the color.
  331. // Alpha is not tested because layers don't use alpha.
  332. AZ::Color setLayerColor(aznumeric_cast<uint8_t>(255), aznumeric_cast<uint8_t>(128), aznumeric_cast<uint8_t>(64), aznumeric_cast<uint8_t>(255));
  333. m_layerEntity.m_layer->SetLayerColor(setLayerColor);
  334. // Set the get color to specifically not be the same as the set, so we know if the ebus
  335. // was connected and worked.
  336. QColor getLayerColor(0, 0, 0);
  337. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  338. getLayerColor,
  339. m_layerEntity.m_entity->GetId(),
  340. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::GetLayerColor);
  341. EXPECT_EQ(getLayerColor.red(), setLayerColor.GetR8());
  342. EXPECT_EQ(getLayerColor.green(), setLayerColor.GetG8());
  343. EXPECT_EQ(getLayerColor.blue(), setLayerColor.GetB8());
  344. }
  345. TEST_F(EditorLayerComponentTest, LayerTests_SingleLayer_LayerNameIsValid)
  346. {
  347. bool isLayerNameValid = false;
  348. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  349. isLayerNameValid,
  350. m_layerEntity.m_entity->GetId(),
  351. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::IsLayerNameValid);
  352. EXPECT_TRUE(isLayerNameValid);
  353. }
  354. TEST_F(EditorLayerComponentTest, LayerTests_TwoLayersUniqueNames_LayerNameIsValid)
  355. {
  356. CreateEntityWithLayer("UniqueLayerName");
  357. bool isLayerNameValid = true;
  358. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  359. isLayerNameValid,
  360. m_layerEntity.m_entity->GetId(),
  361. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::IsLayerNameValid);
  362. EXPECT_TRUE(isLayerNameValid);
  363. }
  364. TEST_F(EditorLayerComponentTest, LayerTests_TwoLayersConflictingNames_LayerNameIsNotValid)
  365. {
  366. CreateEntityWithLayer(m_entityName);
  367. bool isLayerNameValid = true;
  368. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  369. isLayerNameValid,
  370. m_layerEntity.m_entity->GetId(),
  371. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::IsLayerNameValid);
  372. EXPECT_FALSE(isLayerNameValid);
  373. }
  374. TEST_F(EditorLayerComponentTest, LayerTests_TwoLayersConflictingNames_LayerNameConflictingMappingShowsConflict)
  375. {
  376. EntityAndLayerComponent secondLayer = CreateEntityWithLayer(m_entityName);
  377. AZStd::unordered_set<AZ::EntityId> layerEntities;
  378. layerEntities.insert(m_layerEntity.m_entity->GetId());
  379. layerEntities.insert(secondLayer.m_entity->GetId());
  380. AZStd::unordered_map<AZStd::string, int> nameConflictMapping;
  381. for (AZ::EntityId layerEntityId : layerEntities)
  382. {
  383. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  384. layerEntityId,
  385. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::UpdateLayerNameConflictMapping,
  386. nameConflictMapping);
  387. }
  388. EXPECT_EQ(nameConflictMapping[m_entityName], 2);
  389. }
  390. TEST_F(EditorLayerComponentTest, LayerTests_TwoLayersSameNameDifferentCase_LayerNameConflictingMappingShowsConflict)
  391. {
  392. AZStd::string upperCaseName = m_entityName;
  393. AZStd::to_upper(upperCaseName.begin(), upperCaseName.end());
  394. // Verify that the casing actually changed. This catches if someone adjusts the
  395. // default layer name in these layer tests to be all upper case.
  396. EXPECT_NE(upperCaseName.compare(m_entityName), 0);
  397. EntityAndLayerComponent secondLayer = CreateEntityWithLayer(upperCaseName.c_str());
  398. AZStd::unordered_set<AZ::EntityId> layerEntities;
  399. layerEntities.insert(m_layerEntity.m_entity->GetId());
  400. layerEntities.insert(secondLayer.m_entity->GetId());
  401. AZStd::unordered_map<AZStd::string, int> nameConflictMapping;
  402. for (AZ::EntityId layerEntityId : layerEntities)
  403. {
  404. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  405. layerEntityId,
  406. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::UpdateLayerNameConflictMapping,
  407. nameConflictMapping);
  408. }
  409. EXPECT_EQ(nameConflictMapping[m_entityName], 2);
  410. }
  411. TEST_F(EditorLayerComponentTest, LayerTests_TwoLayersUniqueNames_NameConflictMappingHasNoConflicts)
  412. {
  413. EntityAndLayerComponent secondLayer = CreateEntityWithLayer("UniqueLayerName");
  414. AZStd::unordered_set<AZ::EntityId> layerEntities;
  415. layerEntities.insert(m_layerEntity.m_entity->GetId());
  416. layerEntities.insert(secondLayer.m_entity->GetId());
  417. AZStd::unordered_map<AZStd::string, int> nameConflictMapping;
  418. for (AZ::EntityId layerEntityId : layerEntities)
  419. {
  420. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  421. layerEntityId,
  422. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::UpdateLayerNameConflictMapping,
  423. nameConflictMapping);
  424. }
  425. EXPECT_EQ(nameConflictMapping.find(m_entityName), nameConflictMapping.end());
  426. }
  427. // The design of this is expected to change, but this unit test validates current behavior.
  428. // Eventually we would like to decouple the layer name from the entity name.
  429. TEST_F(EditorLayerComponentTest, LayerTests_LayerWithNoParent_FileNameIsEntityName)
  430. {
  431. AZ::Outcome<AZStd::string, AZStd::string> layerFileNameResult(
  432. AZ::Failure(AZStd::string("No ebus listener available for this layer.")));
  433. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  434. layerFileNameResult,
  435. m_layerEntity.m_entity->GetId(),
  436. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::GetLayerBaseFileName);
  437. EXPECT_TRUE(layerFileNameResult.IsSuccess());
  438. EXPECT_EQ(layerFileNameResult.GetValue().compare(m_entityName), 0);
  439. }
  440. TEST_F(EditorLayerComponentTest, LayerTests_LayerWithParent_FileNameIsParentDotEntityName)
  441. {
  442. const AZStd::string parentName = "AParentLayer";
  443. EntityAndLayerComponent parentLayer = CreateEntityWithLayer(parentName.c_str());
  444. AZ::TransformBus::Event(
  445. m_layerEntity.m_entity->GetId(),
  446. &AZ::TransformBus::Events::SetParent,
  447. parentLayer.m_entity->GetId());
  448. AZ::Outcome<AZStd::string, AZStd::string> layerFileNameResult(
  449. AZ::Failure(AZStd::string("No ebus listener available for this layer.")));
  450. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  451. layerFileNameResult,
  452. m_layerEntity.m_entity->GetId(),
  453. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::GetLayerBaseFileName);
  454. EXPECT_TRUE(layerFileNameResult.IsSuccess());
  455. AZStd::string expectedParentName = parentName + "." + m_entityName;
  456. EXPECT_EQ(layerFileNameResult.GetValue().compare(expectedParentName), 0);
  457. }
  458. TEST_F(EditorLayerComponentTest, LayerTests_SetVisibility_GetVisibilityReturnsCorrectValue)
  459. {
  460. bool currentVisibility = false;
  461. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  462. currentVisibility,
  463. m_layerEntity.m_entity->GetId(),
  464. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  465. EXPECT_EQ(currentVisibility, true);
  466. bool flippedVisibility = !currentVisibility;
  467. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  468. m_layerEntity.m_entity->GetId(),
  469. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  470. flippedVisibility);
  471. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  472. currentVisibility,
  473. m_layerEntity.m_entity->GetId(),
  474. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  475. EXPECT_EQ(flippedVisibility, currentVisibility);
  476. // Change the visibility again to make sure setting it to both values works.
  477. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  478. m_layerEntity.m_entity->GetId(),
  479. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  480. !flippedVisibility);
  481. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  482. currentVisibility,
  483. m_layerEntity.m_entity->GetId(),
  484. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  485. EXPECT_EQ(!flippedVisibility, currentVisibility);
  486. }
  487. TEST_F(EditorLayerComponentTest, LayerTests_NewLayer_HasUnsavedChanges)
  488. {
  489. bool hasUnsavedChanges = false;
  490. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  491. hasUnsavedChanges,
  492. m_layerEntity.m_entity->GetId(),
  493. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::HasUnsavedChanges);
  494. EXPECT_TRUE(hasUnsavedChanges);
  495. }
  496. TEST_F(EditorLayerComponentTest, LayerTests_SavedLayer_DoesNotHaveUnsavedChanges)
  497. {
  498. m_layerEntity.m_layer->ClearUnsavedChanges();
  499. bool hasUnsavedChanges = true;
  500. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  501. hasUnsavedChanges,
  502. m_layerEntity.m_entity->GetId(),
  503. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::HasUnsavedChanges);
  504. EXPECT_FALSE(hasUnsavedChanges);
  505. }
  506. TEST_F(EditorLayerComponentTest, LayerTests_AddedEntityToLayer_HasUnsavedChanges)
  507. {
  508. m_layerEntity.m_layer->ClearUnsavedChanges();
  509. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  510. // An undo batch needs to begin before the entity can be registered as dirty
  511. AzToolsFramework::ScopedUndoBatch undoBatch("Reparent Entity");
  512. AZ::TransformBus::Event(
  513. childEntity->GetId(),
  514. &AZ::TransformBus::Events::SetParent,
  515. m_layerEntity.m_entity->GetId());
  516. bool hasUnsavedChanges = false;
  517. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  518. hasUnsavedChanges,
  519. m_layerEntity.m_entity->GetId(),
  520. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::HasUnsavedChanges);
  521. EXPECT_TRUE(hasUnsavedChanges);
  522. }
  523. TEST_F(EditorLayerComponentTest, LayerTests_ModifiedEntityInLayer_HasUnsavedChanges)
  524. {
  525. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  526. AZ::TransformBus::Event(
  527. childEntity->GetId(),
  528. &AZ::TransformBus::Events::SetParent,
  529. m_layerEntity.m_entity->GetId());
  530. m_layerEntity.m_layer->ClearUnsavedChanges();
  531. // Change the scale of the child entity so it registers as an unsaved change on the layer.
  532. // An undo batch needs to begin before the entity can be registered as dirty
  533. AzToolsFramework::ScopedUndoBatch undoBatch("Scale Entity");
  534. float scale = 0.0f;
  535. AZ::TransformBus::EventResult(
  536. scale,
  537. childEntity->GetId(),
  538. &AZ::TransformBus::Events::GetLocalUniformScale);
  539. scale += 1.0f;
  540. AZ::TransformBus::Event(
  541. childEntity->GetId(),
  542. &AZ::TransformBus::Events::SetLocalUniformScale,
  543. scale);
  544. bool hasUnsavedChanges = false;
  545. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  546. hasUnsavedChanges,
  547. m_layerEntity.m_entity->GetId(),
  548. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::HasUnsavedChanges);
  549. EXPECT_TRUE(hasUnsavedChanges);
  550. }
  551. TEST_F(EditorLayerComponentTest, LayerTests_CanParentChangeToNonLayer_ReturnsFalse)
  552. {
  553. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  554. bool canParentChange = true;
  555. AZ::TransformNotificationBus::Event(
  556. m_layerEntity.m_entity->GetId(),
  557. &AZ::TransformNotificationBus::Events::CanParentChange,
  558. canParentChange,
  559. AZ::EntityId(),
  560. childEntity->GetId());
  561. EXPECT_FALSE(canParentChange);
  562. }
  563. TEST_F(EditorLayerComponentTest, LayerTests_CanParentChangeToLayer_ReturnsTrue)
  564. {
  565. EntityAndLayerComponent secondLayer = CreateEntityWithLayer("UniqueLayerName");
  566. // Most tests around ebuses, the value is initialized to the opposite of the expected result.
  567. // This particular message is an aggregate message that goes out to multiple listeners,
  568. // and any of them can decline the parent change. This means that the initial
  569. // value needs to start true.
  570. bool canParentChange = true;
  571. AZ::TransformNotificationBus::Event(
  572. m_layerEntity.m_entity->GetId(),
  573. &AZ::TransformNotificationBus::Events::CanParentChange,
  574. canParentChange,
  575. AZ::EntityId(),
  576. secondLayer.m_entity->GetId());
  577. EXPECT_TRUE(canParentChange);
  578. }
  579. TEST_F(EditorLayerComponentTest, LayerTests_CanParentChangeFromLayerToInvalid_ReturnsTrue)
  580. {
  581. EntityAndLayerComponent secondLayer = CreateEntityWithLayer("UniqueLayerName");
  582. AZ::TransformBus::Event(
  583. m_layerEntity.m_entity->GetId(),
  584. &AZ::TransformBus::Events::SetParent,
  585. secondLayer.m_entity->GetId());
  586. bool canParentChange = true;
  587. AZ::TransformNotificationBus::Event(
  588. m_layerEntity.m_entity->GetId(),
  589. &AZ::TransformNotificationBus::Events::CanParentChange,
  590. canParentChange,
  591. secondLayer.m_entity->GetId(),
  592. AZ::EntityId());
  593. EXPECT_TRUE(canParentChange);
  594. }
  595. TEST_F(EditorLayerComponentTest, LayerTests_AttemptToSetParentToNonLayer_ParentDoesNotChange)
  596. {
  597. AZ::Entity* nonLayerEntity = CreateEditorReadyEntity("NonLayerEntity");
  598. AZ::TransformBus::Event(
  599. m_layerEntity.m_entity->GetId(),
  600. &AZ::TransformBus::Events::SetParent,
  601. nonLayerEntity->GetId());
  602. AZ::EntityId parentId = nonLayerEntity->GetId();
  603. AZ::TransformBus::EventResult(
  604. parentId,
  605. m_layerEntity.m_entity->GetId(),
  606. &AZ::TransformBus::Events::GetParentId);
  607. EXPECT_EQ(parentId, AZ::EntityId());
  608. }
  609. TEST_F(EditorLayerComponentTest, LayerTests_VisibleLayerVisibleChild_BothVisible)
  610. {
  611. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  612. AZ::TransformBus::Event(
  613. childEntity->GetId(),
  614. &AZ::TransformBus::Events::SetParent,
  615. m_layerEntity.m_entity->GetId());
  616. bool layerChildrenVisibility = false;
  617. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  618. layerChildrenVisibility,
  619. m_layerEntity.m_entity->GetId(),
  620. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  621. bool isChildVisible = false;
  622. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  623. isChildVisible,
  624. childEntity->GetId(),
  625. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsVisible);
  626. bool isChildVisibilityFlagSet = false;
  627. AzToolsFramework::EditorVisibilityRequestBus::EventResult(
  628. isChildVisibilityFlagSet,
  629. childEntity->GetId(),
  630. &AzToolsFramework::EditorVisibilityRequestBus::Events::GetVisibilityFlag);
  631. EXPECT_TRUE(layerChildrenVisibility);
  632. EXPECT_TRUE(isChildVisible);
  633. EXPECT_TRUE(isChildVisibilityFlagSet);
  634. }
  635. TEST_F(EditorLayerComponentTest, LayerTests_InvisibleLayerVisibleChild_BothInvisibleChildPreservesVisibility)
  636. {
  637. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  638. m_layerEntity.m_entity->GetId(),
  639. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  640. false);
  641. // This is necessary to prevent a warning in the undo system.
  642. // This unit test had modified an entity to make it dirty, so it needs to be marked as such.
  643. AzToolsFramework::ToolsApplicationRequests::Bus::Broadcast(
  644. &AzToolsFramework::ToolsApplicationRequests::Bus::Events::AddDirtyEntity,
  645. m_layerEntity.m_entity->GetId());
  646. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  647. AZ::TransformBus::Event(
  648. childEntity->GetId(),
  649. &AZ::TransformBus::Events::SetParent,
  650. m_layerEntity.m_entity->GetId());
  651. bool layerChildrenVisibility = true;
  652. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  653. layerChildrenVisibility,
  654. m_layerEntity.m_entity->GetId(),
  655. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  656. bool isChildVisible = true;
  657. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  658. isChildVisible,
  659. childEntity->GetId(),
  660. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsVisible);
  661. bool isChildVisibilityFlagSet = false;
  662. AzToolsFramework::EditorVisibilityRequestBus::EventResult(
  663. isChildVisibilityFlagSet,
  664. childEntity->GetId(),
  665. &AzToolsFramework::EditorVisibilityRequestBus::Events::GetVisibilityFlag);
  666. EXPECT_FALSE(layerChildrenVisibility);
  667. EXPECT_FALSE(isChildVisible);
  668. EXPECT_TRUE(isChildVisibilityFlagSet);
  669. }
  670. // Layer visibility toggle only works one way: Invisible layers make all children invisible, but
  671. // visible layers do not force children to be visible.
  672. TEST_F(EditorLayerComponentTest, LayerTests_VisibleLayerInvisibleChild_ChildIsInvisible)
  673. {
  674. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  675. AZ::TransformBus::Event(
  676. childEntity->GetId(),
  677. &AZ::TransformBus::Events::SetParent,
  678. m_layerEntity.m_entity->GetId());
  679. AzToolsFramework::EditorVisibilityRequestBus::Event(
  680. childEntity->GetId(),
  681. &AzToolsFramework::EditorVisibilityRequestBus::Events::SetVisibilityFlag,
  682. false);
  683. bool layerChildrenVisibility = false;
  684. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  685. layerChildrenVisibility,
  686. m_layerEntity.m_entity->GetId(),
  687. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  688. bool isChildVisible = true;
  689. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  690. isChildVisible,
  691. childEntity->GetId(),
  692. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsVisible);
  693. bool isChildVisibilityFlagSet = true;
  694. AzToolsFramework::EditorVisibilityRequestBus::EventResult(
  695. isChildVisibilityFlagSet,
  696. childEntity->GetId(),
  697. &AzToolsFramework::EditorVisibilityRequestBus::Events::GetVisibilityFlag);
  698. EXPECT_TRUE(layerChildrenVisibility);
  699. EXPECT_FALSE(isChildVisible);
  700. EXPECT_FALSE(isChildVisibilityFlagSet);
  701. }
  702. TEST_F(EditorLayerComponentTest, LayerTests_InvisibleLayerInvisibleChild_BothInvisibleChildPreservesVisibility)
  703. {
  704. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  705. m_layerEntity.m_entity->GetId(),
  706. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  707. false);
  708. AzToolsFramework::ToolsApplicationRequests::Bus::Broadcast(
  709. &AzToolsFramework::ToolsApplicationRequests::Bus::Events::AddDirtyEntity,
  710. m_layerEntity.m_entity->GetId());
  711. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  712. AZ::TransformBus::Event(
  713. childEntity->GetId(),
  714. &AZ::TransformBus::Events::SetParent,
  715. m_layerEntity.m_entity->GetId());
  716. AzToolsFramework::EditorVisibilityRequestBus::Event(
  717. childEntity->GetId(),
  718. &AzToolsFramework::EditorVisibilityRequestBus::Events::SetVisibilityFlag,
  719. false);
  720. bool layerChildrenVisibility = true;
  721. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  722. layerChildrenVisibility,
  723. m_layerEntity.m_entity->GetId(),
  724. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  725. bool isChildVisible = true;
  726. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  727. isChildVisible,
  728. childEntity->GetId(),
  729. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsVisible);
  730. bool isChildVisibilityFlagSet = true;
  731. AzToolsFramework::EditorVisibilityRequestBus::EventResult(
  732. isChildVisibilityFlagSet,
  733. childEntity->GetId(),
  734. &AzToolsFramework::EditorVisibilityRequestBus::Events::GetVisibilityFlag);
  735. EXPECT_FALSE(layerChildrenVisibility);
  736. EXPECT_FALSE(isChildVisible);
  737. EXPECT_FALSE(isChildVisibilityFlagSet);
  738. }
  739. TEST_F(EditorLayerComponentTest, LayerTests_InvisLayerVisLayerVisChild_AllInvisiblePreservingVisibility)
  740. {
  741. const AZStd::string parentName = "AParentLayer";
  742. EntityAndLayerComponent parentLayer = CreateEntityWithLayer(parentName.c_str());
  743. AZ::TransformBus::Event(
  744. m_layerEntity.m_entity->GetId(),
  745. &AZ::TransformBus::Events::SetParent,
  746. parentLayer.m_entity->GetId());
  747. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  748. AZ::TransformBus::Event(
  749. childEntity->GetId(),
  750. &AZ::TransformBus::Events::SetParent,
  751. m_layerEntity.m_entity->GetId());
  752. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  753. parentLayer.m_entity->GetId(),
  754. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  755. false);
  756. AzToolsFramework::ToolsApplicationRequests::Bus::Broadcast(
  757. &AzToolsFramework::ToolsApplicationRequests::Bus::Events::AddDirtyEntity,
  758. parentLayer.m_entity->GetId());
  759. bool parentLayerChildrenVisible = true;
  760. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  761. parentLayerChildrenVisible,
  762. parentLayer.m_entity->GetId(),
  763. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  764. bool layerChildrenVisibility = false;
  765. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  766. layerChildrenVisibility,
  767. m_layerEntity.m_entity->GetId(),
  768. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  769. bool isChildVisible = true;
  770. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  771. isChildVisible,
  772. childEntity->GetId(),
  773. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsVisible);
  774. bool isChildVisibilityFlagSet = false;
  775. AzToolsFramework::EditorVisibilityRequestBus::EventResult(
  776. isChildVisibilityFlagSet,
  777. childEntity->GetId(),
  778. &AzToolsFramework::EditorVisibilityRequestBus::Events::GetVisibilityFlag);
  779. EXPECT_FALSE(parentLayerChildrenVisible);
  780. EXPECT_TRUE(layerChildrenVisibility);
  781. EXPECT_FALSE(isChildVisible);
  782. EXPECT_TRUE(isChildVisibilityFlagSet);
  783. }
  784. TEST_F(EditorLayerComponentTest, LayerTests_UnlockedLayerUnlockedChild_BothUnlocked)
  785. {
  786. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  787. AZ::TransformBus::Event(
  788. childEntity->GetId(),
  789. &AZ::TransformBus::Events::SetParent,
  790. m_layerEntity.m_entity->GetId());
  791. bool isLayerLocked = true;
  792. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  793. isLayerLocked,
  794. m_layerEntity.m_entity->GetId(),
  795. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  796. bool isChildLockFlagSet = true;
  797. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  798. isChildLockFlagSet,
  799. childEntity->GetId(),
  800. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  801. bool isChildLockedViaHierarchy = true;
  802. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  803. isChildLockedViaHierarchy,
  804. childEntity->GetId(),
  805. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsLocked);
  806. EXPECT_FALSE(isLayerLocked);
  807. EXPECT_FALSE(isChildLockFlagSet);
  808. EXPECT_FALSE(isChildLockedViaHierarchy);
  809. }
  810. TEST_F(EditorLayerComponentTest, LayerTests_LockedLayerUnlockedChild_ChildLockedAndPreservesLockState)
  811. {
  812. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  813. AZ::TransformBus::Event(
  814. childEntity->GetId(),
  815. &AZ::TransformBus::Events::SetParent,
  816. m_layerEntity.m_entity->GetId());
  817. AzToolsFramework::EditorLockComponentRequestBus::Event(
  818. m_layerEntity.m_entity->GetId(),
  819. &AzToolsFramework::EditorLockComponentRequests::SetLocked,
  820. true);
  821. bool isLayerLocked = false;
  822. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  823. isLayerLocked,
  824. m_layerEntity.m_entity->GetId(),
  825. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  826. bool isChildLockFlagSet = true;
  827. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  828. isChildLockFlagSet,
  829. childEntity->GetId(),
  830. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  831. bool isChildLockedViaHierarchy = false;
  832. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  833. isChildLockedViaHierarchy,
  834. childEntity->GetId(),
  835. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsLocked);
  836. EXPECT_TRUE(isLayerLocked);
  837. EXPECT_FALSE(isChildLockFlagSet);
  838. EXPECT_TRUE(isChildLockedViaHierarchy);
  839. }
  840. TEST_F(EditorLayerComponentTest, LayerTests_LockedLayerLockedChild_AllLocked)
  841. {
  842. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  843. AZ::TransformBus::Event(
  844. childEntity->GetId(),
  845. &AZ::TransformBus::Events::SetParent,
  846. m_layerEntity.m_entity->GetId());
  847. AzToolsFramework::EditorLockComponentRequestBus::Event(
  848. m_layerEntity.m_entity->GetId(),
  849. &AzToolsFramework::EditorLockComponentRequests::SetLocked,
  850. true);
  851. AzToolsFramework::EditorLockComponentRequestBus::Event(
  852. childEntity->GetId(),
  853. &AzToolsFramework::EditorLockComponentRequests::SetLocked,
  854. true);
  855. bool isLayerLocked = false;
  856. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  857. isLayerLocked,
  858. m_layerEntity.m_entity->GetId(),
  859. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  860. bool isChildLockFlagSet = false;
  861. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  862. isChildLockFlagSet,
  863. childEntity->GetId(),
  864. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  865. bool isChildLockedViaHierarchy = false;
  866. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  867. isChildLockedViaHierarchy,
  868. childEntity->GetId(),
  869. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsLocked);
  870. EXPECT_TRUE(isLayerLocked);
  871. EXPECT_TRUE(isChildLockFlagSet);
  872. EXPECT_TRUE(isChildLockedViaHierarchy);
  873. }
  874. TEST_F(EditorLayerComponentTest, LayerTests_LockLayerUnlockLayerUnlockChild_AllLockedPreservingVisibility)
  875. {
  876. const AZStd::string parentName = "AParentLayer";
  877. EntityAndLayerComponent parentLayer = CreateEntityWithLayer(parentName.c_str());
  878. AZ::TransformBus::Event(
  879. m_layerEntity.m_entity->GetId(),
  880. &AZ::TransformBus::Events::SetParent,
  881. parentLayer.m_entity->GetId());
  882. AZ::Entity* childEntity = CreateEditorReadyEntity("NonLayerEntity");
  883. AZ::TransformBus::Event(
  884. childEntity->GetId(),
  885. &AZ::TransformBus::Events::SetParent,
  886. m_layerEntity.m_entity->GetId());
  887. AzToolsFramework::EditorLockComponentRequestBus::Event(
  888. parentLayer.m_entity->GetId(),
  889. &AzToolsFramework::EditorLockComponentRequests::SetLocked,
  890. true);
  891. bool isParentLocked = false;
  892. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  893. isParentLocked,
  894. parentLayer.m_entity->GetId(),
  895. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  896. bool isLayerLockFlagSet = true;
  897. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  898. isLayerLockFlagSet,
  899. m_layerEntity.m_entity->GetId(),
  900. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  901. bool isLayerLockedViaHierarchy = false;
  902. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  903. isLayerLockedViaHierarchy,
  904. m_layerEntity.m_entity->GetId(),
  905. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsLocked);
  906. bool isChildLockFlagSet = true;
  907. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  908. isChildLockFlagSet,
  909. childEntity->GetId(),
  910. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsJustThisEntityLocked);
  911. bool isChildLockedViaHierarchy = false;
  912. AzToolsFramework::EditorEntityInfoRequestBus::EventResult(
  913. isChildLockedViaHierarchy,
  914. childEntity->GetId(),
  915. &AzToolsFramework::EditorEntityInfoRequestBus::Events::IsLocked);
  916. EXPECT_TRUE(isParentLocked);
  917. EXPECT_TRUE(isLayerLockedViaHierarchy);
  918. EXPECT_FALSE(isLayerLockFlagSet);
  919. EXPECT_TRUE(isLayerLockedViaHierarchy);
  920. EXPECT_FALSE(isChildLockFlagSet);
  921. EXPECT_TRUE(isChildLockedViaHierarchy);
  922. }
  923. TEST_F(EditorLayerComponentTest, LayerTests_SaveEmptyLayer_SavesWithoutError)
  924. {
  925. // SaveMainLayer is not called here because this test is testing behavior
  926. // that SaveMainLayer assumes will work.
  927. AZStd::vector<AZ::Entity*> layerEntities;
  928. AZ::SliceComponent::SliceReferenceToInstancePtrs instancesInLayers;
  929. AZStd::vector<char> entitySaveBuffer;
  930. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  931. Layers::EditorLayer layer;
  932. Layers::LayerResult layerResult = m_layerEntity.m_layer->PopulateLayerWriteToStreamAndGetEntities(
  933. layerEntities,
  934. instancesInLayers,
  935. entitySaveStream,
  936. layer);
  937. EXPECT_TRUE(layerResult.IsSuccess());
  938. EXPECT_EQ(layer.m_layerEntities.size(), 0);
  939. EXPECT_EQ(layer.m_sliceAssetsToSliceInstances.size(), 0);
  940. }
  941. // To minimize the need to modify the level file, the color should save to the layer
  942. // and not the level. This is tested by verifying the color is set to zero on the
  943. // layer component after the save, and the color is set correctly in the EditorLayer object.
  944. TEST_F(EditorLayerComponentTest, LayerTests_SaveColorModified_ColorSavedCorrectly)
  945. {
  946. AZ::Color setLayerColor(aznumeric_cast<uint8_t>(64), aznumeric_cast<uint8_t>(255), aznumeric_cast<uint8_t>(128), aznumeric_cast<uint8_t>(255));
  947. m_layerEntity.m_layer->SetLayerColor(setLayerColor);
  948. Layers::EditorLayer layer;
  949. Layers::LayerResult saveResult = SaveMainLayer(layer);
  950. EXPECT_TRUE(saveResult.IsSuccess());
  951. QColor getLayerColor(2, 4, 8);
  952. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  953. getLayerColor,
  954. m_layerEntity.m_entity->GetId(),
  955. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::GetLayerColor);
  956. EXPECT_EQ(getLayerColor.red(), 255);
  957. EXPECT_EQ(getLayerColor.green(), 255);
  958. EXPECT_EQ(getLayerColor.blue(), 255);
  959. EXPECT_EQ(layer.m_layerProperties.m_color.GetR8(), setLayerColor.GetR8());
  960. EXPECT_EQ(layer.m_layerProperties.m_color.GetG8(), setLayerColor.GetG8());
  961. EXPECT_EQ(layer.m_layerProperties.m_color.GetB8(), setLayerColor.GetB8());
  962. }
  963. TEST_F(EditorLayerComponentTest, LayerTests_ColorModifiedRestoreLayerAfterSave_ColorRestoresCorrectly)
  964. {
  965. AZ::Color setLayerColor(aznumeric_cast<uint8_t>(10), aznumeric_cast<uint8_t>(30), aznumeric_cast<uint8_t>(20), aznumeric_cast<uint8_t>(255));
  966. m_layerEntity.m_layer->SetLayerColor(setLayerColor);
  967. Layers::EditorLayer layer;
  968. Layers::LayerResult saveResult = SaveMainLayer(layer);
  969. EXPECT_TRUE(saveResult.IsSuccess());
  970. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  971. m_layerEntity.m_entity->GetId(),
  972. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  973. QColor getLayerColor(2, 4, 8);
  974. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  975. getLayerColor,
  976. m_layerEntity.m_entity->GetId(),
  977. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::GetLayerColor);
  978. EXPECT_EQ(getLayerColor.red(), setLayerColor.GetR8());
  979. EXPECT_EQ(getLayerColor.green(), setLayerColor.GetG8());
  980. EXPECT_EQ(getLayerColor.blue(), setLayerColor.GetB8());
  981. }
  982. TEST_F(EditorLayerComponentTest, LayerTests_SaveFormatModifiedRestoreLayerAfterSave_SaveFormatRestoresCorrectly)
  983. {
  984. // Set the save format to binary, as the default is xml.
  985. AzToolsFramework::Layers::LayerProperties::SaveFormat setSaveFormat = AzToolsFramework::Layers::LayerProperties::SaveFormat::Binary;
  986. m_layerEntity.m_layer->SetSaveFormat(setSaveFormat);
  987. Layers::EditorLayer layer;
  988. Layers::LayerResult saveResult = SaveMainLayer(layer);
  989. EXPECT_TRUE(saveResult.IsSuccess());
  990. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  991. m_layerEntity.m_entity->GetId(),
  992. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  993. // Check the save format is still binary after a restoring the layer.
  994. AzToolsFramework::Layers::LayerProperties::SaveFormat getSaveFormat = AzToolsFramework::Layers::LayerProperties::SaveFormat::Xml;
  995. bool saveFormatIsBinary = false;
  996. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  997. saveFormatIsBinary,
  998. m_layerEntity.m_entity->GetId(),
  999. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::IsSaveFormatBinary);
  1000. if (saveFormatIsBinary)
  1001. {
  1002. getSaveFormat = AzToolsFramework::Layers::LayerProperties::SaveFormat::Binary;
  1003. }
  1004. EXPECT_EQ(getSaveFormat, setSaveFormat);
  1005. // Now change the save format back to xml and redo the test.
  1006. setSaveFormat = AzToolsFramework::Layers::LayerProperties::SaveFormat::Xml;
  1007. m_layerEntity.m_layer->SetSaveFormat(setSaveFormat);
  1008. saveResult = SaveMainLayer(layer);
  1009. EXPECT_TRUE(saveResult.IsSuccess());
  1010. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1011. m_layerEntity.m_entity->GetId(),
  1012. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1013. getSaveFormat = AzToolsFramework::Layers::LayerProperties::SaveFormat::Xml;
  1014. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  1015. saveFormatIsBinary,
  1016. m_layerEntity.m_entity->GetId(),
  1017. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::IsSaveFormatBinary);
  1018. if (saveFormatIsBinary)
  1019. {
  1020. getSaveFormat = AzToolsFramework::Layers::LayerProperties::SaveFormat::Binary;
  1021. }
  1022. EXPECT_EQ(getSaveFormat, setSaveFormat);
  1023. }
  1024. TEST_F(EditorLayerComponentTest, LayerTests_SaveAndLoadColorModified_ColorLoadsCorrectly)
  1025. {
  1026. AZ::Color savedLayerColor(aznumeric_cast<uint8_t>(6), aznumeric_cast<uint8_t>(7), aznumeric_cast<uint8_t>(8), aznumeric_cast<uint8_t>(255));
  1027. m_layerEntity.m_layer->SetLayerColor(savedLayerColor);
  1028. Layers::EditorLayer layer;
  1029. AZStd::vector<char> entitySaveBuffer;
  1030. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1031. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream);
  1032. EXPECT_TRUE(saveResult.IsSuccess());
  1033. // After saving the layer, restore the editor data and set the color to something else.
  1034. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1035. m_layerEntity.m_entity->GetId(),
  1036. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1037. AZ::Color unsavedLayerColor(aznumeric_cast<uint8_t>(20), aznumeric_cast<uint8_t>(30), aznumeric_cast<uint8_t>(40), aznumeric_cast<uint8_t>(255));
  1038. m_layerEntity.m_layer->SetLayerColor(unsavedLayerColor);
  1039. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1040. AZ::SliceComponent::SliceAssetToSliceInstancePtrs sliceInstances;
  1041. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, sliceInstances, uniqueEntities);
  1042. EXPECT_TRUE(readResult.IsSuccess());
  1043. QColor getLayerColor(2, 4, 8);
  1044. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  1045. getLayerColor,
  1046. m_layerEntity.m_entity->GetId(),
  1047. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::GetLayerColor);
  1048. EXPECT_FLOAT_EQ(aznumeric_cast<float>(getLayerColor.redF()), savedLayerColor.GetR());
  1049. EXPECT_FLOAT_EQ(aznumeric_cast<float>(getLayerColor.greenF()), savedLayerColor.GetG());
  1050. EXPECT_FLOAT_EQ(aznumeric_cast<float>(getLayerColor.blueF()), savedLayerColor.GetB());
  1051. }
  1052. TEST_F(EditorLayerComponentTest, LayerTests_SaveLayerVisibilityModified_VisibilitySavesCorrectly)
  1053. {
  1054. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1055. m_layerEntity.m_entity->GetId(),
  1056. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  1057. false);
  1058. Layers::EditorLayer layer;
  1059. Layers::LayerResult saveResult = SaveMainLayer(layer);
  1060. EXPECT_TRUE(saveResult.IsSuccess());
  1061. bool visibilityAfterSave = false;
  1062. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  1063. visibilityAfterSave,
  1064. m_layerEntity.m_entity->GetId(),
  1065. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  1066. EXPECT_TRUE(visibilityAfterSave);
  1067. EXPECT_FALSE(layer.m_layerProperties.m_isLayerVisible);
  1068. }
  1069. TEST_F(EditorLayerComponentTest, LayerTests_RestoreLayerAfterSave_VisibilityRestoresCorrectly)
  1070. {
  1071. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1072. m_layerEntity.m_entity->GetId(),
  1073. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  1074. false);
  1075. AzToolsFramework::ToolsApplicationRequests::Bus::Broadcast(
  1076. &AzToolsFramework::ToolsApplicationRequests::Bus::Events::AddDirtyEntity,
  1077. m_layerEntity.m_entity->GetId());
  1078. Layers::EditorLayer layer;
  1079. Layers::LayerResult saveResult = SaveMainLayer(layer);
  1080. EXPECT_TRUE(saveResult.IsSuccess());
  1081. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1082. m_layerEntity.m_entity->GetId(),
  1083. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1084. bool visibilityAfterSave = true;
  1085. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  1086. visibilityAfterSave,
  1087. m_layerEntity.m_entity->GetId(),
  1088. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  1089. EXPECT_FALSE(visibilityAfterSave);
  1090. }
  1091. TEST_F(EditorLayerComponentTest, LayerTests_SaveAndLoadVisibilityModified_VisibilityLoadsCorrectly)
  1092. {
  1093. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1094. m_layerEntity.m_entity->GetId(),
  1095. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  1096. false);
  1097. Layers::EditorLayer layer;
  1098. AZStd::vector<char> entitySaveBuffer;
  1099. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1100. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream);
  1101. EXPECT_TRUE(saveResult.IsSuccess());
  1102. // After saving the layer, restore the editor data and set the visibility to true, the value that wasn't saved.
  1103. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1104. m_layerEntity.m_entity->GetId(),
  1105. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1106. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1107. m_layerEntity.m_entity->GetId(),
  1108. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetLayerChildrenVisibility,
  1109. true);
  1110. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1111. AZ::SliceComponent::SliceAssetToSliceInstancePtrs sliceInstances;
  1112. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, sliceInstances, uniqueEntities);
  1113. EXPECT_TRUE(readResult.IsSuccess());
  1114. bool visibilityAfterLoad = true;
  1115. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  1116. visibilityAfterLoad,
  1117. m_layerEntity.m_entity->GetId(),
  1118. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::AreLayerChildrenVisible);
  1119. EXPECT_FALSE(visibilityAfterLoad);
  1120. }
  1121. TEST_F(EditorLayerComponentTest, LayerTests_SaveLayerBinaryModified_BinarySavesCorrectly)
  1122. {
  1123. m_layerEntity.m_layer->SetSaveAsBinary(true);
  1124. Layers::EditorLayer layer;
  1125. Layers::LayerResult saveResult = SaveMainLayer(layer);
  1126. EXPECT_TRUE(saveResult.IsSuccess());
  1127. EXPECT_FALSE(m_layerEntity.m_layer->GetSaveAsBinary());
  1128. EXPECT_TRUE(layer.m_layerProperties.m_saveAsBinary);
  1129. }
  1130. TEST_F(EditorLayerComponentTest, LayerTests_RestoreLayerAfterSave_BinaryRestoresCorrectly)
  1131. {
  1132. m_layerEntity.m_layer->SetSaveAsBinary(true);
  1133. Layers::EditorLayer layer;
  1134. Layers::LayerResult saveResult = SaveMainLayer(layer);
  1135. EXPECT_TRUE(saveResult.IsSuccess());
  1136. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1137. m_layerEntity.m_entity->GetId(),
  1138. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1139. EXPECT_TRUE(m_layerEntity.m_layer->GetSaveAsBinary());
  1140. }
  1141. TEST_F(EditorLayerComponentTest, LayerTests_SaveAndLoadBinarySaveTypeModified_BinarySaveTypeLoadsCorrectly)
  1142. {
  1143. m_layerEntity.m_layer->SetSaveAsBinary(true);
  1144. Layers::EditorLayer layer;
  1145. AZStd::vector<char> entitySaveBuffer;
  1146. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1147. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream);
  1148. EXPECT_TRUE(saveResult.IsSuccess());
  1149. // After saving the layer, restore the editor data and set the save as binary to false, the value that wasn't saved.
  1150. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1151. m_layerEntity.m_entity->GetId(),
  1152. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1153. m_layerEntity.m_layer->SetSaveAsBinary(false);
  1154. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1155. AZ::SliceComponent::SliceAssetToSliceInstancePtrs sliceInstances;
  1156. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, sliceInstances, uniqueEntities);
  1157. EXPECT_TRUE(readResult.IsSuccess());
  1158. EXPECT_TRUE(m_layerEntity.m_layer->GetSaveAsBinary());
  1159. }
  1160. TEST_F(EditorLayerComponentTest, LayerTests_SaveAndLoadEntityInLayer_EntityLoadsCorrectly)
  1161. {
  1162. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1163. AZ::TransformBus::Event(
  1164. childEntity->GetId(),
  1165. &AZ::TransformBus::Events::SetParent,
  1166. m_layerEntity.m_entity->GetId());
  1167. Layers::EditorLayer layer;
  1168. AZStd::vector<char> entitySaveBuffer;
  1169. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1170. AZStd::vector<AZ::Entity*> savedEntities;
  1171. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1172. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1173. EXPECT_TRUE(saveResult.IsSuccess());
  1174. EXPECT_EQ(savedEntities.size(), 1);
  1175. EXPECT_NE(savedEntities[0], nullptr);
  1176. EXPECT_EQ(savedEntities[0]->GetId(), childEntity->GetId());
  1177. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1178. m_layerEntity.m_entity->GetId(),
  1179. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1180. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1181. AZ::SliceComponent::SliceAssetToSliceInstancePtrs loadedInstances;
  1182. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, loadedInstances, uniqueEntities);
  1183. EXPECT_TRUE(readResult.IsSuccess());
  1184. EXPECT_EQ(uniqueEntities.size(), 1);
  1185. EXPECT_NE(uniqueEntities.begin(), uniqueEntities.end());
  1186. EXPECT_EQ(uniqueEntities.begin()->first, childEntity->GetId());
  1187. EXPECT_NE(uniqueEntities.begin()->second, nullptr);
  1188. EXPECT_EQ(uniqueEntities.begin()->second->GetId(), childEntity->GetId());
  1189. }
  1190. TEST_F(EditorLayerComponentTest, LayerTests_RootSliceEntityEraseRestore_EntitiesRemovedAndRestoredCorrectly)
  1191. {
  1192. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1193. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1194. AZ::TransformBus::Event(
  1195. childEntity->GetId(),
  1196. &AZ::TransformBus::Events::SetParent,
  1197. m_layerEntity.m_entity->GetId());
  1198. Layers::EditorLayer layer;
  1199. AZStd::vector<char> entitySaveBuffer;
  1200. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1201. AZStd::vector<AZ::Entity*> savedEntities;
  1202. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1203. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1204. EXPECT_TRUE(saveResult.IsSuccess());
  1205. EXPECT_EQ(savedEntities.size(), 1);
  1206. EXPECT_NE(savedEntities[0], nullptr);
  1207. EXPECT_EQ(savedEntities[0]->GetId(), childEntity->GetId());
  1208. AZ::SliceComponent* rootSlice;
  1209. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1210. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1211. EXPECT_NE(rootSlice, nullptr);
  1212. // First, verify that childEntity is in the loose entity list.
  1213. // Size of 2 is the layer and the child entity.
  1214. EXPECT_TRUE(IsEntityInLooseEditorEntities(childEntity));
  1215. // After erasing the saved entities, verify childEntity is no longer a loose entity.
  1216. rootSlice->EraseEntities(savedEntities);
  1217. EXPECT_FALSE(IsEntityInLooseEditorEntities(childEntity));
  1218. rootSlice->ReplaceEntities(savedEntities);
  1219. EXPECT_TRUE(IsEntityInLooseEditorEntities(childEntity));
  1220. }
  1221. TEST_F(EditorLayerComponentTest, LayerTests_NestedLayersDoNotSaveLayersInLayers_LayersLoadCorrectly)
  1222. {
  1223. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1224. const AZStd::string childLayerName = "ChildLayerName";
  1225. EntityAndLayerComponent childLayer = CreateEntityWithLayer(childLayerName.c_str());
  1226. AZ::TransformBus::Event(
  1227. childLayer.m_entity->GetId(),
  1228. &AZ::TransformBus::Events::SetParent,
  1229. m_layerEntity.m_entity->GetId());
  1230. Layers::EditorLayer layer;
  1231. AZStd::vector<char> entitySaveBuffer;
  1232. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1233. AZStd::vector<AZ::Entity*> savedEntities;
  1234. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1235. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1236. EXPECT_TRUE(saveResult.IsSuccess());
  1237. EXPECT_EQ(savedEntities.size(), 0);
  1238. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1239. m_layerEntity.m_entity->GetId(),
  1240. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1241. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1242. AZ::SliceComponent::SliceAssetToSliceInstancePtrs loadedInstances;
  1243. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, loadedInstances, uniqueEntities);
  1244. EXPECT_TRUE(readResult.IsSuccess());
  1245. EXPECT_EQ(uniqueEntities.size(), 0);
  1246. }
  1247. // With a hierarchy of: LayerEntityName -> ChildLayer -> ChildEntity, when the parent and child layer are saved,
  1248. // then loaded, the ChildEntity should be saved in the ChildLayer and not the LayerEntityName, and the ChildLayer should not
  1249. // be saved to the LayerEntityName.
  1250. TEST_F(EditorLayerComponentTest, LayerTests_SaveAndLoadLayerLayerEntityHierarchy_LayersAndEntityLoadCorrectly)
  1251. {
  1252. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1253. const AZStd::string childLayerName = "ChildLayer";
  1254. EntityAndLayerComponent childLayerEntityAndComponent = CreateEntityWithLayer(childLayerName.c_str());
  1255. AZ::EntityId childLayerEntityId = childLayerEntityAndComponent.m_entity->GetId();
  1256. AZ::TransformBus::Event(
  1257. childLayerEntityId,
  1258. &AZ::TransformBus::Events::SetParent,
  1259. m_layerEntity.m_entity->GetId());
  1260. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1261. AZ::TransformBus::Event(
  1262. childEntity->GetId(),
  1263. &AZ::TransformBus::Events::SetParent,
  1264. childLayerEntityId);
  1265. Layers::EditorLayer layer;
  1266. AZStd::vector<char> entitySaveBuffer;
  1267. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1268. AZStd::vector<AZ::Entity*> savedEntities;
  1269. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1270. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1271. EXPECT_TRUE(saveResult.IsSuccess());
  1272. EXPECT_EQ(savedEntities.size(), 0);
  1273. Layers::EditorLayer childLayer;
  1274. AZStd::vector<char> childLayerEntitySaveBuffer;
  1275. AZ::IO::ByteContainerStream<AZStd::vector<char> > childLayerEntitySaveStream(&childLayerEntitySaveBuffer);
  1276. AZStd::vector<AZ::Entity*> childLayerSavedEntities;
  1277. AZ::SliceComponent::SliceReferenceToInstancePtrs childLayerSavedInstances;
  1278. Layers::LayerResult childSaveResult = childLayerEntityAndComponent.m_layer->PopulateLayerWriteToStreamAndGetEntities(
  1279. childLayerSavedEntities,
  1280. childLayerSavedInstances,
  1281. childLayerEntitySaveStream,
  1282. childLayer);
  1283. EXPECT_TRUE(childSaveResult.IsSuccess());
  1284. EXPECT_EQ(childLayerSavedEntities.size(), 1);
  1285. EXPECT_NE(childLayerSavedEntities[0], nullptr);
  1286. EXPECT_EQ(childLayerSavedEntities[0]->GetId(), childEntity->GetId());
  1287. // Restore the cached editor data for both the parent and child layers.
  1288. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1289. m_layerEntity.m_entity->GetId(),
  1290. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1291. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1292. childLayerEntityId,
  1293. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1294. // Verify that the outermost layer loads correctly and has no entities in it.
  1295. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1296. AZ::SliceComponent::SliceAssetToSliceInstancePtrs loadedInstances;
  1297. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, loadedInstances, uniqueEntities);
  1298. EXPECT_TRUE(readResult.IsSuccess());
  1299. EXPECT_EQ(uniqueEntities.size(), 0);
  1300. // Verify the inner layer loads correctly and has the entity in it we are looking for.
  1301. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueChildEntities;
  1302. AZ::SliceComponent::SliceAssetToSliceInstancePtrs loadedChildInstances;
  1303. Layers::LayerResult childReadResult =
  1304. childLayerEntityAndComponent.m_layer->ReadFromLayerStream(childLayerEntitySaveStream, loadedChildInstances, uniqueChildEntities);
  1305. EXPECT_TRUE(childReadResult.IsSuccess());
  1306. EXPECT_EQ(uniqueChildEntities.size(), 1);
  1307. EXPECT_NE(uniqueChildEntities.begin(), uniqueChildEntities.end());
  1308. EXPECT_EQ(uniqueChildEntities.begin()->first, childEntity->GetId());
  1309. EXPECT_NE(uniqueChildEntities.begin()->second, nullptr);
  1310. EXPECT_EQ(uniqueChildEntities.begin()->second->GetId(), childEntity->GetId());
  1311. childLayerEntityAndComponent.m_layer->CleanupLoadedLayer();
  1312. }
  1313. TEST_F(EditorLayerComponentTest, LayerTests_SliceInstanceAddedToLayer_LayerHasUnsavedChanges)
  1314. {
  1315. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1316. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = CreateSliceInstance();
  1317. AZ::Entity* childEntity = GetEntityFromSliceInstance(instantiatedSlice);
  1318. m_layerEntity.m_layer->ClearUnsavedChanges();
  1319. AZ::TransformBus::Event(
  1320. childEntity->GetId(),
  1321. &AZ::TransformBus::Events::SetParent,
  1322. m_layerEntity.m_entity->GetId());
  1323. bool hasUnsavedChanges = false;
  1324. AzToolsFramework::Layers::EditorLayerComponentRequestBus::EventResult(
  1325. hasUnsavedChanges,
  1326. m_layerEntity.m_entity->GetId(),
  1327. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::HasUnsavedChanges);
  1328. EXPECT_TRUE(hasUnsavedChanges);
  1329. DeleteSliceInstance(instantiatedSlice);
  1330. }
  1331. TEST_F(EditorLayerComponentTest, LayerTests_SaveAndLoadInstanceInLayer_InstanceLoadsCorrectly)
  1332. {
  1333. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1334. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = CreateSliceInstance();
  1335. AZ::Entity* childEntity = GetEntityFromSliceInstance(instantiatedSlice);
  1336. AZ::TransformBus::Event(
  1337. childEntity->GetId(),
  1338. &AZ::TransformBus::Events::SetParent,
  1339. m_layerEntity.m_entity->GetId());
  1340. Layers::EditorLayer layer;
  1341. AZStd::vector<char> entitySaveBuffer;
  1342. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1343. AZStd::vector<AZ::Entity*> savedEntities;
  1344. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1345. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1346. EXPECT_TRUE(saveResult.IsSuccess());
  1347. EXPECT_EQ(savedEntities.size(), 0);
  1348. EXPECT_EQ(savedInstances.size(), 1);
  1349. AZ::SliceComponent::SliceReferenceToInstancePtrs::iterator refToInstanceIterator =
  1350. savedInstances.find(instantiatedSlice.GetReference());
  1351. EXPECT_NE(refToInstanceIterator, savedInstances.end());
  1352. EXPECT_NE(refToInstanceIterator->second.find(instantiatedSlice.GetInstance()), refToInstanceIterator->second.end());
  1353. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1354. m_layerEntity.m_entity->GetId(),
  1355. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1356. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1357. AZ::SliceComponent::SliceAssetToSliceInstancePtrs loadedInstances;
  1358. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, loadedInstances, uniqueEntities);
  1359. EXPECT_TRUE(readResult.IsSuccess());
  1360. EXPECT_EQ(uniqueEntities.size(), 0);
  1361. EXPECT_EQ(loadedInstances.size(), 1);
  1362. EXPECT_NE(loadedInstances.find(instantiatedSlice.GetReference()->GetSliceAsset()), loadedInstances.end());
  1363. DeleteSliceInstance(instantiatedSlice);
  1364. }
  1365. // Temporarily disabled until fix provided in mainline - instantiatedSlice is no longer valid to access after RemoveAndCacheInstances
  1366. /*
  1367. TEST_F(EditorLayerComponentTest, LayerTests_SliceInstanceOnlyInLayerRootSliceRemoveRestore_InstanceRemovedAndRestoredCorrectly)
  1368. {
  1369. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = CreateSliceInstance();
  1370. AZ::Entity* childEntity = GetEntityFromSliceInstance(instantiatedSlice);
  1371. AZ::TransformBus::Event(
  1372. childEntity->GetId(),
  1373. &AZ::TransformBus::Events::SetParent,
  1374. m_layerEntity.m_entity->GetId());
  1375. Layers::EditorLayer layer;
  1376. AZStd::vector<char> entitySaveBuffer;
  1377. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1378. AZStd::vector<AZ::Entity*> savedEntities;
  1379. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1380. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1381. EXPECT_TRUE(saveResult.IsSuccess());
  1382. EXPECT_EQ(savedEntities.size(), 0);
  1383. EXPECT_EQ(savedInstances.size(), 1);
  1384. AZ::SliceComponent::SliceReferenceToInstancePtrs::iterator refToInstanceIterator =
  1385. savedInstances.find(instantiatedSlice.GetReference());
  1386. EXPECT_NE(refToInstanceIterator, savedInstances.end());
  1387. EXPECT_NE(refToInstanceIterator->second.find(instantiatedSlice.GetInstance()), refToInstanceIterator->second.end());
  1388. AZ::SliceComponent* rootSlice;
  1389. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1390. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1391. EXPECT_NE(rootSlice, nullptr);
  1392. // First, verify the the instance is in the root slice.
  1393. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1394. // After removing the instances, verify the instance and reference is no longer in the root slice.
  1395. rootSlice->RemoveAndCacheInstances(savedInstances);
  1396. EXPECT_FALSE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1397. rootSlice->RestoreCachedInstances();
  1398. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1399. DeleteSliceInstance(instantiatedSlice);
  1400. }
  1401. // Tests that the slice reference remains in the root scene if there is an instance of the slice in the layer and in the root scene.
  1402. TEST_F(EditorLayerComponentTest, LayerTests_MultipleSliceInstanceInLayerRootSliceRemoveRestore_InstanceRemovedAndRestoredCorrectly)
  1403. {
  1404. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = CreateSliceInstance();
  1405. // Put the first instance in the layer
  1406. AZ::Entity* childEntity = GetEntityFromSliceInstance(instantiatedSlice);
  1407. AZ::TransformBus::Event(
  1408. childEntity->GetId(),
  1409. &AZ::TransformBus::Events::SetParent,
  1410. m_layerEntity.m_entity->GetId());
  1411. AZ::SliceComponent* rootSlice;
  1412. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1413. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1414. EXPECT_NE(rootSlice, nullptr);
  1415. // Create a second slice instance that is not in the layer.
  1416. AZ::SliceComponent::SliceInstanceAddress secondSliceInstance = CreateSliceInstanceFromSlice(
  1417. rootSlice,
  1418. instantiatedSlice.GetReference()->GetSliceAsset());
  1419. Layers::EditorLayer layer;
  1420. AZStd::vector<char> entitySaveBuffer;
  1421. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1422. AZStd::vector<AZ::Entity*> savedEntities;
  1423. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1424. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1425. EXPECT_TRUE(saveResult.IsSuccess());
  1426. EXPECT_EQ(savedEntities.size(), 0);
  1427. EXPECT_EQ(savedInstances.size(), 1);
  1428. AZ::SliceComponent::SliceReferenceToInstancePtrs::iterator refToInstanceIterator =
  1429. savedInstances.find(instantiatedSlice.GetReference());
  1430. EXPECT_NE(refToInstanceIterator, savedInstances.end());
  1431. EXPECT_NE(refToInstanceIterator->second.find(instantiatedSlice.GetInstance()), refToInstanceIterator->second.end());
  1432. // Make sure the second slice instance is not saved.
  1433. EXPECT_EQ(refToInstanceIterator->second.find(secondSliceInstance.GetInstance()), refToInstanceIterator->second.end());
  1434. // First, verify the the instances are in the root slice.
  1435. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1436. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, secondSliceInstance));
  1437. // After removing the instances, verify the first instance is no longer in the root slice, but the reference and second instance are.
  1438. rootSlice->RemoveAndCacheInstances(savedInstances);
  1439. EXPECT_FALSE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1440. AZ::SliceComponent::SliceReference* sliceReference = rootSlice->GetSlice(instantiatedSlice.GetReference()->GetSliceAsset());
  1441. EXPECT_NE(sliceReference, nullptr);
  1442. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, secondSliceInstance));
  1443. rootSlice->RestoreCachedInstances();
  1444. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1445. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, secondSliceInstance));
  1446. DeleteSliceInstance(instantiatedSlice);
  1447. DeleteSliceInstance(secondSliceInstance);
  1448. }
  1449. */
  1450. TEST_F(EditorLayerComponentTest, LayerTests_DuplicateEntitiesInSceneAndLayer_DuplicateEntityIsDeleted)
  1451. {
  1452. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1453. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1454. AZ::TransformBus::Event(
  1455. childEntity->GetId(),
  1456. &AZ::TransformBus::Events::SetParent,
  1457. m_layerEntity.m_entity->GetId());
  1458. Layers::EditorLayer layer;
  1459. AZStd::vector<char> entitySaveBuffer;
  1460. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1461. AZStd::vector<AZ::Entity*> savedEntities;
  1462. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1463. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1464. EXPECT_TRUE(saveResult.IsSuccess());
  1465. EXPECT_EQ(savedEntities.size(), 1);
  1466. EXPECT_NE(savedEntities[0], nullptr);
  1467. EXPECT_EQ(savedEntities[0]->GetId(), childEntity->GetId());
  1468. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1469. m_layerEntity.m_entity->GetId(),
  1470. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1471. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1472. // ReadFromLayerStream will delete the older entities, so create an entity here that can be safely deleted.
  1473. AZ::Entity* duplicateToBeDeletedEntity = aznew AZ::Entity(childEntity->GetId(), "GoingToBeDeleted");
  1474. uniqueEntities[childEntity->GetId()] = duplicateToBeDeletedEntity;
  1475. AZ::SliceComponent::SliceAssetToSliceInstancePtrs loadedInstances;
  1476. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, loadedInstances, uniqueEntities);
  1477. EXPECT_TRUE(readResult.IsSuccess());
  1478. EXPECT_EQ(uniqueEntities.size(), 1);
  1479. EXPECT_NE(uniqueEntities.begin(), uniqueEntities.end());
  1480. EXPECT_EQ(uniqueEntities.begin()->first, childEntity->GetId());
  1481. EXPECT_NE(uniqueEntities.begin()->second, nullptr);
  1482. EXPECT_EQ(uniqueEntities.begin()->second->GetId(), childEntity->GetId());
  1483. EXPECT_NE(uniqueEntities.begin()->second, duplicateToBeDeletedEntity);
  1484. }
  1485. TEST_F(EditorLayerComponentTest, LayerTests_DuplicateEntitiesInLayer_DuplicateEntityIsDeleted)
  1486. {
  1487. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1488. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1489. AZ::TransformBus::Event(
  1490. childEntity->GetId(),
  1491. &AZ::TransformBus::Events::SetParent,
  1492. m_layerEntity.m_entity->GetId());
  1493. Layers::EditorLayer layer;
  1494. AZStd::vector<char> entitySaveBuffer;
  1495. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1496. AZStd::vector<AZ::Entity*> savedEntities;
  1497. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1498. Layers::LayerResult saveResult =
  1499. m_layerEntity.m_layer->CreateLayerStreamWithDuplicateEntity(
  1500. savedEntities,
  1501. savedInstances,
  1502. entitySaveStream,
  1503. layer);
  1504. EXPECT_TRUE(saveResult.IsSuccess());
  1505. EXPECT_EQ(savedEntities.size(), 1);
  1506. EXPECT_NE(savedEntities[0], nullptr);
  1507. EXPECT_EQ(savedEntities[0]->GetId(), childEntity->GetId());
  1508. EXPECT_EQ(layer.m_layerEntities.size(), 2);
  1509. // Make sure the saved data has a duplicate entity in it.
  1510. EXPECT_EQ(layer.m_layerEntities[0]->GetId(), layer.m_layerEntities[1]->GetId());
  1511. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1512. m_layerEntity.m_entity->GetId(),
  1513. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::RestoreEditorData);
  1514. AZStd::unordered_map<AZ::EntityId, AZ::Entity*> uniqueEntities;
  1515. AZ::SliceComponent::SliceAssetToSliceInstancePtrs loadedInstances;
  1516. Layers::LayerResult readResult = m_layerEntity.m_layer->ReadFromLayerStream(entitySaveStream, loadedInstances, uniqueEntities);
  1517. EXPECT_TRUE(readResult.IsSuccess());
  1518. // Verify there is only one entity loaded from the layer.
  1519. EXPECT_EQ(uniqueEntities.size(), 1);
  1520. EXPECT_NE(uniqueEntities.begin(), uniqueEntities.end());
  1521. EXPECT_EQ(uniqueEntities.begin()->first, childEntity->GetId());
  1522. EXPECT_NE(uniqueEntities.begin()->second, nullptr);
  1523. EXPECT_EQ(uniqueEntities.begin()->second->GetId(), childEntity->GetId());
  1524. }
  1525. TEST_F(EditorLayerComponentTest, LayerTests_RestoreNullLayer_FailsToRestore)
  1526. {
  1527. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1528. AZ::EntityId invalidParentId;
  1529. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(nullptr, "RecoveredLayerName", invalidParentId);
  1530. EXPECT_FALSE(recoveryResult.IsSuccess());
  1531. }
  1532. TEST_F(EditorLayerComponentTest, LayerTests_RestoreEmptyLayer_RestoresCorrectly)
  1533. {
  1534. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1535. AZ::EntityId layerEntityId = m_layerEntity.m_entity->GetId();
  1536. // Check that the layer is in the scene.
  1537. AZ::SliceComponent* rootSlice;
  1538. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1539. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1540. EXPECT_NE(rootSlice, nullptr);
  1541. const EntityList& looseEntities(rootSlice->GetNewEntities());
  1542. EXPECT_EQ(looseEntities.size(), 1);
  1543. EXPECT_EQ(looseEntities[0]->GetId(), layerEntityId);
  1544. // Next, save that layer to a stream.
  1545. AZStd::vector<char> entitySaveBuffer;
  1546. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1547. AZStd::vector<AZ::Entity*> savedEntities;
  1548. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1549. Layers::EditorLayer layer;
  1550. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1551. EXPECT_TRUE(saveResult.IsSuccess());
  1552. // Delete the layer from the scene.
  1553. bool layerDeleted = false;
  1554. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1555. layerDeleted,
  1556. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1557. m_layerEntity.m_entity->GetId());
  1558. EXPECT_TRUE(layerDeleted);
  1559. m_layerEntity.m_entity = nullptr;
  1560. // Verify that the layer is gone.
  1561. EXPECT_EQ(looseEntities.size(), 0);
  1562. // Load the layer object from the stream it was saved to.
  1563. AZStd::shared_ptr<Layers::EditorLayer> loadedFromStream(AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(entitySaveStream));
  1564. EXPECT_NE(loadedFromStream, nullptr);
  1565. // Attempt to recover the empty layer, which should succeed.
  1566. AZ::EntityId invalidParentId;
  1567. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(loadedFromStream, "RecoveredLayerName", invalidParentId);
  1568. EXPECT_TRUE(recoveryResult.IsSuccess());
  1569. // Verify the layer was restored.
  1570. EXPECT_EQ(looseEntities.size(), 1);
  1571. EXPECT_EQ(looseEntities[0]->GetId(), layerEntityId);
  1572. }
  1573. TEST_F(EditorLayerComponentTest, LayerTests_RestoreLayerButLayerStillInScene_FailsToRestore)
  1574. {
  1575. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1576. AZ::EntityId layerEntityId = m_layerEntity.m_entity->GetId();
  1577. // Check that the layer is in the scene.
  1578. AZ::SliceComponent* rootSlice;
  1579. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1580. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1581. EXPECT_NE(rootSlice, nullptr);
  1582. const EntityList& looseEntities(rootSlice->GetNewEntities());
  1583. EXPECT_EQ(looseEntities.size(), 1);
  1584. EXPECT_EQ(looseEntities[0]->GetId(), layerEntityId);
  1585. AzToolsFramework::ToolsApplicationRequests::Bus::Broadcast(
  1586. &AzToolsFramework::ToolsApplicationRequests::Bus::Events::AddDirtyEntity,
  1587. layerEntityId);
  1588. // Next, save that layer to a stream.
  1589. AZStd::vector<char> entitySaveBuffer;
  1590. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1591. AZStd::vector<AZ::Entity*> savedEntities;
  1592. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1593. Layers::EditorLayer layer;
  1594. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1595. EXPECT_TRUE(saveResult.IsSuccess());
  1596. // Load the layer object from the stream it was saved to.
  1597. AZStd::shared_ptr<Layers::EditorLayer> loadedFromStream(AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(entitySaveStream));
  1598. EXPECT_NE(loadedFromStream, nullptr);
  1599. // Attempt to recover the layer, which should fail because it's still in the scene.
  1600. AZ::EntityId invalidParentId;
  1601. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(loadedFromStream, "RecoveredLayerName", invalidParentId);
  1602. EXPECT_FALSE(recoveryResult.IsSuccess());
  1603. }
  1604. TEST_F(EditorLayerComponentTest, LayerTests_RestoreLayerWithEntityChild_RestoresCorrectly)
  1605. {
  1606. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1607. const AZ::EntityId layerEntityId = m_layerEntity.m_entity->GetId();
  1608. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1609. const AZ::EntityId childEntityId = childEntity->GetId();
  1610. AZ::TransformBus::Event(
  1611. childEntityId,
  1612. &AZ::TransformBus::Events::SetParent,
  1613. layerEntityId);
  1614. // Check that the layer and the child entity are in the scene.
  1615. AZ::SliceComponent* rootSlice;
  1616. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1617. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1618. EXPECT_NE(rootSlice, nullptr);
  1619. const EntityList& looseEntities(rootSlice->GetNewEntities());
  1620. EXPECT_EQ(looseEntities.size(), 2);
  1621. bool foundLayer = false;
  1622. bool foundChild = false;
  1623. for (const auto& entity : looseEntities)
  1624. {
  1625. if (entity->GetId() == layerEntityId)
  1626. {
  1627. foundLayer = true;
  1628. }
  1629. else if (entity->GetId() == childEntityId)
  1630. {
  1631. foundChild = true;
  1632. }
  1633. }
  1634. EXPECT_TRUE(foundLayer);
  1635. EXPECT_TRUE(foundChild);
  1636. // Next, save that layer to a stream.
  1637. AZStd::vector<char> entitySaveBuffer;
  1638. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1639. AZStd::vector<AZ::Entity*> savedEntities;
  1640. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1641. Layers::EditorLayer layer;
  1642. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1643. EXPECT_TRUE(saveResult.IsSuccess());
  1644. // Delete the child from the scene.
  1645. bool childDeleted = false;
  1646. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1647. childDeleted,
  1648. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1649. childEntityId);
  1650. EXPECT_TRUE(childDeleted);
  1651. childEntity = nullptr;
  1652. // Delete the layer from the scene.
  1653. bool layerDeleted = false;
  1654. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1655. layerDeleted,
  1656. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1657. layerEntityId);
  1658. EXPECT_TRUE(layerDeleted);
  1659. m_layerEntity.m_entity = nullptr;
  1660. // Verify that the layer is gone.
  1661. EXPECT_EQ(looseEntities.size(), 0);
  1662. // Load the layer object from the stream it was saved to.
  1663. AZStd::shared_ptr<Layers::EditorLayer> loadedFromStream(AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(entitySaveStream));
  1664. EXPECT_NE(loadedFromStream, nullptr);
  1665. // Recover the layer.
  1666. AZ::EntityId invalidParentId;
  1667. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(loadedFromStream, "RecoveredLayerName", invalidParentId);
  1668. EXPECT_TRUE(recoveryResult.IsSuccess());
  1669. // Verify the layer and child were restored.
  1670. EXPECT_EQ(looseEntities.size(), 2);
  1671. foundLayer = false;
  1672. foundChild = false;
  1673. for (const auto& entity : looseEntities)
  1674. {
  1675. if (entity->GetId() == layerEntityId)
  1676. {
  1677. foundLayer = true;
  1678. }
  1679. else if (entity->GetId() == childEntityId)
  1680. {
  1681. foundChild = true;
  1682. }
  1683. }
  1684. EXPECT_TRUE(foundLayer);
  1685. EXPECT_TRUE(foundChild);
  1686. }
  1687. TEST_F(EditorLayerComponentTest, LayerTests_RestoreLayerWithEntityChildStillInScene_FailsToRestore)
  1688. {
  1689. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1690. const AZ::EntityId layerEntityId = m_layerEntity.m_entity->GetId();
  1691. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1692. const AZ::EntityId childEntityId = childEntity->GetId();
  1693. AZ::TransformBus::Event(
  1694. childEntityId,
  1695. &AZ::TransformBus::Events::SetParent,
  1696. layerEntityId);
  1697. // Check that the layer and the child entity are in the scene.
  1698. AZ::SliceComponent* rootSlice;
  1699. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1700. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1701. EXPECT_NE(rootSlice, nullptr);
  1702. const EntityList& looseEntities(rootSlice->GetNewEntities());
  1703. EXPECT_EQ(looseEntities.size(), 2);
  1704. bool foundLayer = false;
  1705. bool foundChild = false;
  1706. for (const auto& entity : looseEntities)
  1707. {
  1708. if (entity->GetId() == layerEntityId)
  1709. {
  1710. foundLayer = true;
  1711. }
  1712. else if (entity->GetId() == childEntityId)
  1713. {
  1714. foundChild = true;
  1715. }
  1716. }
  1717. EXPECT_TRUE(foundLayer);
  1718. EXPECT_TRUE(foundChild);
  1719. // Next, save that layer to a stream.
  1720. AZStd::vector<char> entitySaveBuffer;
  1721. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1722. AZStd::vector<AZ::Entity*> savedEntities;
  1723. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1724. Layers::EditorLayer layer;
  1725. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1726. EXPECT_TRUE(saveResult.IsSuccess());
  1727. // Set the child's parent to invalid, so it sticks around after the layer is deleted
  1728. AZ::TransformBus::Event(
  1729. childEntityId,
  1730. &AZ::TransformBus::Events::SetParent,
  1731. AZ::EntityId());
  1732. // Delete the layer from the scene.
  1733. bool layerDeleted = false;
  1734. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1735. layerDeleted,
  1736. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1737. layerEntityId);
  1738. EXPECT_TRUE(layerDeleted);
  1739. m_layerEntity.m_entity = nullptr;
  1740. // Verify that the layer is gone, but the child is still in the scene.
  1741. EXPECT_EQ(looseEntities.size(), 1);
  1742. EXPECT_EQ(looseEntities[0]->GetId(), childEntityId);
  1743. // Load the layer object from the stream it was saved to.
  1744. AZStd::shared_ptr<Layers::EditorLayer> loadedFromStream(AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(entitySaveStream));
  1745. EXPECT_NE(loadedFromStream, nullptr);
  1746. // Attempt to recover the layer, which should fail because the child is still in the scene.
  1747. AZ::EntityId invalidParentId;
  1748. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(loadedFromStream, "RecoveredLayerName", invalidParentId);
  1749. EXPECT_FALSE(recoveryResult.IsSuccess());
  1750. // Verify the layer was not restored.
  1751. EXPECT_EQ(looseEntities.size(), 1);
  1752. EXPECT_EQ(looseEntities[0]->GetId(), childEntityId);
  1753. }
  1754. TEST_F(EditorLayerComponentTest, LayerTests_RestoreLayerWithSliceInstance_RestoresCorrectly)
  1755. {
  1756. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1757. const AZ::EntityId layerEntityId = m_layerEntity.m_entity->GetId();
  1758. // First, set up a layer with a slice instance in it.
  1759. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = CreateSliceInstance();
  1760. AZ::Data::Asset<AZ::SliceAsset> loadedSliceAsset = instantiatedSlice.first->GetSliceAsset();
  1761. AZ::Entity* childEntity = GetEntityFromSliceInstance(instantiatedSlice);
  1762. AZ::TransformBus::Event(
  1763. childEntity->GetId(),
  1764. &AZ::TransformBus::Events::SetParent,
  1765. layerEntityId);
  1766. // Check that the layer is in the scene.
  1767. AZ::SliceComponent* rootSlice;
  1768. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1769. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1770. EXPECT_NE(rootSlice, nullptr);
  1771. const EntityList& looseEntities(rootSlice->GetNewEntities());
  1772. EXPECT_EQ(looseEntities.size(), 1);
  1773. EXPECT_EQ(looseEntities[0]->GetId(), layerEntityId);
  1774. // Next, save that layer to a stream.
  1775. AZStd::vector<char> entitySaveBuffer;
  1776. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1777. AZStd::vector<AZ::Entity*> savedEntities;
  1778. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1779. Layers::EditorLayer layer;
  1780. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1781. EXPECT_TRUE(saveResult.IsSuccess());
  1782. // Clear out the scene, delete the instance and the layer.
  1783. DeleteSliceInstance(instantiatedSlice);
  1784. bool layerDeleted = false;
  1785. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1786. layerDeleted,
  1787. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1788. layerEntityId);
  1789. EXPECT_TRUE(layerDeleted);
  1790. m_layerEntity.m_entity = nullptr;
  1791. // Verify the slice instance and layer have been removed from the scene.
  1792. AZStd::list<AZ::SliceComponent::SliceReference>& sliceList = rootSlice->GetSlices();
  1793. EXPECT_EQ(sliceList.size(), 0);
  1794. // Verify the layer is gone.
  1795. EXPECT_EQ(looseEntities.size(), 0);
  1796. // Load the layer object from the stream it was saved to.
  1797. AZStd::shared_ptr<Layers::EditorLayer> loadedFromStream(AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(entitySaveStream));
  1798. EXPECT_NE(loadedFromStream, nullptr);
  1799. // Recover the layer. It has no parent, so use an invalid ID.
  1800. AZ::EntityId invalidParentId;
  1801. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(loadedFromStream, "RecoveredLayerName", invalidParentId);
  1802. EXPECT_TRUE(recoveryResult.IsSuccess());
  1803. // Verify the slice instance is now in the scene.
  1804. EXPECT_EQ(sliceList.size(), 1);
  1805. EXPECT_EQ(sliceList.front().GetSliceAsset(), loadedSliceAsset);
  1806. AZStd::unordered_set<AZ::SliceComponent::SliceInstance>& sliceInstances = sliceList.front().GetInstances();
  1807. EXPECT_EQ(sliceInstances.size(), 1);
  1808. // Verify the layer is now in the scene.
  1809. EXPECT_EQ(looseEntities.size(), 1);
  1810. EXPECT_EQ(looseEntities[0]->GetId(), layerEntityId);
  1811. // Clean up the slice instance.
  1812. // There's only one instance, so no need to loop to clear it out.
  1813. // Convert the instance from an iterator to a pointer, to remove it.
  1814. rootSlice->RemoveSliceInstance(&(*sliceInstances.begin()));
  1815. }
  1816. TEST_F(EditorLayerComponentTest, LayerTests_RestoreLayerWithSliceInstanceStillInScene_FailsToRestore)
  1817. {
  1818. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1819. const AZ::EntityId layerEntityId = m_layerEntity.m_entity->GetId();
  1820. // First, set up a layer with a slice instance in it.
  1821. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = CreateSliceInstance();
  1822. AZ::Data::Asset<AZ::SliceAsset> loadedSliceAsset = instantiatedSlice.first->GetSliceAsset();
  1823. AZ::Entity* childEntity = GetEntityFromSliceInstance(instantiatedSlice);
  1824. AZ::TransformBus::Event(
  1825. childEntity->GetId(),
  1826. &AZ::TransformBus::Events::SetParent,
  1827. layerEntityId);
  1828. // Check that the layer is in the scene.
  1829. AZ::SliceComponent* rootSlice;
  1830. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1831. rootSlice, &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1832. EXPECT_NE(rootSlice, nullptr);
  1833. const EntityList& looseEntities(rootSlice->GetNewEntities());
  1834. EXPECT_EQ(looseEntities.size(), 1);
  1835. EXPECT_EQ(looseEntities[0]->GetId(), layerEntityId);
  1836. // Next, save that layer to a stream.
  1837. AZStd::vector<char> entitySaveBuffer;
  1838. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1839. AZStd::vector<AZ::Entity*> savedEntities;
  1840. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1841. Layers::EditorLayer layer;
  1842. Layers::LayerResult saveResult = SaveMainLayer(layer, entitySaveStream, savedEntities, savedInstances);
  1843. EXPECT_TRUE(saveResult.IsSuccess());
  1844. // Move the slice instance out of the layer, so the entity ID remains active and conflicts with the layer.
  1845. AZ::TransformBus::Event(
  1846. childEntity->GetId(),
  1847. &AZ::TransformBus::Events::SetParent,
  1848. AZ::EntityId());
  1849. bool layerDeleted = false;
  1850. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1851. layerDeleted,
  1852. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1853. layerEntityId);
  1854. EXPECT_TRUE(layerDeleted);
  1855. m_layerEntity.m_entity = nullptr;
  1856. // Verify the layer is gone.
  1857. EXPECT_EQ(looseEntities.size(), 0);
  1858. // Load the layer object from the stream it was saved to.
  1859. AZStd::shared_ptr<Layers::EditorLayer> loadedFromStream(AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(entitySaveStream));
  1860. EXPECT_NE(loadedFromStream, nullptr);
  1861. // Attempt to recover the layer. It has no parent, so use an invalid ID.
  1862. AZ::EntityId invalidParentId;
  1863. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(loadedFromStream, "RecoveredLayerName", invalidParentId);
  1864. // Verify it failed to recover.
  1865. EXPECT_FALSE(recoveryResult.IsSuccess());
  1866. // Verify the slice instance is now in the scene.
  1867. AZStd::list<AZ::SliceComponent::SliceReference>& sliceList = rootSlice->GetSlices();
  1868. EXPECT_EQ(sliceList.size(), 1);
  1869. EXPECT_EQ(sliceList.front().GetSliceAsset(), loadedSliceAsset);
  1870. AZStd::unordered_set<AZ::SliceComponent::SliceInstance>& sliceInstances = sliceList.front().GetInstances();
  1871. EXPECT_EQ(sliceInstances.size(), 1);
  1872. // Verify the layer is not in the scene. If it failed, it shouldn't create the layer.
  1873. EXPECT_EQ(looseEntities.size(), 0);
  1874. // Clean up the slice instance.
  1875. DeleteSliceInstance(instantiatedSlice);
  1876. }
  1877. TEST_F(EditorLayerComponentTest, LayerTests_AttemptToCopyLayerComponent_IsNotCopyable)
  1878. {
  1879. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1880. AZ::Entity::ComponentArrayType components;
  1881. components.push_back(m_layerEntity.m_layer);
  1882. bool isCopyable = EntityPropertyEditor::AreComponentsCopyable(components, DummyComponentFilter);
  1883. EXPECT_FALSE(isCopyable);
  1884. }
  1885. TEST_F(EditorLayerComponentTest, LayerTests_CheckOverwriteFlag_IsSetCorrectly)
  1886. {
  1887. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1888. // Check layer created with correct value
  1889. EXPECT_FALSE(m_layerEntity.m_layer->GetOverwriteFlag());
  1890. //check direct call works correctly
  1891. m_layerEntity.m_layer->SetOverwriteFlag(true);
  1892. EXPECT_TRUE(m_layerEntity.m_layer->GetOverwriteFlag());
  1893. // check bus works correctly
  1894. AzToolsFramework::Layers::EditorLayerComponentRequestBus::Event(
  1895. m_layerEntity.m_entity->GetId(),
  1896. &AzToolsFramework::Layers::EditorLayerComponentRequestBus::Events::SetOverwriteFlag, true);
  1897. EXPECT_TRUE(m_layerEntity.m_layer->GetOverwriteFlag());
  1898. }
  1899. TEST_F(EditorLayerComponentTest, LayerTests_UndoRedoRestoreLayerWithChildren_AllRestoredEntitiesCorrect)
  1900. {
  1901. AUTO_RESULT_IF_SETTING_TRUE(UnitTest::prefabSystemSetting, true)
  1902. const AZ::EntityId layerEntityId = m_layerEntity.m_entity->GetId();
  1903. AZ::SliceComponent* rootSlice;
  1904. AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::BroadcastResult(
  1905. rootSlice,
  1906. &AzToolsFramework::SliceEditorEntityOwnershipServiceRequestBus::Events::GetEditorRootSlice);
  1907. EXPECT_NE(rootSlice, nullptr);
  1908. // Set up a an entity and a slice instance as children of the layer.
  1909. AZ::Entity* childEntity = CreateEditorReadyEntity("ChildEntity");
  1910. const AZ::EntityId childEntityId = childEntity->GetId();
  1911. AZ::TransformBus::Event(
  1912. childEntityId,
  1913. &AZ::TransformBus::Events::SetParent,
  1914. layerEntityId);
  1915. AZ::SliceComponent::SliceInstanceAddress instantiatedSlice = CreateSliceInstance();
  1916. AZ::Data::Asset<AZ::SliceAsset> loadedSliceAsset = instantiatedSlice.first->GetSliceAsset();
  1917. AZ::Entity* sliceEntity = GetEntityFromSliceInstance(instantiatedSlice);
  1918. const AZ::EntityId sliceEntityId = sliceEntity->GetId();
  1919. AZ::TransformBus::Event(
  1920. sliceEntityId,
  1921. &AZ::TransformBus::Events::SetParent,
  1922. layerEntityId);
  1923. const EntityList& looseEntities(rootSlice->GetNewEntities());
  1924. EXPECT_EQ(looseEntities.size(), 2);
  1925. // Check that the layers, the entity, and the slice are in the scene.
  1926. EXPECT_TRUE(IsLooseEntityInRootSlice(rootSlice, layerEntityId));
  1927. EXPECT_TRUE(IsLooseEntityInRootSlice(rootSlice, childEntityId));
  1928. EXPECT_TRUE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1929. // Next, save the layer to a stream.
  1930. AZStd::vector<char> entitySaveBuffer;
  1931. AZ::IO::ByteContainerStream<AZStd::vector<char> > entitySaveStream(&entitySaveBuffer);
  1932. AZStd::vector<AZ::Entity*> savedEntities;
  1933. AZ::SliceComponent::SliceReferenceToInstancePtrs savedInstances;
  1934. Layers::EditorLayer layer;
  1935. Layers::LayerResult saveResult = m_layerEntity.m_layer->PopulateLayerWriteToStreamAndGetEntities(
  1936. savedEntities,
  1937. savedInstances,
  1938. entitySaveStream,
  1939. layer);
  1940. EXPECT_TRUE(saveResult.IsSuccess());
  1941. // Delete all the objects.
  1942. bool entityDeleted = false;
  1943. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1944. entityDeleted,
  1945. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1946. childEntityId);
  1947. EXPECT_TRUE(entityDeleted);
  1948. childEntity = nullptr;
  1949. DeleteSliceInstance(instantiatedSlice);
  1950. AzToolsFramework::EditorEntityContextRequestBus::BroadcastResult(
  1951. entityDeleted,
  1952. &AzToolsFramework::EditorEntityContextRequestBus::Events::DestroyEditorEntity,
  1953. layerEntityId);
  1954. EXPECT_TRUE(entityDeleted);
  1955. m_layerEntity.m_entity = nullptr;
  1956. // Check that everything is gone.
  1957. EXPECT_EQ(looseEntities.size(), 0);
  1958. EXPECT_FALSE(IsInstanceAndReferenceInRootSlice(rootSlice, instantiatedSlice));
  1959. // Load the layer object from the stream it was saved to.
  1960. AZStd::shared_ptr<Layers::EditorLayer> loadedFromStream(AZ::Utils::LoadObjectFromStream<Layers::EditorLayer>(entitySaveStream));
  1961. EXPECT_NE(loadedFromStream, nullptr);
  1962. // Attempt to recover the layer. It has no parent, so use an invalid ID.
  1963. AZ::EntityId invalidParentId;
  1964. Layers::LayerResult recoveryResult = AzToolsFramework::Layers::EditorLayerComponent::RecoverEditorLayer(loadedFromStream, "RecoveredLayerName", invalidParentId);
  1965. // Verify it recovered successfully.
  1966. EXPECT_TRUE(recoveryResult.IsSuccess());
  1967. // Verify the slice instance is now in the scene.
  1968. AZStd::list<AZ::SliceComponent::SliceReference>& sliceList = rootSlice->GetSlices();
  1969. EXPECT_EQ(sliceList.size(), 1);
  1970. EXPECT_EQ(sliceList.front().GetSliceAsset(), loadedSliceAsset);
  1971. AZStd::unordered_set<AZ::SliceComponent::SliceInstance>& sliceInstances = sliceList.front().GetInstances();
  1972. EXPECT_EQ(sliceInstances.size(), 1);
  1973. // Verify the loose entities are restored.
  1974. EXPECT_EQ(looseEntities.size(), 2);
  1975. // Check the hierarchy is correct.
  1976. AZ::EntityId childParentId;
  1977. AZ::TransformBus::EventResult(
  1978. childParentId,
  1979. childEntityId,
  1980. &AZ::TransformBus::Events::GetParentId);
  1981. EXPECT_EQ(childParentId, layerEntityId);
  1982. AZ::EntityId sliceParentId;
  1983. AZ::TransformBus::EventResult(
  1984. sliceParentId,
  1985. sliceEntityId,
  1986. &AZ::TransformBus::Events::GetParentId);
  1987. EXPECT_EQ(sliceParentId, layerEntityId);
  1988. // Undo.
  1989. AzToolsFramework::ToolsApplicationRequestBus::Broadcast(&AzToolsFramework::ToolsApplicationRequestBus::Events::UndoPressed);
  1990. // Check everything's gone again.
  1991. EXPECT_EQ(looseEntities.size(), 0);
  1992. EXPECT_EQ(sliceList.size(), 0);
  1993. // Redo.
  1994. AzToolsFramework::ToolsApplicationRequestBus::Broadcast(&AzToolsFramework::ToolsApplicationRequestBus::Events::RedoPressed);
  1995. // Check everything's back and the hierarchy is correct.
  1996. EXPECT_EQ(looseEntities.size(), 2);
  1997. EXPECT_TRUE(IsLooseEntityInRootSlice(rootSlice, layerEntityId));
  1998. EXPECT_TRUE(IsLooseEntityInRootSlice(rootSlice, childEntityId));
  1999. EXPECT_EQ(sliceList.size(), 1);
  2000. AZ::EntityId childParentIdAfterRedo;
  2001. AZ::TransformBus::EventResult(
  2002. childParentIdAfterRedo,
  2003. childEntityId,
  2004. &AZ::TransformBus::Events::GetParentId);
  2005. EXPECT_EQ(childParentIdAfterRedo, layerEntityId);
  2006. AZ::EntityId sliceParentIdAfterRedo;
  2007. AZ::TransformBus::EventResult(
  2008. sliceParentIdAfterRedo,
  2009. sliceEntityId,
  2010. &AZ::TransformBus::Events::GetParentId);
  2011. EXPECT_EQ(sliceParentIdAfterRedo, layerEntityId);
  2012. rootSlice->RemoveAllEntities();
  2013. }
  2014. }