SkeletalMeshReductionSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    SkeletalMeshReductionSettings.h: Skeletal Mesh Reduction Settings
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "BoneContainer.h"
#include "SkeletalMeshReductionSettings.generated.h"
 
class FSkeletalMeshLODModel;
 
UENUM()
enum SkeletalMeshTerminationCriterion : int
{
    SMTC_NumOfTriangles UMETA(DisplayName = "Triangles", ToolTip = "Triangle count criterion will be used for simplification."),
    SMTC_NumOfVerts UMETA(DisplayName = "Vertices", ToolTip = "Vertex cont criterion will be used for simplification."),
    SMTC_TriangleOrVert UMETA(DisplayName = "First Percent Satisfied", ToolTip = "Simplification will continue until either Triangle or Vertex count criteria is met."),
    SMTC_AbsNumOfTriangles UMETA(DisplayName = "Max Triangles", ToolTip = "Triangle count criterion will be used for simplification."),
    SMTC_AbsNumOfVerts UMETA(DisplayName = "Max Vertices", ToolTip = "Vertex cont criterion will be used for simplification."),
    SMTC_AbsTriangleOrVert UMETA(DisplayName = "First Max Satisfied", ToolTip = "Simplification will continue until either Triangle or Vertex count criteria is met."),
    SMTC_MAX UMETA(Hidden),
};
 
UENUM()
enum SkeletalMeshOptimizationType : int
{
    SMOT_NumOfTriangles UMETA(DisplayName = "Triangles", ToolTip = "Triangle requirement will be used for simplification."),
    SMOT_MaxDeviation UMETA(DisplayName = "Accuracy", ToolTip = "Accuracy requirement will be used for simplification."),
    SMOT_TriangleOrDeviation UMETA(DisplayName = "Any", ToolTip = "Simplification will continue until either Triangle or Accuracy requirement is met."),
    SMOT_MAX UMETA(Hidden),
};
 
UENUM()
enum SkeletalMeshOptimizationImportance : int
{
    SMOI_Off UMETA(DisplayName = "Off"),
    SMOI_Lowest UMETA(DisplayName = "Lowest"),
    SMOI_Low UMETA(DisplayName = "Low"),
    SMOI_Normal UMETA(DisplayName = "Normal"),
    SMOI_High UMETA(DisplayName = "High"),
    SMOI_Highest UMETA(DisplayName = "Highest"),
    SMOI_MAX UMETA(Hidden)
};
 
DECLARE_DELEGATE_OneParam(FOnDeleteLODModelOverride, FSkeletalMeshLODModel*);
 
USTRUCT()
struct FSkeletalMeshOptimizationSettings
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = ReductionMethod)
    TEnumAsByte<enum SkeletalMeshTerminationCriterion> TerminationCriterion;
 
    UPROPERTY(EditAnywhere, Category = ReductionMethod, meta = (DisplayName = "Percent of Triangles"))
    float NumOfTrianglesPercentage;
 
    UPROPERTY(EditAnywhere, Category = ReductionMethod, meta = (DisplayName = "Percent of Vertices"))
    float NumOfVertPercentage;
    
    UPROPERTY(EditAnywhere, Category = ReductionMethod, meta = (DisplayName = "Max Triangle Count", ClampMin = 4))
    uint32 MaxNumOfTriangles;
 
    UPROPERTY(EditAnywhere, Category = ReductionMethod, meta = (DisplayName = "Max Vertex Count", ClampMin = 6))
    uint32 MaxNumOfVerts;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category = ReductionMethod, meta = (DisplayName = "Max Triangle Count", ClampMin = 4, UIMin = "4"))
    uint32 MaxNumOfTrianglesPercentage;
 
    UPROPERTY(EditAnywhere, Category = ReductionMethod, meta = (DisplayName = "Max Vertex Count", ClampMin = 6, UIMin = "6"))
    uint32 MaxNumOfVertsPercentage;
#endif
 
    UPROPERTY(EditAnywhere, Category = ReductionMethod)
    float MaxDeviationPercentage;
 
    UPROPERTY(EditAnywhere, Category = ReductionMethod)
    TEnumAsByte<enum SkeletalMeshOptimizationType> ReductionMethod;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Silhouette"))
    TEnumAsByte<enum SkeletalMeshOptimizationImportance> SilhouetteImportance;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Texture"))
    TEnumAsByte<enum SkeletalMeshOptimizationImportance> TextureImportance;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Shading"))
    TEnumAsByte<enum SkeletalMeshOptimizationImportance> ShadingImportance;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Skinning"))
    TEnumAsByte<enum SkeletalMeshOptimizationImportance> SkinningImportance;
 
    /* Remap the morph targets from the base LOD onto the reduce LOD. */
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings)
    uint8 bRemapMorphTargets:1;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Recompute Normal"))
    uint8 bRecalcNormals:1;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings)
    float WeldingThreshold;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Hard Edge Angle", EditCondition = "bRecalcNormals"))
    float NormalsThreshold;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Max Bones Influence", ClampMin = 1))
    int32 MaxBonesPerVertex;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Enforce Bone Boundaries"))
    uint8 bEnforceBoneBoundaries : 1;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Merge Coincident Vertices Bones"))
    uint8 bMergeCoincidentVertBones : 1;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Volumetric Correction", ClampMin = 0, ClampMax = 2))
    float VolumeImportance;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Lock Mesh Edges"))
    uint8 bLockEdges : 1;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings, meta = (DisplayName = "Lock Vertex Color Boundaries"))
    uint8 bLockColorBounaries : 1;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings)
    uint8 bImproveTrianglesForCloth : 1;
 
    UPROPERTY(EditAnywhere, Category = FSkeletalMeshOptimizationSettings)
    int32 BaseLOD;
 
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TArray<FBoneReference> BonesToRemove_DEPRECATED;
 
    UPROPERTY()
    TObjectPtr<class UAnimSequence> BakePose_DEPRECATED;
 
    //Transient mutable delegate. If the delegate is bound, the reduction will call it instead of deleting the replaced LODModel. It will be then the delegate owner responsible of the LODModel memory
    mutable FOnDeleteLODModelOverride OnDeleteLODModelDelegate;
#endif
 
    FSkeletalMeshOptimizationSettings()
        : TerminationCriterion(SMTC_NumOfTriangles)
        , NumOfTrianglesPercentage(0.5f)
        , NumOfVertPercentage(0.5f)
        , MaxNumOfTriangles(4)
        , MaxNumOfVerts(6)
#if WITH_EDITORONLY_DATA        
        , MaxNumOfTrianglesPercentage(MAX_uint32)
        , MaxNumOfVertsPercentage(MAX_uint32)
#endif
        , MaxDeviationPercentage(0.5f)
        , ReductionMethod(SMOT_NumOfTriangles)
        , SilhouetteImportance(SMOI_Normal)
        , TextureImportance(SMOI_Normal)
        , ShadingImportance(SMOI_Normal)
        , SkinningImportance(SMOI_Normal)
        , bRemapMorphTargets(false)
        , bRecalcNormals(true)
        , WeldingThreshold(0.1f)
        , NormalsThreshold(60.0f)
        , MaxBonesPerVertex(4)
        , bEnforceBoneBoundaries(false)
        , bMergeCoincidentVertBones(true)
        , VolumeImportance(1.f)
        , bLockEdges(false)
        , bLockColorBounaries(false)
        , bImproveTrianglesForCloth(true)
        , BaseLOD(0)
#if WITH_EDITORONLY_DATA
        , BakePose_DEPRECATED(nullptr)
#endif
    {
    }
};