MetaNavMeshPath.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "EngineDefines.h"
#include "AI/Navigation/NavigationTypes.h"
#include "NavMesh/RecastNavMesh.h"
 
class AController;
class UCanvas;
struct FVisualLogEntry;
 
enum class EMetaPathUpdateReason : uint8 
{
    PathFinished,
    MoveTick,
};
 
struct FMetaPathWayPoint : public FVector
{
    uint32 UserFlags;
 
    FMetaPathWayPoint()
        : FVector()
        , UserFlags(0)
    {}
 
    FMetaPathWayPoint(const FVector& Location, const uint32 InUserFlags = 0)
        : FVector(Location)
        , UserFlags(InUserFlags)
    {}
};
 
struct FMetaNavMeshPath : public FNavMeshPath
{
    typedef FNavMeshPath Super;
    static AIMODULE_API const FNavPathType Type;
 
    AIMODULE_API FMetaNavMeshPath();
    AIMODULE_API FMetaNavMeshPath(const TArray<FMetaPathWayPoint>& InWaypoints, const ANavigationData& NavData);
    AIMODULE_API FMetaNavMeshPath(const TArray<FMetaPathWayPoint>& InWaypoints, const AController& Owner);
    AIMODULE_API FMetaNavMeshPath(const TArray<FVector>& InWaypoints, const ANavigationData& NavData);
    AIMODULE_API FMetaNavMeshPath(const TArray<FVector>& InWaypoints, const AController& Owner);
 
    AIMODULE_API virtual void Initialize(const FVector& AgentLocation);
 
    AIMODULE_API virtual bool ConditionalMoveToNextSection(const FVector& AgentLocation, EMetaPathUpdateReason Reason);
 
    AIMODULE_API bool ForceMoveToNextSection(const FVector& AgentLocation);
 
    AIMODULE_API virtual bool UpdatePath(const FVector& AgentLocation);
 
    AIMODULE_API virtual void CopyFrom(const FMetaNavMeshPath& Other);
 
    bool IsLastSection() const { return (TargetWaypointIdx == (Waypoints.Num() - 1)) && (Waypoints.Num() > 0); }
 
    int32 GetTargetWaypointIndex() const { return TargetWaypointIdx; }
 
    int32 GetNumWaypoints() const { return Waypoints.Num(); }
 
    const TArray<FMetaPathWayPoint>& GetWaypointArray() const { return Waypoints; }
    
    AActor* GetMetaPathGoal() const { return PathGoal.Get(); }
 
    AIMODULE_API bool SetWaypoints(const TArray<FMetaPathWayPoint>& InWaypoints);
 
    AIMODULE_API bool SetWaypoints(const TArray<FVector>& InWaypoints);
    
    float GetWaypointSwitchRadius() const { return WaypointSwitchRadius; }
 
    void SetWaypointSwitchRadius(float InSwitchRadius) { WaypointSwitchRadius = InSwitchRadius; }
 
    AIMODULE_API virtual FVector::FReal GetLengthFromPosition(FVector SegmentStart, uint32 NextPathPointIndex) const override;
    
    AIMODULE_API virtual FVector::FReal GetCostFromIndex(int32 PathPointIndex) const override;
 
#if ENABLE_VISUAL_LOG
    AIMODULE_API virtual void DescribeSelfToVisLog(FVisualLogEntry* Snapshot) const override;
#endif
    AIMODULE_API virtual void DebugDraw(const ANavigationData* NavData, const FColor PathColor, UCanvas* Canvas, const bool bPersistent, const float LifeTime, const uint32 NextPathPointIndex = 0) const override;
 
protected:
 
    TArray<FMetaPathWayPoint> Waypoints;
 
    FVector::FReal ApproximateLength;
 
    float WaypointSwitchRadius;
 
    int32 TargetWaypointIdx;
 
    TWeakObjectPtr<AActor> PathGoal;
 
    float PathGoalTetherDistance;
 
    AIMODULE_API bool MoveToNextSection(const FVector& AgentLocation);
};