LODSyncComponent.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 "InputCoreTypes.h"
#include "Components/ActorComponent.h"
#include "Framework/Commands/InputChord.h"
#include "LODSyncComponent.generated.h"
 
USTRUCT(BlueprintType)
struct FLODMappingData
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = FLODMappingData)
    TArray<int32> Mapping;
 
    UPROPERTY(transient)
    TArray<int32> InverseMapping;
};
 
UENUM(BlueprintType)
enum class ESyncOption : uint8
{
    Drive,
    Passive,
    Disabled, 
};
 
USTRUCT(BlueprintType)
struct FComponentSync
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = FComponentSync)
    FName Name;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = FComponentSync)
    ESyncOption SyncOption;
 
    FComponentSync()
    : SyncOption(ESyncOption::Drive)
    {}
 
    FComponentSync(const FName& InName, ESyncOption InSyncOption)
        : Name (InName)
        , SyncOption(InSyncOption)
    {}
};
UCLASS(Blueprintable, ClassGroup = Component, BlueprintType, meta = (BlueprintSpawnableComponent), MinimalAPI)
class ULODSyncComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
 
    // if -1, it's default and it will calculate the max number of LODs from all sub components
    // if not, it is a number of LODs (not the max index of LODs)
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = LOD, meta=(ScriptName="NumLods;NumLODs"))
    int32 NumLODs = -1;
 
    // if -1, it's automatically switching
    UPROPERTY(EditAnywhere, BlueprintReadWrite, interp, Category = LOD)
    int32 ForcedLOD = -1;
 
    // Minimum LOD to use when syncing components
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = LOD)
    int32 MinLOD = 0;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = LOD)
    TArray<FComponentSync> ComponentsToSync;
 
    // by default, the mapping will be one to one
    // but if you want custom, add here. 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = LOD)
    TMap<FName, FLODMappingData> CustomLODMapping;
 
    UFUNCTION(BlueprintCallable, Category = "Components|SkeletalMesh")
    ENGINE_API FString GetLODSyncDebugText() const;
 
private:
    UPROPERTY(transient)
    int32 CurrentLOD = 0;
 
    // num of LODs
    UPROPERTY(transient)
    int32 CurrentNumLODs = 0;
 
    // component that drives the LOD
    UPROPERTY(transient)
    TArray<TObjectPtr<UPrimitiveComponent>> DriveComponents;
 
    // all the components that ticks
    UPROPERTY(transient)
    TArray<TObjectPtr<UPrimitiveComponent>> SubComponents;
 
    // BEGIN AActorComponent interface
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void OnUnregister() override;
    ENGINE_API virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    // END AActorComponent interface
 
public: 
    ENGINE_API void RefreshSyncComponents();
    
    ENGINE_API void UpdateLOD();
 
private:
    int32 GetCustomMappingLOD(const FName& ComponentName, int32 CurrentWorkingLOD) const;
    int32 GetSyncMappingLOD(const FName& ComponentName, int32 CurrentSourceLOD) const;
    void InitializeSyncComponents();
    void UninitializeSyncComponents();
    const FComponentSync* GetComponentSync(const FName& InName) const;
};