NavLinkCustomComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_4
#include "CoreMinimal.h"
#endif
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Engine/EngineTypes.h"
#include "NavAreas/NavArea.h"
#include "AI/Navigation/NavLinkDefinition.h"
#include "AI/Navigation/NavAgentSelector.h"
#include "NavLinkCustomInterface.h"
#include "NavRelevantComponent.h"
#include "NavLinkCustomComponent.generated.h"
 
 
struct FNavigationRelevantData;
 
UCLASS(MinimalAPI)
class UNavLinkCustomComponent : public UNavRelevantComponent, public INavLinkCustomInterface
{
    GENERATED_UCLASS_BODY()
 
    DECLARE_DELEGATE_ThreeParams(FOnMoveReachedLink, UNavLinkCustomComponent* /*ThisComp*/, UObject* /*PathComp*/, const FVector& /*DestPoint*/);
    DECLARE_DELEGATE_TwoParams(FBroadcastFilter, UNavLinkCustomComponent* /*ThisComp*/, TArray<UObject*>& /*NotifyList*/);
 
    // BEGIN INavLinkCustomInterface
    NAVIGATIONSYSTEM_API virtual void GetLinkData(FVector& LeftPt, FVector& RightPt, ENavLinkDirection::Type& Direction) const override;
    NAVIGATIONSYSTEM_API virtual void GetSupportedAgents(FNavAgentSelector& OutSupportedAgents) const override;
    NAVIGATIONSYSTEM_API virtual TSubclassOf<UNavArea> GetLinkAreaClass() const override;
    NAVIGATIONSYSTEM_API virtual FNavLinkAuxiliaryId GetAuxiliaryId() const override;
    NAVIGATIONSYSTEM_API virtual FNavLinkId GetId() const override;
    NAVIGATIONSYSTEM_API virtual void UpdateLinkId(FNavLinkId NewUniqueId) override;
    NAVIGATIONSYSTEM_API virtual bool IsLinkPathfindingAllowed(const UObject* Querier) const override;
    NAVIGATIONSYSTEM_API virtual bool OnLinkMoveStarted(UObject* PathComp, const FVector& DestPoint) override;
    NAVIGATIONSYSTEM_API virtual void OnLinkMoveFinished(UObject* PathComp) override;
    // END INavLinkCustomInterface
 
    //~ Begin UNavRelevantComponent Interface
    NAVIGATIONSYSTEM_API virtual void GetNavigationData(FNavigationRelevantData& Data) const override;
    NAVIGATIONSYSTEM_API virtual void CalcAndCacheBounds() const override;
    //~ End UNavRelevantComponent Interface
 
    //~ Begin UActorComponent Interface
    NAVIGATIONSYSTEM_API virtual void OnRegister() override;
    NAVIGATIONSYSTEM_API virtual void OnUnregister() override;
    NAVIGATIONSYSTEM_API virtual TStructOnScope<FActorComponentInstanceData> GetComponentInstanceData() const override;
    //~ End UActorComponent Interface
 
    NAVIGATIONSYSTEM_API void ApplyComponentInstanceData(struct FNavLinkCustomInstanceData* ComponentInstanceData);
 
    //~ Begin UObject Interface
    NAVIGATIONSYSTEM_API virtual void Serialize(FArchive& Ar) override;
    NAVIGATIONSYSTEM_API virtual void PostLoad() override;
#if WITH_EDITOR
    NAVIGATIONSYSTEM_API virtual void PostEditImport() override;
#endif
    //~ End UObject Interface
 
    NAVIGATIONSYSTEM_API void SetLinkData(const FVector& RelativeStart, const FVector& RelativeEnd, ENavLinkDirection::Type Direction);
    NAVIGATIONSYSTEM_API virtual FNavigationLink GetLinkModifier() const;
 
    NAVIGATIONSYSTEM_API void SetEnabledArea(TSubclassOf<UNavArea> AreaClass);
    TSubclassOf<UNavArea> GetEnabledArea() const { return EnabledAreaClass; }
 
    NAVIGATIONSYSTEM_API void SetDisabledArea(TSubclassOf<UNavArea> AreaClass);
    TSubclassOf<UNavArea> GetDisabledArea() const { return DisabledAreaClass; }
 
    void SetSupportedAgents(const FNavAgentSelector& InSupportedAgents) { SupportedAgents = InSupportedAgents; }
    FNavAgentSelector GetSupportedAgents() const { return SupportedAgents; }
 
    NAVIGATIONSYSTEM_API void AddNavigationObstacle(TSubclassOf<UNavArea> AreaClass, const FVector& BoxExtent, const FVector& BoxOffset = FVector::ZeroVector);
 
    NAVIGATIONSYSTEM_API void ClearNavigationObstacle();
 
    NAVIGATIONSYSTEM_API void SetBroadcastData(float Radius, ECollisionChannel TraceChannel = ECC_Pawn, float Interval = 0.0f);
 
    NAVIGATIONSYSTEM_API void SendBroadcastWhenEnabled(bool bEnabled);
    NAVIGATIONSYSTEM_API void SendBroadcastWhenDisabled(bool bEnabled);
 
    NAVIGATIONSYSTEM_API void SetBroadcastFilter(FBroadcastFilter const& InDelegate);
 
    NAVIGATIONSYSTEM_API void SetEnabled(bool bNewEnabled);
    bool IsEnabled() const { return bLinkEnabled; }
    
    NAVIGATIONSYSTEM_API void SetMoveReachedLink(FOnMoveReachedLink const& InDelegate);
 
    NAVIGATIONSYSTEM_API bool HasMovingAgents() const;
 
    NAVIGATIONSYSTEM_API FVector GetStartPoint() const;
 
    NAVIGATIONSYSTEM_API FVector GetEndPoint() const;
 
    TSubclassOf<UNavArea> GetObstacleAreaClass() const { return ObstacleAreaClass; }
 
    // helper functions for setting delegates
 
    template< class UserClass > 
    inline void SetMoveReachedLink(UserClass* TargetOb, typename FOnMoveReachedLink::TMethodPtr< UserClass > InFunc)
    {
        SetMoveReachedLink(FOnMoveReachedLink::CreateUObject(TargetOb, InFunc));
    }
    template< class UserClass > 
    inline void SetMoveReachedLink(UserClass* TargetOb, typename FOnMoveReachedLink::TConstMethodPtr< UserClass > InFunc)
    {
        SetMoveReachedLink(FOnMoveReachedLink::CreateUObject(TargetOb, InFunc));
    }
 
    template< class UserClass > 
    inline void SetBroadcastFilter(UserClass* TargetOb, typename FBroadcastFilter::TMethodPtr< UserClass > InFunc)
    {
        SetBroadcastFilter(FBroadcastFilter::CreateUObject(TargetOb, InFunc));
    }
    template< class UserClass > 
    inline void SetBroadcastFilter(UserClass* TargetOb, typename FBroadcastFilter::TConstMethodPtr< UserClass > InFunc)
    {
        SetBroadcastFilter(FBroadcastFilter::CreateUObject(TargetOb, InFunc));
    }
 
protected:
#if WITH_EDITOR
    NAVIGATIONSYSTEM_API void OnNavAreaRegistered(const UWorld& World, const UClass* NavAreaClass);
    NAVIGATIONSYSTEM_API void OnNavAreaUnregistered(const UWorld& World, const UClass* NavAreaClass);
#endif // WITH_EDITOR
 
protected:
 
    UE_DEPRECATED(5.3, "LinkIds are now based on FNavLinkId. Use CustomLinkId instead. This Id is no longer used by the engine.")
    UPROPERTY()
    uint32 NavLinkUserId;
 
    UPROPERTY()
    FNavLinkId CustomLinkId;
 
    UPROPERTY()
    FNavLinkAuxiliaryId AuxiliaryCustomLinkId;
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    TSubclassOf<UNavArea> EnabledAreaClass;
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    TSubclassOf<UNavArea> DisabledAreaClass;
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    FNavAgentSelector SupportedAgents;
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    FVector LinkRelativeStart;
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    FVector LinkRelativeEnd;
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    TEnumAsByte<ENavLinkDirection::Type> LinkDirection;
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    uint32 bLinkEnabled : 1;
 
    UPROPERTY(EditAnywhere, Category=Broadcast)
    uint32 bNotifyWhenEnabled : 1;
 
    UPROPERTY(EditAnywhere, Category=Broadcast)
    uint32 bNotifyWhenDisabled : 1;
 
    UPROPERTY(EditAnywhere, Category=Obstacle)
    uint32 bCreateBoxObstacle : 1;
 
    UPROPERTY(EditAnywhere, Category=Obstacle)
    FVector ObstacleOffset;
 
    UPROPERTY(EditAnywhere, Category=Obstacle)
    FVector ObstacleExtent;
 
    UPROPERTY(EditAnywhere, Category=Obstacle)
    TSubclassOf<UNavArea> ObstacleAreaClass;
 
    UPROPERTY(EditAnywhere, Category=Broadcast)
    float BroadcastRadius;
 
    UPROPERTY(EditAnywhere, Category=Broadcast, Meta=(UIMin="0.0", ClampMin="0.0"))
    float BroadcastInterval;
 
    UPROPERTY(EditAnywhere, Category=Broadcast)
    TEnumAsByte<ECollisionChannel> BroadcastChannel;
 
    FBroadcastFilter OnBroadcastFilter;
 
    TArray<TWeakObjectPtr<UObject> > MovingAgents;
 
    FOnMoveReachedLink OnMoveReachedLink;
 
    FTimerHandle TimerHandle_BroadcastStateChange;
 
    NAVIGATIONSYSTEM_API void BroadcastStateChange();
    
    NAVIGATIONSYSTEM_API void CollectNearbyAgents(TArray<UObject*>& NotifyList);
 
#if WITH_EDITOR
    FDelegateHandle OnNavAreaRegisteredDelegateHandle;
    FDelegateHandle OnNavAreaUnregisteredDelegateHandle;
#endif // WITH_EDITOR
};
 
USTRUCT()
struct FNavLinkCustomInstanceData : public FActorComponentInstanceData
{
    GENERATED_BODY()
 
public:
    FNavLinkCustomInstanceData() = default;
    FNavLinkCustomInstanceData(const UNavLinkCustomComponent* SourceComponent)
        : FActorComponentInstanceData(SourceComponent)
    {}
 
    virtual ~FNavLinkCustomInstanceData() = default;
 
    virtual bool ContainsData() const override
    {
        return true;
    }
 
    virtual void ApplyToComponent(UActorComponent* Component, const ECacheApplyPhase CacheApplyPhase) override
    {
        Super::ApplyToComponent(Component, CacheApplyPhase);
 
        if (CacheApplyPhase == ECacheApplyPhase::PostUserConstructionScript)
        {
            CastChecked<UNavLinkCustomComponent>(Component)->ApplyComponentInstanceData(this);
        }
    }
 
    UPROPERTY()
    FNavLinkId CustomLinkId;
 
    UPROPERTY()
    FNavLinkAuxiliaryId AuxiliaryCustomLinkId;
};