birkeh
/
o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Dragging an entity from outside the focused Prefab into it may crash the Editor (#5762)

Browse Source 
* Replace Instance References with EntityId of the Prefab Container (WIP)

Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com>

* Use the invalid entity id for the root instance and get the root instance every time to prevent weird Prefab EOS shenanigans.

Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com>

* Revert unnecessary changes, fix IsOwningPrefabBeingFocused to match previous behavior. Disable some tests that no longer apply correctly due to the testing environment not relying on the Prefab EOS.

Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com>

* Fix minor typo in test comment

Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com>
monroegm-disable-blank-issue-2
Danilo Aimini 4 years ago committed by GitHub
parent edb15946ca
commit ac959bcc01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 99 additions and 57 deletions
Show Stats Download Patch File Download Diff File

129
Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/PrefabFocusHandler.cpp
Unescape Escape View File

@ -98,7 +98,7 @@ namespace AzToolsFramework::Prefab
} }
// Retrieve parent of currently focused prefab. // Retrieve parent of currently focused prefab.
InstanceOptionalReference parentInstance = m_instanceFocusHierarchy[hierarchySize - 2]; InstanceOptionalReference parentInstance = GetReferenceFromContainerEntityId(m_instanceFocusHierarchy[hierarchySize - 2]);
// Use container entity of parent Instance for focus operations. // Use container entity of parent Instance for focus operations.
AZ::EntityId entityId = parentInstance->get().GetContainerEntityId(); AZ::EntityId entityId = parentInstance->get().GetContainerEntityId();
@ -132,7 +132,7 @@ namespace AzToolsFramework::Prefab
return AZ::Failure(AZStd::string("Prefab Focus Handler: Invalid index on FocusOnPathIndex.")); return AZ::Failure(AZStd::string("Prefab Focus Handler: Invalid index on FocusOnPathIndex."));
} }
InstanceOptionalReference focusedInstance = m_instanceFocusHierarchy[index]; InstanceOptionalReference focusedInstance = GetReferenceFromContainerEntityId(m_instanceFocusHierarchy[index]);
return FocusOnOwningPrefab(focusedInstance->get().GetContainerEntityId()); return FocusOnOwningPrefab(focusedInstance->get().GetContainerEntityId());
} }
@ -172,7 +172,8 @@ namespace AzToolsFramework::Prefab
// Close all container entities in the old path. // Close all container entities in the old path.
CloseInstanceContainers(m_instanceFocusHierarchy); CloseInstanceContainers(m_instanceFocusHierarchy);
m_focusedInstance = focusedInstance; // Do not store the container for the root instance, use an invalid EntityId instead.
m_focusedInstanceContainerEntityId = focusedInstance->get().GetParentInstance().has_value() ? focusedInstance->get().GetContainerEntityId() : AZ::EntityId();
m_focusedTemplateId = focusedInstance->get().GetTemplateId(); m_focusedTemplateId = focusedInstance->get().GetTemplateId();
// Focus on the descendants of the container entity in the Editor, if the interface is initialized. // Focus on the descendants of the container entity in the Editor, if the interface is initialized.
@ -206,56 +207,55 @@ namespace AzToolsFramework::Prefab
InstanceOptionalReference PrefabFocusHandler::GetFocusedPrefabInstance( InstanceOptionalReference PrefabFocusHandler::GetFocusedPrefabInstance(
[[maybe_unused]] AzFramework::EntityContextId entityContextId) const [[maybe_unused]] AzFramework::EntityContextId entityContextId) const
{ {
return m_focusedInstance; return GetReferenceFromContainerEntityId(m_focusedInstanceContainerEntityId);
} }
AZ::EntityId PrefabFocusHandler::GetFocusedPrefabContainerEntityId([[maybe_unused]] AzFramework::EntityContextId entityContextId) const AZ::EntityId PrefabFocusHandler::GetFocusedPrefabContainerEntityId([[maybe_unused]] AzFramework::EntityContextId entityContextId) const
{ {
if (!m_focusedInstance.has_value()) return m_focusedInstanceContainerEntityId;
{
// PrefabFocusHandler has not been initialized yet.
return AZ::EntityId();
}
return m_focusedInstance->get().GetContainerEntityId();
} }
bool PrefabFocusHandler::IsOwningPrefabBeingFocused(AZ::EntityId entityId) const bool PrefabFocusHandler::IsOwningPrefabBeingFocused(AZ::EntityId entityId) const
{ {
if (!m_focusedInstance.has_value()) if (!entityId.IsValid())
{ {
// PrefabFocusHandler has not been initialized yet.
return false; return false;
} }
if (!entityId.IsValid()) InstanceOptionalReference instance = m_instanceEntityMapperInterface->FindOwningInstance(entityId);
if (!instance.has_value())
{ {
return false; return false;
} }
InstanceOptionalReference instance = m_instanceEntityMapperInterface->FindOwningInstance(entityId); // If this is owned by the root instance, that corresponds to an invalid m_focusedInstanceContainerEntityId.
if (!instance->get().GetParentInstance().has_value())
{
return !m_focusedInstanceContainerEntityId.IsValid();
}
return instance.has_value() && (&instance->get() == &m_focusedInstance->get()); return (instance->get().GetContainerEntityId() == m_focusedInstanceContainerEntityId);
} }
bool PrefabFocusHandler::IsOwningPrefabInFocusHierarchy(AZ::EntityId entityId) const bool PrefabFocusHandler::IsOwningPrefabInFocusHierarchy(AZ::EntityId entityId) const
{ {
if (!m_focusedInstance.has_value()) if (!entityId.IsValid())
{ {
// PrefabFocusHandler has not been initialized yet.
return false; return false;
} }
if (!entityId.IsValid()) // If the focus is on the root, m_focusedInstanceContainerEntityId will be the invalid id.
// In those case all entities are in the focus hierarchy and should return true.
if (!m_focusedInstanceContainerEntityId.IsValid())
{ {
return false; return true;
} }
InstanceOptionalReference instance = m_instanceEntityMapperInterface->FindOwningInstance(entityId); InstanceOptionalReference instance = m_instanceEntityMapperInterface->FindOwningInstance(entityId);
while (instance.has_value()) while (instance.has_value())
{ {
if (&instance->get() == &m_focusedInstance->get()) if (instance->get().GetContainerEntityId() == m_focusedInstanceContainerEntityId)
{ {
return true; return true;
} }
@ -290,8 +290,9 @@ namespace AzToolsFramework::Prefab
// Determine if the entityId is the container for any of the instances in the vector. // Determine if the entityId is the container for any of the instances in the vector.
auto result = AZStd::find_if( auto result = AZStd::find_if(
m_instanceFocusHierarchy.begin(), m_instanceFocusHierarchy.end(), m_instanceFocusHierarchy.begin(), m_instanceFocusHierarchy.end(),
[entityId](const InstanceOptionalReference& instance) [&, entityId](const AZ::EntityId& containerEntityId)
{ {
InstanceOptionalReference instance = GetReferenceFromContainerEntityId(containerEntityId);
return (instance->get().GetContainerEntityId() == entityId); return (instance->get().GetContainerEntityId() == entityId);
} }
); );
@ -316,8 +317,9 @@ namespace AzToolsFramework::Prefab
// Determine if the templateId matches any of the instances in the vector. // Determine if the templateId matches any of the instances in the vector.
auto result = AZStd::find_if( auto result = AZStd::find_if(
m_instanceFocusHierarchy.begin(), m_instanceFocusHierarchy.end(), m_instanceFocusHierarchy.begin(), m_instanceFocusHierarchy.end(),
[templateId](const InstanceOptionalReference& instance) [&, templateId](const AZ::EntityId& containerEntityId)
{ {
InstanceOptionalReference instance = GetReferenceFromContainerEntityId(containerEntityId);
return (instance->get().GetTemplateId() == templateId); return (instance->get().GetTemplateId() == templateId);
} }
); );
@ -336,10 +338,17 @@ namespace AzToolsFramework::Prefab
AZStd::list<InstanceOptionalReference> instanceFocusList; AZStd::list<InstanceOptionalReference> instanceFocusList;
InstanceOptionalReference currentInstance = m_focusedInstance; InstanceOptionalReference currentInstance = GetReferenceFromContainerEntityId(m_focusedInstanceContainerEntityId);
while (currentInstance.has_value()) while (currentInstance.has_value())
{ {
m_instanceFocusHierarchy.emplace_back(currentInstance); if (currentInstance->get().GetParentInstance().has_value())
{
m_instanceFocusHierarchy.emplace_back(currentInstance->get().GetContainerEntityId());
}
else
{
m_instanceFocusHierarchy.emplace_back(AZ::EntityId());
}
currentInstance = currentInstance->get().GetParentInstance(); currentInstance = currentInstance->get().GetParentInstance();
} }
@ -357,33 +366,37 @@ namespace AzToolsFramework::Prefab
size_t index = 0; size_t index = 0;
size_t maxIndex = m_instanceFocusHierarchy.size() - 1; size_t maxIndex = m_instanceFocusHierarchy.size() - 1;
for (const InstanceOptionalReference& instance : m_instanceFocusHierarchy) for (const AZ::EntityId containerEntityId : m_instanceFocusHierarchy)
{ {
AZStd::string prefabName; InstanceOptionalReference instance = GetReferenceFromContainerEntityId(containerEntityId);
if (instance.has_value())
if (index < maxIndex)
{
// Get the filename without the extension (stem).
prefabName = instance->get().GetTemplateSourcePath().Stem().Native();
}
else
{
// Get the full filename.
prefabName = instance->get().GetTemplateSourcePath().Filename().Native();
}
if (prefabSystemComponentInterface->IsTemplateDirty(instance->get().GetTemplateId()))
{ {
prefabName += "*"; AZStd::string prefabName;
if (index < maxIndex)
{
// Get the filename without the extension (stem).
prefabName = instance->get().GetTemplateSourcePath().Stem().Native();
}
else
{
// Get the full filename.
prefabName = instance->get().GetTemplateSourcePath().Filename().Native();
}
if (prefabSystemComponentInterface->IsTemplateDirty(instance->get().GetTemplateId()))
{
prefabName += "*";
}
m_instanceFocusPath.Append(prefabName);
} }
m_instanceFocusPath.Append(prefabName);
++index; ++index;
} }
} }
void PrefabFocusHandler::OpenInstanceContainers(const AZStd::vector<InstanceOptionalReference>& instances) const void PrefabFocusHandler::OpenInstanceContainers(const AZStd::vector<AZ::EntityId>& instances) const
{ {
// If this is called outside the Editor, this interface won't be initialized. // If this is called outside the Editor, this interface won't be initialized.
if (!m_containerEntityInterface) if (!m_containerEntityInterface)
@ -391,8 +404,10 @@ namespace AzToolsFramework::Prefab
return; return;
} }
for (const InstanceOptionalReference& instance : instances) for (const AZ::EntityId containerEntityId : instances)
{ {
InstanceOptionalReference instance = GetReferenceFromContainerEntityId(containerEntityId);
if (instance.has_value()) if (instance.has_value())
{ {
m_containerEntityInterface->SetContainerOpen(instance->get().GetContainerEntityId(), true); m_containerEntityInterface->SetContainerOpen(instance->get().GetContainerEntityId(), true);
@ -400,7 +415,7 @@ namespace AzToolsFramework::Prefab
} }
} }
void PrefabFocusHandler::CloseInstanceContainers(const AZStd::vector<InstanceOptionalReference>& instances) const void PrefabFocusHandler::CloseInstanceContainers(const AZStd::vector<AZ::EntityId>& instances) const
{ {
// If this is called outside the Editor, this interface won't be initialized. // If this is called outside the Editor, this interface won't be initialized.
if (!m_containerEntityInterface) if (!m_containerEntityInterface)
@ -408,8 +423,10 @@ namespace AzToolsFramework::Prefab
return; return;
} }
for (const InstanceOptionalReference& instance : instances) for (const AZ::EntityId containerEntityId : instances)
{ {
InstanceOptionalReference instance = GetReferenceFromContainerEntityId(containerEntityId);
if (instance.has_value()) if (instance.has_value())
{ {
m_containerEntityInterface->SetContainerOpen(instance->get().GetContainerEntityId(), false); m_containerEntityInterface->SetContainerOpen(instance->get().GetContainerEntityId(), false);
@ -417,4 +434,22 @@ namespace AzToolsFramework::Prefab
} }
} }
InstanceOptionalReference PrefabFocusHandler::GetReferenceFromContainerEntityId(AZ::EntityId containerEntityId) const
{
if (!containerEntityId.IsValid())
{
PrefabEditorEntityOwnershipInterface* prefabEditorEntityOwnershipInterface =
AZ::Interface<PrefabEditorEntityOwnershipInterface>::Get();
if (!prefabEditorEntityOwnershipInterface)
{
return AZStd::nullopt;
}
return prefabEditorEntityOwnershipInterface->GetRootPrefabInstance();
}
return m_instanceEntityMapperInterface->FindOwningInstance(containerEntityId);
}
} // namespace AzToolsFramework::Prefab } // namespace AzToolsFramework::Prefab

17
Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/PrefabFocusHandler.h
Unescape Escape View File

@ -73,16 +73,19 @@ namespace AzToolsFramework::Prefab
void RefreshInstanceFocusList(); void RefreshInstanceFocusList();
void RefreshInstanceFocusPath(); void RefreshInstanceFocusPath();
void OpenInstanceContainers(const AZStd::vector<InstanceOptionalReference>& instances) const; void OpenInstanceContainers(const AZStd::vector<AZ::EntityId>& instances) const;
void CloseInstanceContainers(const AZStd::vector<InstanceOptionalReference>& instances) const; void CloseInstanceContainers(const AZStd::vector<AZ::EntityId>& instances) const;
//! The instance the editor is currently focusing on. InstanceOptionalReference GetReferenceFromContainerEntityId(AZ::EntityId containerEntityId) const;
InstanceOptionalReference m_focusedInstance;
//! The EntityId of the prefab container entity for the instance the editor is currently focusing on.
AZ::EntityId m_focusedInstanceContainerEntityId = AZ::EntityId();
//! The templateId of the focused instance. //! The templateId of the focused instance.
TemplateId m_focusedTemplateId; TemplateId m_focusedTemplateId;
//! The list of instances going from the root (index 0) to the focused instance. //! The list of instances going from the root (index 0) to the focused instance,
AZStd::vector<InstanceOptionalReference> m_instanceFocusHierarchy; //! referenced by their prefab container's EntityId.
//! A path containing the names of the containers in the instance focus hierarchy, separated with a /. AZStd::vector<AZ::EntityId> m_instanceFocusHierarchy;
//! A path containing the filenames of the instances in the focus hierarchy, separated with a /.
AZ::IO::Path m_instanceFocusPath; AZ::IO::Path m_instanceFocusPath;
ContainerEntityInterface* m_containerEntityInterface = nullptr; ContainerEntityInterface* m_containerEntityInterface = nullptr;

8
Code/Framework/AzToolsFramework/Tests/Prefab/PrefabFocus/PrefabFocusTests.cpp
Unescape Escape View File

@ -106,7 +106,9 @@ namespace UnitTest
inline static const char* Passenger2EntityName = "Passenger2"; inline static const char* Passenger2EntityName = "Passenger2";
}; };
TEST_F(PrefabFocusTests, PrefabFocus_FocusOnOwningPrefab_RootContainer) // Test was disabled because the implementation of GetFocusedPrefabInstance now relies on the Prefab EOS,
// which is not used by our test environment. This can be restored once Instance handles are implemented.
TEST_F(PrefabFocusTests, DISABLED_PrefabFocus_FocusOnOwningPrefab_RootContainer)
{ {
// Verify FocusOnOwningPrefab works when passing the container entity of the root prefab. // Verify FocusOnOwningPrefab works when passing the container entity of the root prefab.
{ {
@ -121,7 +123,9 @@ namespace UnitTest
} }
} }
TEST_F(PrefabFocusTests, PrefabFocus_FocusOnOwningPrefab_RootEntity) // Test was disabled because the implementation of GetFocusedPrefabInstance now relies on the Prefab EOS,
// which is not used by our test environment. This can be restored once Instance handles are implemented.
TEST_F(PrefabFocusTests, DISABLED_PrefabFocus_FocusOnOwningPrefab_RootEntity)
{ {
// Verify FocusOnOwningPrefab works when passing a nested entity of the root prefab. // Verify FocusOnOwningPrefab works when passing a nested entity of the root prefab.
{ {

Write Preview
Loading…
Cancel
Save