SplineNavModifierComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "NavModifierComponent.h"
 
#include "SplineNavModifierComponent.generated.h"
 
#define INVALID_SPLINE_VERSION MIN_int32
 
struct FNavigationRelevantData;
 
UENUM()
enum class ESubdivisionLOD
{
    Low,
    Medium,
    High,
    Ultra,
};
 
UCLASS(Blueprintable, MinimalAPI, Meta = (BlueprintSpawnableComponent), hidecategories = (Variable, Tags, Cooking, Collision))
class USplineNavModifierComponent : public UNavModifierComponent
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Navigation)
    bool bUpdateNavDataOnSplineChange = true;
 
    UPROPERTY(EditAnywhere, Category = Navigation, Meta = (UseComponentPicker, AllowedClasses = "/Script/Engine.SplineComponent", DisplayName = "Nav Modifier Spline"))
    FComponentReference AttachedSpline;
 
    UPROPERTY(EditAnywhere, Category = Navigation, Meta=(UIMin="10", ClampMin="10"))
    double StrokeWidth = 500.0f;
 
    UPROPERTY(EditAnywhere, Category = Navigation, Meta=(UIMin="10", ClampMin="10"))
    double StrokeHeight = 500.0f;
 
    UPROPERTY(EditAnywhere, Category = Navigation)
    ESubdivisionLOD SubdivisionLOD = ESubdivisionLOD::Medium;
 
    USplineNavModifierComponent(const FObjectInitializer& ObjectInitializer);
 
    UFUNCTION(CallInEditor, Category = Navigation, Meta=(DisplayName="UpdateNavigationData"))
    void UpdateNavigationWithComponentData();
 
protected:
#if WITH_EDITORONLY_DATA
    virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    virtual bool IsComponentTickEnabled() const override;
#endif // WITH_EDITORONLY_DATA
 
    virtual void CalculateBounds() const override;
    virtual void GetNavigationData(FNavigationRelevantData& Data) const override;
 
    float GetSubdivisionThreshold() const;
 
private:
#if WITH_EDITORONLY_DATA
    // Used to check against attached spline's version each tick for changes
    uint32 SplineVersion = INVALID_SPLINE_VERSION;
#endif // WITH_EDITORONLY_DATA
 
    // Used for bounds calculation and to check against attached spline's transform each tick for changes
    FTransform SplineTransform = FTransform();
};