MeshApproximationSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Engine/MaterialMerging.h"
#include "MeshApproximationSettings.generated.h"
 
 
UENUM()
enum class EMeshApproximationType : uint8
{
    MeshAndMaterials,
    MeshShapeOnly
};
 
UENUM()
enum class EMeshApproximationBaseCappingType : uint8
{
    NoBaseCapping = 0,
    ConvexPolygon = 1,
    ConvexSolid = 2
};
 
 
UENUM()
enum class EOccludedGeometryFilteringPolicy : uint8
{
    NoOcclusionFiltering = 0,
    VisibilityBasedFiltering = 1
};
 
UENUM()
enum class EMeshApproximationSimplificationPolicy : uint8
{
    FixedTriangleCount = 0,
    TrianglesPerArea = 1,
    GeometricTolerance = 2
};
 
UENUM()
enum class EMeshApproximationGroundPlaneClippingPolicy : uint8
{
    NoGroundClipping = 0,
    DiscardWithZPlane = 1,
    CutWithZPlane = 2,
    CutAndFillWithZPlane = 3
};
 
 
UENUM()
enum class EMeshApproximationUVGenerationPolicy : uint8
{
    PreferUVAtlas = 0,
    PreferXAtlas = 1,
    PreferPatchBuilder = 2
};
 
 
USTRUCT(Blueprintable)
struct FMeshApproximationSettings
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings)
    EMeshApproximationType OutputType = EMeshApproximationType::MeshAndMaterials;
 
 
    //
    // Mesh Generation Settings
    //
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings, meta = (DisplayName = "Approximation Accuracy (meters)", ClampMin = "0.001"))
    float ApproximationAccuracy = 1.0f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, AdvancedDisplay, Category = ShapeSettings, meta = (ClampMin = "64", ClampMax = "1290"))
    int32 ClampVoxelDimension = 1024;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings)
    bool bAttemptAutoThickening = true;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings, meta = (ClampMin = "0.001", EditCondition = "bAttemptAutoThickening"))
    float TargetMinThicknessMultiplier = 1.5f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings)
    bool bIgnoreTinyParts = true;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings, meta = (ClampMin = "0.001", EditCondition = "bIgnoreTinyParts"))
    float TinyPartSizeMultiplier = 0.05f;
 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings)
    EMeshApproximationBaseCappingType BaseCapping = EMeshApproximationBaseCappingType::NoBaseCapping;
 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, AdvancedDisplay, Category = ShapeSettings, meta = (ClampMin = "0.01", ClampMax = "0.99"))
    float WindingThreshold = 0.5f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings)
    bool bFillGaps = true;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = ShapeSettings, meta = (DisplayName = "Gap Filling Distance (meters)", ClampMin = "0.001", EditCondition = "bFillGaps"))
    float GapDistance = 0.1f;
 
 
    //
    // Output Mesh Filtering and Simplification Settings
    //
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings)
    EOccludedGeometryFilteringPolicy OcclusionMethod = EOccludedGeometryFilteringPolicy::VisibilityBasedFiltering;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings)
    bool bOccludeFromBottom = true;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings)
    EMeshApproximationSimplificationPolicy SimplifyMethod = EMeshApproximationSimplificationPolicy::GeometricTolerance;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings, meta = (ClampMin = "16", EditCondition = "SimplifyMethod == EMeshApproximationSimplificationPolicy::FixedTriangleCount" ))
    int32 TargetTriCount = 2000;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings, meta = (ClampMin = "0.01", EditCondition = "SimplifyMethod == EMeshApproximationSimplificationPolicy::TrianglesPerArea" ))
    float TrianglesPerM = 2.0f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings, meta = (DisplayName = "Geometric Deviation (meters)", ClampMin = "0.0001", EditCondition = "SimplifyMethod == EMeshApproximationSimplificationPolicy::GeometricTolerance"))
    float GeometricDeviation = 0.1f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings)
    EMeshApproximationGroundPlaneClippingPolicy GroundClipping = EMeshApproximationGroundPlaneClippingPolicy::NoGroundClipping;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SimplifySettings, meta = (EditCondition = "GroundClipping != EMeshApproximationGroundPlaneClippingPolicy::NoGroundClipping"))
    float GroundClippingZHeight = 0.0f;
 
 
    //
    // Mesh Normals and Tangents Settings
    //
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = NormalsSettings)
    bool bEstimateHardNormals = true;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = NormalsSettings, meta = (ClampMin = "0.0", ClampMax = "90.0", EditCondition = "bEstimateHardNormals"))
    float HardNormalAngle = 60.0f;
 
 
    //
    // Mesh UV Generation Settings
    //
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = UVSettings)
    EMeshApproximationUVGenerationPolicy UVGenerationMethod = EMeshApproximationUVGenerationPolicy::PreferXAtlas;
 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = UVSettings, AdvancedDisplay, meta = (UIMin = "1", UIMax = "1000", ClampMin = "1", ClampMax = "99999999", EditCondition = "UVGenerationMethod == EMeshApproximationUVGenerationPolicy::PreferPatchBuilder"))
    int InitialPatchCount = 250;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = UVSettings, AdvancedDisplay, meta = (UIMin = "0.1", UIMax = "2.0", ClampMin = "0.01", ClampMax = "100.0", EditCondition = "UVGenerationMethod == EMeshApproximationUVGenerationPolicy::PreferPatchBuilder"))
    float CurvatureAlignment = 1.0f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = UVSettings, AdvancedDisplay, meta = (UIMin = "1.0", UIMax = "5.0", ClampMin = "1.0", EditCondition = "UVGenerationMethod == EMeshApproximationUVGenerationPolicy::PreferPatchBuilder"))
    float MergingThreshold = 1.5f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = UVSettings, AdvancedDisplay, meta = (UIMin = "0.0", UIMax = "90.0", ClampMin = "0.0", ClampMax = "180.0", EditCondition = "UVGenerationMethod == EMeshApproximationUVGenerationPolicy::PreferPatchBuilder"))
    float MaxAngleDeviation = 45.0f;
 
    //
    // Output Static Mesh Settings
    //
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = MeshSettings)
    bool bGenerateNaniteEnabledMesh = false;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, AdvancedDisplay, Category = MeshSettings, meta = (EditConditionHides, EditCondition = "bGenerateNaniteEnabledMesh"))
    ENaniteFallbackTarget NaniteFallbackTarget = ENaniteFallbackTarget::Auto;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, AdvancedDisplay, Category = MeshSettings, meta = (EditConditionHides, EditCondition = "bGenerateNaniteEnabledMesh && NaniteFallbackTarget == ENaniteFallbackTarget::PercentTriangles", ClampMin = 0, ClampMax = 1))
    float NaniteFallbackPercentTriangles = 1.0f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, AdvancedDisplay, Category = MeshSettings, meta = (EditConditionHides, EditCondition = "bGenerateNaniteEnabledMesh && NaniteFallbackTarget == ENaniteFallbackTarget::RelativeError", ClampMin = 0))
    float NaniteFallbackRelativeError = 1.0f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = MeshSettings)
    bool bSupportRayTracing = true;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = MeshSettings)
    bool bAllowDistanceField = true;
 
 
    //
    // Material Baking Settings
    //
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = MaterialSettings, meta = (ClampMin = "0", ClampMax = "8", UIMin = "0", UIMax = "4"))
    int32 MultiSamplingAA = 0;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = MaterialSettings, meta = (ClampMin = "0"))
    int32 RenderCaptureResolution = 2048;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = MaterialSettings)
    FMaterialProxySettings MaterialSettings;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, AdvancedDisplay, Category = MaterialSettings, meta = (ClampMin = "5.0", ClampMax = "160.0"))
    float CaptureFieldOfView = 30.0f;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, AdvancedDisplay, Category = MaterialSettings, meta = (ClampMin = "0.001", ClampMax = "1000.0"))
    float NearPlaneDist = 1.0f;
 
 
    //
    // Performance Settings
    //
 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = PerformanceSettings)
    bool bUseRenderLODMeshes = false;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = PerformanceSettings)
    bool bEnableSimplifyPrePass = true;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = PerformanceSettings)
    bool bEnableParallelBaking = true;
 
    //
    // Debug Output Settings
    //
 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = DebugSettings)
    bool bPrintDebugMessages = false;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = DebugSettings)
    bool bEmitFullDebugMesh = false;
    
 
    ENGINE_API bool operator==(const FMeshApproximationSettings& Other) const;
 
    ENGINE_API bool operator!=(const FMeshApproximationSettings& Other) const;
 
#if WITH_EDITORONLY_DATA
    void PostSerialize(const FArchive& Ar);
#endif
 
private:
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    float NaniteProxyTrianglePercent_DEPRECATED = 0;
#endif
};
 
template<>
struct TStructOpsTypeTraits<FMeshApproximationSettings> : public TStructOpsTypeTraitsBase2<FMeshApproximationSettings>
{
#if WITH_EDITORONLY_DATA
    enum
    {
        WithPostSerialize = true,
    };
#endif
};