InterchangeProjectSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Engine/DeveloperSettings.h"
#include "Engine/EngineTypes.h"
#include "InterchangeFilePickerBase.h"
#include "InterchangePipelineBase.h"
#include "InterchangePipelineConfigurationBase.h"
#include "UObject/SoftObjectPath.h"
 
#include "InterchangeProjectSettings.generated.h"
 
#define UE_API INTERCHANGEENGINE_API
 
class UInterchangeSourceData;
 
USTRUCT(BlueprintType)
struct FInterchangeTranslatorPipelines
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "TranslatorPipelines", meta = (AllowedClasses = "/Script/InterchangeCore.InterchangeTranslatorBase"))
    TSoftClassPtr<UInterchangeTranslatorBase> Translator;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "TranslatorPipelines", meta = (AllowedClasses = "/Script/InterchangeCore.InterchangePipelineBase, /Script/InterchangeEngine.InterchangeBlueprintPipelineBase, /Script/InterchangeEngine.InterchangePythonPipelineAsset"))
    TArray<FSoftObjectPath> Pipelines;
};
 
USTRUCT(BlueprintType)
struct FInterchangePipelineStack
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = "Pipelines", meta = (AllowedClasses = "/Script/InterchangeCore.InterchangePipelineBase, /Script/InterchangeEngine.InterchangeBlueprintPipelineBase, /Script/InterchangeEngine.InterchangePythonPipelineAsset"))
    TArray<FSoftObjectPath> Pipelines;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "TranslatorPipelines")
    TArray<FInterchangeTranslatorPipelines> PerTranslatorPipelines;
};
 
USTRUCT(BlueprintType)
struct FInterchangePerTranslatorDialogOverride
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride", meta = (AllowedClasses = "/Script/InterchangeCore.InterchangeTranslatorBase"))
    TSoftClassPtr<UInterchangeTranslatorBase> Translator;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowImportDialog = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowReimportDialog = false;
};
 
USTRUCT(BlueprintType)
struct FInterchangeDialogOverride
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowImportDialog = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowReimportDialog = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    TArray<FInterchangePerTranslatorDialogOverride> PerTranslatorImportDialogOverride;
};
 
USTRUCT(BlueprintType)
struct FInterchangeImportSettings
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Pipeline")
    TMap<FName, FInterchangePipelineStack> PipelineStacks;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Pipeline")
    FName DefaultPipelineStack = NAME_None;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Pipeline")
    TSoftClassPtr <UInterchangePipelineConfigurationBase> ImportDialogClass;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowImportDialog = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowReimportDialog = false;
};
 
USTRUCT(BlueprintType)
struct FInterchangeSceneImportSettings : public FInterchangeImportSettings
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride", Meta=(DisplayAfter="bShowReimportDialog"))
    TArray<FInterchangePerTranslatorDialogOverride> PerTranslatorDialogOverride;
};
 
USTRUCT(BlueprintType)
struct FInterchangeContentImportSettings : public FInterchangeImportSettings
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Pipeline", Meta=(DisplayAfter="DefaultPipelineStack"))
    TMap<EInterchangeTranslatorAssetType, FName> DefaultPipelineStackOverride;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride", Meta=(DisplayAfter="bShowReimportDialog"))
    TMap<EInterchangeTranslatorAssetType, FInterchangeDialogOverride> ShowImportDialogOverride;
};
 
USTRUCT(BlueprintType)
struct FInterchangeGroup
{
    GENERATED_BODY()
 
    enum EUsedGroupStatus : uint8
    {
        NotSet,
        SetAndValid,
        SetAndInvalid
    };
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "InterchangeGroup")
    FName DisplayName;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "InterchangeGroup", meta = (IgnoreForMemberInitializationTest, EditCondition = "false", EditConditionHides))
    FGuid UniqueID = FGuid::NewGuid();
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Pipeline")
    FName DefaultPipelineStack = NAME_None;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Pipeline", Meta = (DisplayAfter = "DefaultPipelineStack"))
    TMap<EInterchangeTranslatorAssetType, FName> DefaultPipelineStackOverride;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowImportDialog = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    bool bShowReimportDialog = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DialogOverride")
    TMap<EInterchangeTranslatorAssetType, FInterchangeDialogOverride> ShowImportDialogOverride;
};
 
UCLASS(config=Engine, BlueprintType, meta=(DisplayName=Interchange), MinimalAPI)
class UInterchangeProjectSettings : public UDeveloperSettings
{
    GENERATED_BODY()
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "ImportContent")
    FInterchangeContentImportSettings ContentImportSettings;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "ImportIntoLevel")
    FInterchangeSceneImportSettings SceneImportSettings;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "EditorInterface")
    TSoftClassPtr <UInterchangeFilePickerBase> FilePickerClass;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "Generic|ImportSettings")
    bool bStaticMeshUseSmoothEdgesIfSmoothingInformationIsMissing = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "Editor Generic Pipeline Class")
    TSoftClassPtr <UInterchangePipelineBase> GenericPipelineClass;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "Converters", meta = (AllowedClasses = "/Script/InterchangeCore.InterchangePipelineBase, /Script/InterchangeEngine.InterchangeBlueprintPipelineBase, /Script/InterchangeEngine.InterchangePythonPipelineAsset"))
    FSoftObjectPath ConverterDefaultPipeline;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "Groups", meta = (NoElementDuplicate))
    TArray<FInterchangeGroup> InterchangeGroups;
 
private:
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
};
 
class FInterchangeProjectSettingsUtils
{
public:
    static INTERCHANGEENGINE_API const FInterchangeImportSettings& GetImportSettings(const UInterchangeProjectSettings& InterchangeProjectSettings, const bool bIsSceneImport);
    static INTERCHANGEENGINE_API FInterchangeImportSettings& GetMutableImportSettings(UInterchangeProjectSettings& InterchangeProjectSettings, const bool bIsSceneImport);
    static INTERCHANGEENGINE_API const FInterchangeImportSettings& GetDefaultImportSettings(const bool bIsSceneImport);
    static INTERCHANGEENGINE_API FInterchangeImportSettings& GetMutableDefaultImportSettings(const bool bIsSceneImport);
 
    static INTERCHANGEENGINE_API FName GetDefaultPipelineStackName(const bool bIsSceneImport, const UInterchangeSourceData& SourceData);
    static INTERCHANGEENGINE_API void SetDefaultPipelineStackName(const bool bIsSceneImport, const UInterchangeSourceData& SourceData, const FName StackName);
 
    static INTERCHANGEENGINE_API bool ShouldShowPipelineStacksConfigurationDialog(const bool bIsSceneImport, const bool bReImport, const UInterchangeSourceData& SourceData);
 
    static INTERCHANGEENGINE_API const FInterchangeGroup& GetUsedGroup(FInterchangeGroup::EUsedGroupStatus& UsedGroupStatus);
 
    static INTERCHANGEENGINE_API TArray<FName> GetGroupNames();
};
 
UCLASS(MinimalAPI)
class UInterchangeProjectSettingsScript : public UObject
{
    GENERATED_BODY()
public:
    UFUNCTION(BlueprintCallable, Category = "Interchange Settings")
    static UE_API TArray<UInterchangePipelineBase*> GetPipelineArrayFromPipelineStack(const FInterchangePipelineStack& InterchangePipelineStack);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange Settings")
    static UE_API TArray<UInterchangePipelineBase*> GetPipelineArrayFromTranslatorPipelines(const FInterchangeTranslatorPipelines& InterchangeTranslatorPipeline);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange Settings")
    static UE_API TArray<UInterchangePipelineBase*> GetPipelineStackFromSourceData(const bool bIsSceneImport, const UInterchangeSourceData* SourceData);
};
 
UCLASS(config = EditorPerProjectUserSettings, BlueprintType, meta = (DisplayName = Interchange), MinimalAPI)
class UInterchangeEditorSettings : public UDeveloperSettings
{
    GENERATED_BODY()
 
public:
    UE_DEPRECATED(5.6, "Use the dialog overrides on the Interchange category of the Project Settings if you want to control when the Interchange reimport dialog is shown")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, config, Category = "Show Dialog", meta=(EditCondition = "false", ToolTip="Use the dialog overrides on the Interchange category of the Project Settings if you want to control when the Interchange reimport dialog is shown"))
    bool bShowImportDialogAtReimport = false;
 
    const FGuid& GetUsedGroupUID() const { return UsedGroupUID; }
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Groups")
    const FName& GetUsedGroupName() const { return UsedGroupName; }
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Groups")
    void SetUsedGroupName(const FName& InUsedGroupName);
 
    void UpdateUsedGroupName();
 
private:
    UPROPERTY(EditAnywhere, Transient, Category = "Group Used", meta = (GetOptions = "GetSelectableItems", AllowPrivateAccess = "true"))
    FName UsedGroupName;
 
    UPROPERTY(EditAnywhere, Category = "Group Used", config, meta = (IgnoreForMemberInitializationTest, EditCondition = "false", EditConditionHides))
    FGuid UsedGroupUID;
 
    UFUNCTION()
    TArray<FName> GetSelectableItems() const;
 
    void UpdateUsedGroupUIDFromGroupName();
 
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual void PostInitProperties() override;
#endif
};
 
#undef UE_API