SkeletalMeshLODSettings.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 "UObject/Object.h"
#include "Engine/EngineTypes.h"
#include "SkeletalMeshReductionSettings.h"
#include "DataAsset.h"
#include "UObject/PerPlatformProperties.h"
#include "PerQualityLevelProperties.h"
#include "SkeletalMeshLODSettings.generated.h"
 
UENUM()
enum class EBoneFilterActionOption : uint8
{
    Remove UMETA(DisplayName = "Remove the joints specified and children"), 
 
    Keep UMETA(DisplayName = "Only keep the joints specified and parents"), 
 
    Invalid UMETA(Hidden), 
};
 
USTRUCT()
struct FBoneFilter
{
    GENERATED_USTRUCT_BODY()
 
    /*
     * Do not include the joint specified
     *
     * This option will work differently based on EBoneFilterActionOption
     * If EBoneFilterActionOption is Remove, it will exclude itself and only remove children
     * For example, if you specify hand, it will only include children of hand(all fingers), 
     * not the hand itself if this is true
     * 
     * But if the EBoneFilterActionOption is Keep, it will exclude itself but include all parents of it 
     * You can't remove joint without children removed, and you can't keep without your parents 
     */
    UPROPERTY(EditAnywhere, Category = FBoneFilter)
    bool bExcludeSelf = false;
 
    /* Name of Bone Name */
    UPROPERTY(EditAnywhere, Category = FBoneFilter)
    FName BoneName;
};
 
USTRUCT()
struct FSkeletalMeshLODGroupSettings
{
    GENERATED_USTRUCT_BODY()
 
    FSkeletalMeshLODGroupSettings()
        : ScreenSize(0.3f)
        , LODHysteresis(0.0f)
        , BoneFilterActionOption(EBoneFilterActionOption::Remove)
        , WeightOfPrioritization(1.f)
        , BakePose(nullptr)
    {}
    
    ENGINE_API FSkeletalMeshOptimizationSettings GetReductionSettings() const;
 
    UE_DEPRECATED(4.20, "Please use GetReductionSettings instead")
    FSkeletalMeshOptimizationSettings GetSettings() const
    {
        return GetReductionSettings();
    }
 
    ENGINE_API const float GetScreenSize() const;
 
    friend class USkeletalMeshLODSettings;
 
    UPROPERTY(EditAnywhere, Category = LODSetting)
    FPerPlatformFloat ScreenSize;
 
    UPROPERTY(EditAnywhere, Category = LODSetting)
    float LODHysteresis;
 
    UPROPERTY(EditAnywhere, Category = Reduction)
    EBoneFilterActionOption BoneFilterActionOption;
 
    UPROPERTY(EditAnywhere, Category = Reduction)
    TArray<FBoneFilter> BoneList;
 
    UPROPERTY(EditAnywhere, Category = Reduction)
    TArray<FName> BonesToPrioritize;
 
    UPROPERTY(EditAnywhere, Category = Reduction)
    TArray<int32> SectionsToPrioritize;
 
    UPROPERTY(EditAnywhere, Category = Reduction, meta = (UIMin = "0.0", ClampMin = "0.0"))
    float WeightOfPrioritization;
 
    UPROPERTY(EditAnywhere, Category = Reduction)
    TObjectPtr<class UAnimSequence> BakePose;
 
    UPROPERTY(EditAnywhere, Category = Reduction)
    FSkeletalMeshOptimizationSettings ReductionSettings;
 
    UPROPERTY(EditAnywhere, Category = LODSetting)
    bool bAllowMeshDeformer = true;
};
 
UCLASS(config = Engine, defaultconfig, BlueprintType, MinimalAPI)
class USkeletalMeshLODSettings : public UDataAsset
{
    GENERATED_UCLASS_BODY()
protected:
    UPROPERTY(globalconfig, EditAnywhere, Category = LODGroups, meta = (DisplayName = "Quality Level Minimum LOD"))
    FPerQualityLevelInt MinQualityLevelLod;
 
    UPROPERTY(globalconfig, EditAnywhere, Category=LODGroups, meta = (DisplayName = "Minimum LOD"))
    FPerPlatformInt MinLod;
 
    UPROPERTY(globalconfig, EditAnywhere, Category = LODGroups)
    FPerPlatformBool DisableBelowMinLodStripping;
 
    UPROPERTY(globalconfig, EditAnywhere, Category=LODGroups)
    bool bOverrideLODStreamingSettings;
 
    UPROPERTY(globalconfig, EditAnywhere, Category=LODGroups, meta=(DisplayName="Stream LODs", EditCondition="bOverrideLODStreamingSettings"))
    FPerPlatformBool bSupportLODStreaming;
 
    UPROPERTY(globalconfig, EditAnywhere, Category=LODGroups, meta=(EditCondition="bOverrideLODStreamingSettings"))
    FPerPlatformInt MaxNumStreamedLODs;
 
    UPROPERTY(globalconfig, EditAnywhere, Category=LODGroups, meta=(EditCondition="bOverrideLODStreamingSettings"))
    FPerPlatformInt MaxNumOptionalLODs;
 
    UPROPERTY(globalconfig, EditAnywhere, Category=LODGroups)
    TArray<FSkeletalMeshLODGroupSettings> LODGroups;
 
    friend class FSkeletalMeshReductionSettingsDetails;
public:
    ENGINE_API const FSkeletalMeshLODGroupSettings& GetSettingsForLODLevel(const int32 LODIndex) const;
 
    const bool HasValidSettings() const
    {
        return LODGroups.Num() > 0;
    }
 
    ENGINE_API int32 GetNumberOfSettings() const;
 
    /*
    * Set InMesh->LODInfo with this LOD Settings for LODIndex
    * return true if succeed
    */
    ENGINE_API bool SetLODSettingsToMesh(USkeletalMesh* InMesh, int32 LODIndex) const;
 
    /*
    * Set InMesh->LODInfo with this LOD Settings
    * return # of settings that are set. Return N for 0-(N-1).
    */
    ENGINE_API int32 SetLODSettingsToMesh(USkeletalMesh* InMesh) const;
    /*
    * Set this LOD Settings from InMesh->LODInfo 
    * return # of settings that are set. Return N for 0-(N-1).
    */
    ENGINE_API int32 SetLODSettingsFromMesh(USkeletalMesh* InMesh);
    
    // BEGIN UObject interface
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif// WITH_EDITOR
    virtual void Serialize(FArchive& Ar) override;
    // END UObject interface
};