NavModifierComponent.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 "NavAreas/NavArea.h"
#include "NavRelevantComponent.h"
#include "NavModifierComponent.generated.h"
 
struct FNavigationRelevantData;
class UBodySetup;
enum class ENavigationDataResolution : uint8;
 
UCLASS(ClassGroup = (Navigation), meta = (BlueprintSpawnableComponent), hidecategories = (Activation), config = Engine, defaultconfig, MinimalAPI)
class UNavModifierComponent : public UNavRelevantComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Navigation)
    TSubclassOf<UNavArea> AreaClass;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Navigation)
    TSubclassOf<UNavArea> AreaClassToReplace;
 
    UPROPERTY(EditAnywhere, Category = Navigation)
    FVector FailsafeExtent;
 
    UPROPERTY(EditAnywhere, Category = Navigation, AdvancedDisplay)
    ENavigationDataResolution NavMeshResolution;
 
    UPROPERTY(config, EditAnywhere, Category = Navigation)
    uint8 bIncludeAgentHeight : 1;
 
 
    // Does the actual calculating and caching of the bounds when called by CalcAndCacheBounds
    NAVIGATIONSYSTEM_API virtual void CalculateBounds() const;
    // @Note We might make this function non-virtual in the future in favor of child classes overriding CalculateBounds, see #jira UE-202451
    NAVIGATIONSYSTEM_API virtual void CalcAndCacheBounds() const override;
    NAVIGATIONSYSTEM_API virtual void GetNavigationData(FNavigationRelevantData& Data) const override;
 
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation")
    NAVIGATIONSYSTEM_API void SetAreaClass(TSubclassOf<UNavArea> NewAreaClass);
    UFUNCTION(BlueprintCallable, Category = "AI|Navigation")
    NAVIGATIONSYSTEM_API void SetAreaClassToReplace(TSubclassOf<UNavArea> NewAreaClassToReplace);
 
protected:
    NAVIGATIONSYSTEM_API void OnTransformUpdated(USceneComponent* RootComponent, EUpdateTransformFlags UpdateTransformFlags, ETeleportType Teleport);
 
#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 
 
    //~ Begin UActorComponent Interface
    NAVIGATIONSYSTEM_API virtual void OnRegister() override;
    NAVIGATIONSYSTEM_API virtual void OnUnregister() override;
    //~ End UActorComponent Interface
 
    NAVIGATIONSYSTEM_API void PopulateComponentBounds(FTransform InParentTransform, const UBodySetup& InBodySetup) const;
    
    struct FRotatedBox
    {
        FBox Box;
        FQuat Quat;
 
        FRotatedBox() {}
        FRotatedBox(const FBox& InBox, const FQuat& InQuat) : Box(InBox), Quat(InQuat) {}
    };
 
    mutable TArray<FRotatedBox> ComponentBounds;
    mutable FDelegateHandle TransformUpdateHandle;
    mutable FTransform CachedTransform;
 
#if WITH_EDITOR
    FDelegateHandle OnNavAreaRegisteredDelegateHandle;
    FDelegateHandle OnNavAreaUnregisteredDelegateHandle;
#endif // WITH_EDITOR 
};