NavLinkProxy.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "GameFramework/Actor.h"
#include "EngineDefines.h"
#include "AI/Navigation/NavRelevantInterface.h"
#include "AI/Navigation/NavLinkDefinition.h"
#include "NavLinkHostInterface.h"
#include "NavLinkProxy.generated.h"
 
class UBillboardComponent;
class UNavLinkCustomComponent;
class UNavLinkRenderingComponent;
class UPathFollowingComponent;
struct FNavigationRelevantData;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams( FSmartLinkReachedSignature, AActor*, MovingActor, const FVector&, DestinationPoint );
 
UCLASS(Blueprintable, autoCollapseCategories=(SmartLink, Actor), hideCategories=(Input), MinimalAPI)
class ANavLinkProxy : public AActor, public INavLinkHostInterface, public INavRelevantInterface
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=SimpleLink)
    TArray<FNavigationLink> PointLinks;
    
    UPROPERTY()
    TArray<FNavigationSegmentLink> SegmentLinks;
 
private:
    UPROPERTY(VisibleAnywhere, Category=SmartLink)
    TObjectPtr<UNavLinkCustomComponent> SmartLinkComp;
public:
 
    UPROPERTY(EditAnywhere, Category=SmartLink)
    bool bSmartLinkIsRelevant;
 
#if WITH_EDITORONLY_DATA
private:
    UPROPERTY()
    TObjectPtr<UNavLinkRenderingComponent> EdRenderComp;
 
    UPROPERTY()
    TObjectPtr<UBillboardComponent> SpriteComponent;
public:
#endif // WITH_EDITORONLY_DATA
 
    // BEGIN INavRelevantInterface
    AIMODULE_API virtual void GetNavigationData(FNavigationRelevantData& Data) const override;
    AIMODULE_API virtual FBox GetNavigationBounds() const override;
    AIMODULE_API virtual bool IsNavigationRelevant() const override;
    // END INavRelevantInterface
 
    // BEGIN INavLinkHostInterface
    AIMODULE_API virtual bool GetNavigationLinksClasses(TArray<TSubclassOf<UNavLinkDefinition> >& OutClasses) const override;
    AIMODULE_API virtual bool GetNavigationLinksArray(TArray<FNavigationLink>& OutLink, TArray<FNavigationSegmentLink>& OutSegments) const override;
    // END INavLinkHostInterface
 
#if WITH_EDITOR
    AIMODULE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    AIMODULE_API virtual void PostEditUndo() override;
    AIMODULE_API virtual void PostEditImport() override;
#endif // WITH_EDITOR
    AIMODULE_API virtual void PostInitProperties() override;
    AIMODULE_API virtual void BeginDestroy() override;
 
    AIMODULE_API virtual void PostRegisterAllComponents() override;
    AIMODULE_API virtual void PostLoad() override;
 
#if ENABLE_VISUAL_LOG
protected:
    AIMODULE_API virtual void BeginPlay() override;
public:
#endif // ENABLE_VISUAL_LOG
 
    AIMODULE_API virtual FBox GetComponentsBoundingBox(bool bNonColliding = false, bool bIncludeFromChildActors = false) const override;
 
    // Blueprint interface for smart links
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveSmartLinkReached(AActor* Agent, const FVector& Destination);
 
    UFUNCTION(BlueprintCallable, Category="AI|Navigation")
    AIMODULE_API void ResumePathFollowing(AActor* Agent);
 
    UFUNCTION(BlueprintCallable, Category="AI|Navigation")
    AIMODULE_API bool IsSmartLinkEnabled() const;
 
    UFUNCTION(BlueprintCallable, Category="AI|Navigation")
    AIMODULE_API void SetSmartLinkEnabled(bool bEnabled);
 
    UFUNCTION(BlueprintCallable, Category="AI|Navigation")
    AIMODULE_API bool HasMovingAgents() const;
 
#if WITH_EDITOR
    UFUNCTION(CallInEditor, Category = SmartLink, meta = (DisplayName="CopyEndPointsFromSimpleLink"))
    AIMODULE_API void CopyEndPointsFromSimpleLinkToSmartLink();
#endif // WITH_EDITOR
 
protected:
 
    UPROPERTY(BlueprintAssignable)
    FSmartLinkReachedSignature OnSmartLinkReached;
 
    AIMODULE_API void NotifySmartLinkReached(UNavLinkCustomComponent* LinkComp, UObject* PathingAgent, const FVector& DestPoint);
 
#if WITH_EDITOR
    AIMODULE_API void OnNavAreaRegistered(const UWorld& World, const UClass* NavAreaClass);
    AIMODULE_API void OnNavAreaUnregistered(const UWorld& World, const UClass* NavAreaClass);
#endif // WITH_EDITOR
 
public:
    UNavLinkCustomComponent* GetSmartLinkComp() const { return SmartLinkComp; }
#if WITH_EDITORONLY_DATA
    UNavLinkRenderingComponent* GetEdRenderComp() const { return EdRenderComp; }
    UBillboardComponent* GetSpriteComponent() const { return SpriteComponent; }
#endif
 
protected:
#if WITH_EDITOR
    FDelegateHandle OnNavAreaRegisteredDelegateHandle;
    FDelegateHandle OnNavAreaUnregisteredDelegateHandle;
#endif // WITH_EDITOR
};