NavLocalGridManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
#include "UObject/ScriptMacros.h"
#include "NavLocalGridData.h"
#include "NavLocalGridManager.generated.h"
 
struct FCombinedNavGridData : public FNavLocalGridData
{
    TArray<int32> SourceIds;
 
    FCombinedNavGridData() {}
    FCombinedNavGridData(const TArray<FNavLocalGridData>& SourceGrids) : FNavLocalGridData(SourceGrids) {}
};
 
UCLASS(Experimental, MinimalAPI)
class UNavLocalGridManager : public UObject
{
    GENERATED_UCLASS_BODY()
public:
 
    AIMODULE_API int32 AddGridData(const FNavLocalGridData& GridData, bool bUpdate = true);
 
    AIMODULE_API void RemoveGridData(int32 GridId, bool bUpdate = true);
 
    AIMODULE_API void RebuildGrids();
 
    AIMODULE_API bool FindPath(const FVector& Start, const FVector& End, TArray<FVector>& PathPoints) const;
 
    AIMODULE_API bool SetCellSize(float CellSize);
 
    static float GetCellSize() { return GridCellSize; }
 
    AIMODULE_API void SetMaxActiveSources(int32 NumActiveSources);
 
    int32 GetMaxActiveSources() const { return MaxActiveSourceGrids; }
 
    bool HasSourceGridLimit() const { return MaxActiveSourceGrids > 0; }
 
    AIMODULE_API void UpdateAccessTime(int32 CombinedGridIdx);
 
    int32 GetNumSources() const { return SourceGrids.Num(); }
 
    int32 GetNumGrids() const { return CombinedGrids.Num(); }
 
    const FNavLocalGridData& GetSourceData(int32 SourceIdx) const { return SourceGrids[SourceIdx]; }
 
    const FNavLocalGridData& GetGridData(int32 GridIdx) const { return CombinedGrids[GridIdx]; }
 
    AIMODULE_API uint8 GetGridValueAt(const FVector& WorldLocation) const;
 
    AIMODULE_API int32 GetGridIndex(const FVector& WorldLocation) const;
 
    int32 GetVersion() const { return VersionNum; }
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation", meta = (WorldContext = "WorldContextObject"))
    static AIMODULE_API bool SetLocalNavigationGridDensity(UObject* WorldContextObject, float CellSize);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation", meta = (WorldContext = "WorldContextObject"))
    static AIMODULE_API int32 AddLocalNavigationGridForPoint(UObject* WorldContextObject, const FVector& Location, const int32 Radius2D = 5, const float Height = 100.0f, bool bRebuildGrids = true);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation", meta = (WorldContext = "WorldContextObject"))
    static AIMODULE_API int32 AddLocalNavigationGridForPoints(UObject* WorldContextObject, const TArray<FVector>& Locations, const int32 Radius2D = 5, const float Height = 100.0f, bool bRebuildGrids = true);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation", meta = (WorldContext = "WorldContextObject"))
    static AIMODULE_API int32 AddLocalNavigationGridForBox(UObject* WorldContextObject, const FVector& Location, FVector Extent = FVector(1,1,1), FRotator Rotation = FRotator::ZeroRotator, const int32 Radius2D = 5, const float Height = 100.0f, bool bRebuildGrids = true);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation", meta = (WorldContext = "WorldContextObject"))
    static AIMODULE_API int32 AddLocalNavigationGridForCapsule(UObject* WorldContextObject, const FVector& Location, float CapsuleRadius, float CapsuleHalfHeight, const int32 Radius2D = 5, const float Height = 100.0f, bool bRebuildGrids = true);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation", meta = (WorldContext = "WorldContextObject"))
    static AIMODULE_API void RemoveLocalNavigationGrid(UObject* WorldContextObject, int32 GridId, bool bRebuildGrids = true);
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation", meta = (WorldContext = "WorldContextObject"))
    static AIMODULE_API bool FindLocalNavigationGridPath(UObject* WorldContextObject, const FVector& Start, const FVector& End, TArray<FVector>& PathPoints);
 
    static AIMODULE_API UNavLocalGridManager* GetCurrent(UWorld* World);
    static AIMODULE_API UNavLocalGridManager* GetCurrent(const UObject* WorldContextObject);
 
#if WITH_ENGINE
    AIMODULE_API virtual UWorld* GetWorld() const override;
#endif
 
protected:
 
    TArray<FCombinedNavGridData> CombinedGrids;
    TArray<FNavLocalGridData> SourceGrids;
    
    static AIMODULE_API float GridCellSize;
 
    int32 VersionNum;
    int32 NextGridId;
    int32 MaxActiveSourceGrids;
    uint32 bNeedsRebuilds : 1;
 
    AIMODULE_API virtual void ProjectGrids(const TArray<int32>& GridIndices);
 
    AIMODULE_API bool UpdateSourceGrids();
};