NavigationObjectRepository.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AI/Navigation/NavigationElement.h" // required since we can't fwd declare types used as TMap keys
#include "Misc/MTTransactionallySafeAccessDetector.h"
#include "Subsystems/WorldSubsystem.h"
#include "UObject/ObjectKey.h"
#include "UObject/WeakInterfacePtr.h"
#include "NavigationObjectRepository.generated.h"
 
class INavLinkCustomInterface;
class INavRelevantInterface;
 
UE_DEPRECATED(5.5, "Use the overloaded version with FNavigationElement instead.")
DECLARE_DELEGATE_OneParam(FOnNavRelevantObjectRegistrationEvent, INavRelevantInterface&);
 
DECLARE_DELEGATE_OneParam(FOnNavigationElementRegistrationEvent, const TSharedRef<const FNavigationElement>&);
DECLARE_DELEGATE_OneParam(FOnCustomNavLinkObjectRegistrationEvent, INavLinkCustomInterface&);
 
UCLASS()
class UNavigationObjectRepository : public UWorldSubsystem
{
    GENERATED_BODY()
 
public:
 
    // Specifies whether OnNavigationElementAddedDelegate must be broadcast on successful registration.
    enum class ENotifyOnSuccess : uint8
    {
        No,
        Yes
    };
 
    TSharedPtr<const FNavigationElement> AddNavigationElement(FNavigationElement&& Element, ENotifyOnSuccess NotifyOnSuccess = ENotifyOnSuccess::Yes);
 
    void RemoveNavigationElement(FNavigationElementHandle Handle);
 
    void ForEachNavigationElement(TFunctionRef<void(const TSharedRef<const FNavigationElement>&)>) const;
 
    TSharedPtr<const FNavigationElement> RegisterNavRelevantObject(const INavRelevantInterface& NavRelevantObject);
 
    void UnregisterNavRelevantObject(const INavRelevantInterface& NavRelevantObject);
 
    void UnregisterNavRelevantObject(const UObject* NavRelevantObject);
 
    FNavigationElementHandle GetNavigationElementHandleForUObject(const UObject* NavRelevantObject) const;
 
    TSharedPtr<const FNavigationElement> GetNavigationElementForUObject(const UObject* NavRelevantObject) const;
 
    TSharedPtr<FNavigationElement> GetMutableNavigationElementForUObject(const UObject* NavRelevantObject) const;
 
    TSharedPtr<const FNavigationElement> UpdateNavigationElementForUObject(const INavRelevantInterface& NavRelevantInterface, const UObject& NavRelevantObject);
 
    TSharedPtr<const FNavigationElement> GetNavigationElementForHandle(FNavigationElementHandle Handle) const;
 
    TSharedPtr<FNavigationElement> GetMutableNavigationElementForHandle(FNavigationElementHandle Handle) const;
 
    void RegisterCustomNavLinkObject(INavLinkCustomInterface& CustomNavLinkObject);
 
    void UnregisterCustomNavLinkObject(INavLinkCustomInterface& CustomNavLinkObject);
 
    TConstArrayView<TWeakInterfacePtr<INavLinkCustomInterface>> GetCustomLinks() const
    {
        return CustomLinkObjects;
    }
 
    int32 GetNumRegisteredElements() const
    {
        return NavRelevantElements.Num();
    }
 
    int32 GetNumRegisteredUObjects() const
    {
        return ObjectsToHandleMap.Num();
    }
 
    int32 GetNumRegisteredCustomLinks() const
    {
        return CustomLinkObjects.Num();
    }
 
    FOnNavigationElementRegistrationEvent OnNavigationElementAddedDelegate;
 
    FOnNavigationElementRegistrationEvent OnNavigationElementRemovedDelegate;
 
    FOnCustomNavLinkObjectRegistrationEvent OnCustomNavLinkObjectRegistered;
 
    FOnCustomNavLinkObjectRegistrationEvent OnCustomNavLinkObjectUnregistered;
 
protected:
    virtual bool ShouldCreateSubsystem(UObject* Outer) const override;
 
private:
 
    TSharedPtr<const FNavigationElement> RegisterNavRelevantObjectInternal(const INavRelevantInterface& NavRelevantInterface, const UObject& NavRelevantObject, ENotifyOnSuccess NotifyOnSuccess);
 
    TMap<FObjectKey, FNavigationElementHandle> ObjectsToHandleMap;
 
    TMap<FNavigationElementHandle, TSharedPtr<FNavigationElement>> NavRelevantElements;
 
    TArray<TWeakInterfacePtr<INavLinkCustomInterface>> CustomLinkObjects;
 
    UE_MT_DECLARE_TS_RW_ACCESS_DETECTOR(NavElementAccessDetector);
 
    //----------------------------------------------------------------------//
    // DEPRECATED
    //----------------------------------------------------------------------//
public:
 
#if WITH_EDITORONLY_DATA
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_DEPRECATED(5.5, "Use OnNavigationElementAddedDelegate instead.")
    FOnNavRelevantObjectRegistrationEvent OnNavRelevantObjectRegistered;
 
    UE_DEPRECATED(5.5, "Use OnNavigationElementRemovedDelegate instead.")
    FOnNavRelevantObjectRegistrationEvent OnNavRelevantObjectUnregistered;
PRAGMA_ENABLE_DEPRECATION_WARNINGS
#endif // WITH_EDITORONLY_DATA
};