NavigationElement.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "Math/Box.h"
#include "Math/Transform.h"
#include "UObject/WeakObjectPtr.h"
 
class INavRelevantInterface;
class UBodySetup;
class UObject;
struct FNavigationElement;
struct FNavigationRelevantData;
struct FNavigableGeometryExport;
enum class ENavDataGatheringMode : uint8;
namespace EHasCustomNavigableGeometry
{
    enum Type : int;
}
 
DECLARE_DELEGATE_TwoParams(FNavigationDataExport, const FNavigationElement&, FNavigationRelevantData&);
DECLARE_DELEGATE_ThreeParams(FCustomGeometryExport, const FNavigationElement&, FNavigableGeometryExport&, bool&);
DECLARE_DELEGATE_ThreeParams(FGeometrySliceExport, const FNavigationElement&, FNavigableGeometryExport&, const FBox&);
 
struct FNavigationElementHandle
{
    static ENGINE_API const FNavigationElementHandle Invalid;
 
    FNavigationElementHandle() = default;
 
    inline explicit FNavigationElementHandle(const UObject* Object, const uint64 SubElementId = INDEX_NONE);
    inline explicit FNavigationElementHandle(const TWeakObjectPtr<const UObject>& WeakObject, const uint64 SubElementId = INDEX_NONE);
 
    inline bool operator==(const FNavigationElementHandle& Other) const;
    inline bool operator!=(const FNavigationElementHandle& Other) const;
 
    inline explicit operator bool() const;
 
    inline bool IsValid() const;
 
    inline void Invalidate();
 
    inline friend uint32 GetTypeHash(const FNavigationElementHandle& Handle);
 
    ENGINE_API friend FString LexToString(const FNavigationElementHandle& Handle);
 
private:
 
    TWeakObjectPtr<const UObject> OwnerUObject;
 
    uint64 SubElementId = INDEX_NONE;
};
 
 
struct FNavigationElement : TSharedFromThis<FNavigationElement>
{
private:
    friend struct FNavigationDirtyElement;
    struct FPrivateToken { explicit FPrivateToken() = default; };
    static TSharedRef<FNavigationElement> MakeFromUObject_DEPRECATED(UObject* InOwner)
    {
        return MakeShared<FNavigationElement>(FPrivateToken{}, InOwner, INDEX_NONE);
    }
 
public:
 
    // Public, but can only be called by FNavigationElement and friends, because it needs access to FPrivateToken
    ENGINE_API explicit FNavigationElement(FPrivateToken, const UObject* Object, uint64 SubElementId /*= INDEX_NONE*/);
 
    FNavigationElement() = delete;
    ENGINE_API explicit FNavigationElement(const UObject& Object, uint64 SubElementId = INDEX_NONE);
    ENGINE_API explicit FNavigationElement(const INavRelevantInterface& NavRelevant, uint64 SubElementId = INDEX_NONE);
 
    UE_DEPRECATED(5.5, "Temporary constructor to allow deprecation of other navigation types. Use the version taking an object reference instead.")
    explicit FNavigationElement(const UObject* Object, const uint64 SubElementId = INDEX_NONE)
        : FNavigationElement(FPrivateToken{}, Object, SubElementId)
    {
    }
 
    static ENGINE_API TSharedRef<const FNavigationElement> CreateFromNavRelevantInterface(const INavRelevantInterface& NavRelevantInterface);
 
    inline TWeakObjectPtr<const UObject> GetWeakUObject() const;
 
    ENGINE_API FNavigationElementHandle GetHandle() const;
 
    inline const FTransform& GetTransform() const;
 
    inline void SetTransform(const FTransform& InGeometryTransform);
 
    inline FBox GetBounds() const;
 
    inline void SetBounds(const FBox& InBounds);
 
    inline UBodySetup* GetBodySetup() const;
 
    ENGINE_API void SetBodySetup(UBodySetup* InBodySetup);
 
    inline const TWeakObjectPtr<const UObject>& GetNavigationParent() const;
 
    inline void SetNavigationParent(const UObject* InNavigationParent);
 
    inline EHasCustomNavigableGeometry::Type GetGeometryExportType() const;
 
    inline void SetGeometryExportType(const EHasCustomNavigableGeometry::Type InCustomNavigableGeometry);
 
    inline ENavDataGatheringMode GetGeometryGatheringMode() const;
 
    inline void SetGeometryGatheringMode(const ENavDataGatheringMode InGeometryGatheringMode);
 
    inline bool GetDirtyAreaOnRegistration() const;
 
    inline void SetDirtyAreaOnRegistration(const bool bInDirtyAreaOnRegistration);
 
    inline bool IsInBaseNavigationData() const;
 
    inline bool IsFromLevelVisibilityChange() const;
 
    ENGINE_API FString GetName() const;
 
    ENGINE_API FString GetPathName() const;
 
    ENGINE_API FString GetFullName() const;
 
    inline friend FString GetNameSafe(const FNavigationElement* Element);
 
    inline friend FString GetPathNameSafe(const FNavigationElement* Element);
 
    inline friend FString GetFullNameSafe(const FNavigationElement* Element);
 
    ENGINE_API friend uint32 GetTypeHash(const FNavigationElement& Element);
 
    ENGINE_API friend FString LexToString(const FNavigationElement& Element);
 
    FNavigationDataExport NavigationDataExportDelegate;
 
    FCustomGeometryExport CustomGeometryExportDelegate;
 
    FGeometrySliceExport GeometrySliceExportDelegate;
 
private:
 
    ENGINE_API explicit FNavigationElement(const UObject& Object, uint64 SubElementId, bool bTryInitializeFromInterface);
    void InitializeFromInterface(const INavRelevantInterface* NavRelevantInterface);
    
    TWeakObjectPtr<const UObject> OwnerUObject;
 
    uint64 SubElementId = INDEX_NONE;
 
    TWeakObjectPtr<UBodySetup> BodySetup = nullptr;
 
    FTransform GeometryTransform = FTransform::Identity;
 
    FBox Bounds;
 
    TWeakObjectPtr<const UObject> NavigationParent = nullptr;
 
    EHasCustomNavigableGeometry::Type GeometryExportType;
 
    ENavDataGatheringMode GeometryGatheringMode;
 
    bool bDirtyAreaOnRegistration = true;
 
    bool bIsInBaseNavigationData = false;
 
    bool bIsFromLevelVisibilityChange = false;
};
 
 
//----------------------------------------------------------------------//
// Inlines
//----------------------------------------------------------------------//
uint32 GetTypeHash(const FNavigationElementHandle& Key)
{
    return HashCombine(GetTypeHash(Key.OwnerUObject), GetTypeHash(Key.SubElementId));
}
 
FString GetNameSafe(const FNavigationElement* Element)
{
    return Element ? Element->GetName() : TEXT("None");
}
 
FString GetPathNameSafe(const FNavigationElement* Element)
{
    return Element ? Element->GetPathName() : TEXT("None");
}
 
FString GetFullNameSafe(const FNavigationElement* Element)
{
    return Element ? Element->GetFullName() : TEXT("None");
}
 
 
//----------------------------------------------------------------------//
// Inlines (FNavigationElementHandle)
//----------------------------------------------------------------------//
 
FNavigationElementHandle::FNavigationElementHandle(const UObject* Object, const uint64 SubElementId /*= INDEX_NONE*/)
    : OwnerUObject(Object)
    , SubElementId(SubElementId)
{
}
 
FNavigationElementHandle::FNavigationElementHandle(const TWeakObjectPtr<const UObject>& WeakObject, const uint64 SubElementId /*= INDEX_NONE*/)
    : OwnerUObject(WeakObject)
    , SubElementId(SubElementId)
{
}
 
bool FNavigationElementHandle::operator==(const FNavigationElementHandle& Other) const
{
    return OwnerUObject.HasSameIndexAndSerialNumber(Other.OwnerUObject) && SubElementId == Other.SubElementId;
}
 
bool FNavigationElementHandle::operator!=(const FNavigationElementHandle& Other) const
{
    return !(*this == Other);
}
 
FNavigationElementHandle::operator bool() const
{
    return IsValid();
}
 
bool FNavigationElementHandle::IsValid() const
{
    return *this != Invalid;
}
 
void FNavigationElementHandle::Invalidate()
{
    *this = Invalid;
}
 
 
//----------------------------------------------------------------------//
// Inlines (FNavigationElement)
//----------------------------------------------------------------------//
 
TWeakObjectPtr<const UObject> FNavigationElement::GetWeakUObject() const
{
    return OwnerUObject;
}
 
bool FNavigationElement::IsFromLevelVisibilityChange() const
{
    return bIsFromLevelVisibilityChange;
}
 
bool FNavigationElement::IsInBaseNavigationData() const
{
    return bIsInBaseNavigationData;
}
 
const FTransform& FNavigationElement::GetTransform() const
{
    return GeometryTransform;
}
 
void FNavigationElement::SetTransform(const FTransform& InGeometryTransform)
{
    GeometryTransform = InGeometryTransform;
}
 
FBox FNavigationElement::GetBounds() const
{
    return Bounds;
}
 
void FNavigationElement::SetBounds(const FBox& InBounds)
{
    Bounds = InBounds;
}
 
UBodySetup* FNavigationElement::GetBodySetup() const
{
    return BodySetup.Get();
}
 
const TWeakObjectPtr<const UObject>& FNavigationElement::GetNavigationParent() const
{
    return NavigationParent;
}
 
void FNavigationElement::SetNavigationParent(const UObject* InNavigationParent)
{
    NavigationParent = InNavigationParent;
}
 
EHasCustomNavigableGeometry::Type FNavigationElement::GetGeometryExportType() const
{
    return GeometryExportType;
}
 
void FNavigationElement::SetGeometryExportType(const EHasCustomNavigableGeometry::Type InCustomNavigableGeometry)
{
    GeometryExportType = InCustomNavigableGeometry;
}
 
ENavDataGatheringMode FNavigationElement::GetGeometryGatheringMode() const
{
    return GeometryGatheringMode;
}
 
void FNavigationElement::SetGeometryGatheringMode(const ENavDataGatheringMode InGeometryGatheringMode)
{
    GeometryGatheringMode = InGeometryGatheringMode;
}
 
bool FNavigationElement::GetDirtyAreaOnRegistration() const
{
    return bDirtyAreaOnRegistration;
}
 
void FNavigationElement::SetDirtyAreaOnRegistration(const bool bInDirtyAreaOnRegistration)
{
    bDirtyAreaOnRegistration = bInDirtyAreaOnRegistration;
}