InterchangeFilePickerBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "InterchangeTranslatorBase.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
 
#include "InterchangeFilePickerBase.generated.h"
 
USTRUCT(BlueprintType)
struct FInterchangeFilePickerParameters
{
    GENERATED_BODY()
 
    //If true, the user will be able to select multiple files.
    UPROPERTY(EditAnywhere, Category = "Interchange | File Picker")
    bool bAllowMultipleFiles = false;
 
    //If not empty, this will override the default title.
    UPROPERTY(EditAnywhere, Category = "Interchange | File Picker")
    FText Title = FText();
 
    //Set the default open path that the dialog will show to the user.
    UPROPERTY(EditAnywhere, Category = "Interchange | File Picker")
    FString DefaultPath = TEXT("");
 
    //If true, the user will be able to select any unreal editor factory + interchange file types.
    UPROPERTY(EditAnywhere, Category = "Interchange | File Picker")
    bool bShowAllFactoriesExtension = false;
 
    //Add some extension to the picker. Format text item that way TEXT("fbx;Filmbox")
    UPROPERTY(EditAnywhere, Category = "Interchange | File Picker")
    TArray<FString> ExtraFormats;
};
 
UCLASS(Abstract, BlueprintType, Blueprintable, MinimalAPI)
class UInterchangeFilePickerBase : public UObject
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Interchange | Utilities")
    INTERCHANGEENGINE_API bool ScriptedFilePickerForTranslatorAssetType(const EInterchangeTranslatorAssetType TranslatorAssetType, FInterchangeFilePickerParameters& Parameters, TArray<FString>& OutFilenames);
 
    bool ScriptedFilePickerForTranslatorAssetType_Implementation(const EInterchangeTranslatorAssetType TranslatorAssetType, FInterchangeFilePickerParameters& Parameters, TArray<FString>& OutFilenames)
    {
        //By default we call the virtual function FilePickerForTranslatorAssetType
        return FilePickerForTranslatorAssetType(TranslatorAssetType, Parameters, OutFilenames);
    }
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Interchange | Utilities")
    INTERCHANGEENGINE_API bool ScriptedFilePickerForTranslatorType(const EInterchangeTranslatorType TranslatorType, FInterchangeFilePickerParameters& Parameters, TArray<FString>& OutFilenames);
 
    bool ScriptedFilePickerForTranslatorType_Implementation(const EInterchangeTranslatorType TranslatorAssetType, FInterchangeFilePickerParameters& Parameters, TArray<FString>& OutFilenames)
    {
        //By default we call the virtual function FilePickerForTranslatorType
        return FilePickerForTranslatorType(TranslatorAssetType, Parameters, OutFilenames);
    }
 
 
protected:
 
    virtual bool FilePickerForTranslatorAssetType(const EInterchangeTranslatorAssetType TranslatorAssetType, FInterchangeFilePickerParameters& Parameters, TArray<FString>& OutFilenames) { return false; }
 
    virtual bool FilePickerForTranslatorType(const EInterchangeTranslatorType TranslatorType, FInterchangeFilePickerParameters& Parameters, TArray<FString>& OutFilenames) { return false; }
 
};