WorldPartitionStreamingSourceComponent.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 "Components/ActorComponent.h"
#include "WorldPartition/WorldPartitionStreamingSource.h"
#include "WorldPartition/HLOD/HLODLayer.h"
#include "WorldPartitionStreamingSourceComponent.generated.h"
 
class FSceneView;
class FPrimitiveDrawInterface;
 
UCLASS(Meta = (BlueprintSpawnableComponent), HideCategories = (Tags, Sockets, ComponentTick, ComponentReplication, Activation, Cooking, Events, AssetUserData, Collision, Navigation), MinimalAPI)
class UWorldPartitionStreamingSourceComponent : public UActorComponent, public IWorldPartitionStreamingSourceProvider
{
    GENERATED_UCLASS_BODY()
 
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void OnUnregister() override;
 
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    ENGINE_API virtual void PostLoad() override;
 
    UFUNCTION(BlueprintCallable, Category = "Streaming")
    void EnableStreamingSource() { bStreamingSourceEnabled = true; }
 
    UFUNCTION(BlueprintCallable, Category = "Streaming")
    void DisableStreamingSource() { bStreamingSourceEnabled = false; }
 
    UFUNCTION(BlueprintPure, Category = "Streaming")
    bool IsStreamingSourceEnabled() const { return bStreamingSourceEnabled; }
 
    // IWorldPartitionStreamingSourceProvider interface
    ENGINE_API virtual bool GetStreamingSource(FWorldPartitionStreamingSource& OutStreamingSource) const override;
    virtual const UObject* GetStreamingSourceOwner() const override { return this; }
 
    UFUNCTION(BlueprintCallable, Category = "Streaming")
    ENGINE_API bool IsStreamingCompleted() const;
 
    ENGINE_API void DrawVisualization(const FSceneView* View, FPrimitiveDrawInterface* PDI) const;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category = "Debug")
    float DefaultVisualizerLoadingRange;
#endif
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Streaming")
    EStreamingSourceTargetBehavior TargetBehavior;
            
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Streaming")
    TArray<FName> TargetGrids;
 
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "Use TargetGrids instead."))
    FName TargetGrid_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category = "Streaming")
    FColor DebugColor;
 
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "Use TargetGrids instead."))
    TArray<TObjectPtr<const UHLODLayer>> TargetHLODLayers_DEPRECATED;
 
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "Use TargetHLODLayers instead."))
    TObjectPtr<const UHLODLayer> TargetHLODLayer_DEPRECATED;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Streaming")
    TArray<FStreamingSourceShape> Shapes;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Streaming")
    EStreamingSourcePriority Priority;
 
private:
    UPROPERTY(EditAnywhere, Interp, Category = "Streaming")
    bool bStreamingSourceEnabled;
 
    UPROPERTY(EditAnywhere, Category = "Streaming")
    EStreamingSourceTargetState TargetState;
};