Refactoring away the use of AZ::TransformNotificationBus. Added unittests for deactivating parents of inner roots.

Signed-off-by: AMZN-Olex <5432499+AMZN-Olex@users.noreply.github.com>
This commit is contained in:
AMZN-Olex
2021-09-15 11:29:10 -04:00
parent fcd5b3f184
commit 714dc0a0e8
6 changed files with 296 additions and 111 deletions
@@ -19,6 +19,10 @@ namespace Multiplayer
: public AZ::ComponentBus
{
public:
//! @returns true if the entity a hierarchical component attached should be considered for inclusion in a hierarchy
//! this should return false when an entity is deactivating
virtual bool IsHierarchyEnabled() const = 0;
//! @returns hierarchical entities, the first element is the top level root
virtual AZStd::vector<AZ::Entity*> GetHierarchicalEntities() const = 0;
@@ -9,6 +9,7 @@
#pragma once
#include <AzCore/Component/Component.h>
#include <AzCore/Component/TransformBus.h>
#include <Multiplayer/Components/NetworkHierarchyBus.h>
#include <Source/AutoGen/NetworkHierarchyChildComponent.AutoComponent.h>
@@ -42,12 +43,13 @@ namespace Multiplayer
//! NetworkHierarchyChildComponentBase overrides.
//! @{
void OnInit() override;
void OnActivate(Multiplayer::EntityIsMigrating entityIsMigrating) override;
void OnDeactivate(Multiplayer::EntityIsMigrating entityIsMigrating) override;
void OnActivate(EntityIsMigrating entityIsMigrating) override;
void OnDeactivate(EntityIsMigrating entityIsMigrating) override;
//! @}
//! NetworkHierarchyRequestBus overrides.
//! @{
bool IsHierarchyEnabled() const override;
bool IsHierarchicalChild() const override;
bool IsHierarchicalRoot() const override { return false; }
AZ::Entity* GetHierarchicalRoot() const override;
@@ -58,15 +60,26 @@ namespace Multiplayer
protected:
//! Used by @NetworkHierarchyRootComponent
void SetTopLevelHierarchyRootComponent(NetworkHierarchyRootComponent* hierarchyRoot);
void SetTopLevelHierarchyRootEntity(AZ::Entity* hierarchyRoot);
private:
const NetworkHierarchyRootComponent* m_hierarchyRootComponent = nullptr;
AZ::ChildChangedEvent::Handler m_childChangedHandler;
AZ::ParentChangedEvent::Handler m_parentChangedHandler;
void OnChildChanged(AZ::ChildChangeType type, AZ::EntityId child);
void OnParentChanged(AZ::EntityId oldParent, AZ::EntityId parent);
//! Points to the top level root.
AZ::Entity* m_rootEntity = nullptr;
AZ::Event<NetEntityId>::Handler m_hierarchyRootNetIdChanged;
void OnHierarchyRootNetIdChanged(NetEntityId rootNetId);
NetworkHierarchyChangedEvent m_networkHierarchyChangedEvent;
NetworkHierarchyLeaveEvent m_networkHierarchyLeaveEvent;
bool m_isDeactivating = false;
void NotifyChildrenHierarchyDisbanded();
};
}
@@ -10,8 +10,8 @@
#include <AzCore/Component/Component.h>
#include <AzCore/Component/TransformBus.h>
#include <Source/AutoGen/NetworkHierarchyRootComponent.AutoComponent.h>
#include <Multiplayer/Components/NetworkHierarchyBus.h>
#include <Source/AutoGen/NetworkHierarchyRootComponent.AutoComponent.h>
namespace Multiplayer
{
@@ -27,8 +27,8 @@ namespace Multiplayer
class NetworkHierarchyRootComponent final
: public NetworkHierarchyRootComponentBase
, public NetworkHierarchyRequestBus::Handler
, protected AZ::TransformNotificationBus::MultiHandler
{
friend class NetworkHierarchyChildComponent;
public:
AZ_MULTIPLAYER_COMPONENT(Multiplayer::NetworkHierarchyRootComponent, s_networkHierarchyRootComponentConcreteUuid, Multiplayer::NetworkHierarchyRootComponentBase);
@@ -37,6 +37,8 @@ namespace Multiplayer
static void GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided);
static void GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible);
NetworkHierarchyRootComponent();
//! NetworkHierarchyRootComponentBase overrides.
//! @{
void OnInit() override;
@@ -46,6 +48,7 @@ namespace Multiplayer
//! NetworkHierarchyRequestBus overrides.
//! @{
bool IsHierarchyEnabled() const override;
bool IsHierarchicalRoot() const override;
bool IsHierarchicalChild() const override;
AZStd::vector<AZ::Entity*> GetHierarchicalEntities() const override;
@@ -55,22 +58,24 @@ namespace Multiplayer
//! @}
protected:
//! AZ::TransformNotificationBus::Handler overrides.
//! @{
void OnParentChanged(AZ::EntityId oldParent, AZ::EntityId newParent) override;
void OnChildAdded(AZ::EntityId child) override;
void OnChildRemoved(AZ::EntityId childRemovedId) override;
//! @}
void SetTopLevelHierarchyRootEntity(AZ::Entity* hierarchyRoot);
private:
AZ::ChildChangedEvent::Handler m_childChangedHandler;
AZ::ParentChangedEvent::Handler m_parentChangedHandler;
void OnChildChanged(AZ::ChildChangeType type, AZ::EntityId child);
void OnParentChanged(AZ::EntityId oldParent, AZ::EntityId parent);
NetworkHierarchyChangedEvent m_networkHierarchyChangedEvent;
NetworkHierarchyLeaveEvent m_networkHierarchyLeaveEvent;
AZ::Entity* m_higherRootEntity = nullptr;
//! Points to the top level root, if this root is an inner root in this hierarchy.
AZ::Entity* m_rootEntity = nullptr;
AZStd::vector<AZ::Entity*> m_hierarchicalEntities;
//! Rebuilds hierarchy starting from this root component's entity.
void RebuildHierarchy();
//! @param underEntity Walk the child entities that belong to @underEntity and consider adding them to the hierarchy
@@ -86,5 +91,9 @@ namespace Multiplayer
//! @currentEntityCount will be modified to reflect the total entity count upon completion of this method.
//! @returns false if an attempt was made to go beyond the maximum supported hierarchy size, true otherwise
bool RecursiveAttachHierarchicalChild(AZ::EntityId entity, uint32_t& currentEntityCount);
void SetRootForEntity(AZ::Entity* root, const AZ::Entity* childEntity);
bool m_isDeactivating = false;
};
}