IDeviceProfileSelectorModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    IDeviceProfileSelectorModule.h: Declares the IDeviceProfileSelectorModule interface.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Modules/ModuleInterface.h"
#include "DeviceProfiles/DeviceProfileMatching.h"
 
class UDeviceProfile;
 
class IDeviceProfileSelectorModule
    : public IModuleInterface
{
public:
    IDeviceProfileSelectorModule() :
        ConstrainedAspectRatio(0.0f), 
        SafeZones(FVector4f::Zero())
    {}
    
    virtual const FString GetRuntimeDeviceProfileName() = 0;
 
#if WITH_EDITOR
    virtual void ExportDeviceParametersToJson(FString& FolderLocation){}
    
    virtual bool CanExportDeviceParametersToJson() { return false; }
 
    virtual void GetDeviceParametersFromJson(FString& JsonLocation, TMap<FName, FString>& OutDeviceParameters) {}
    
    virtual float GetConstrainedAspectRatio() { return ConstrainedAspectRatio; }
    
    virtual FVector4f GetSafeZones() { return SafeZones; }
    
    virtual bool CanGetDeviceParametersFromJson() { return false; }
#endif
 
    virtual const FString GetDeviceProfileName() { return FString(); }
 
    virtual void SetSelectorProperties(const TMap<FName, FString>& SelectorProperties) { }
 
    /*
    * Find a custom profile selector property value.
    * @Param PropertyType The information requested
    * @Param PropertyValueOUT the value of PropertyType
    * @return Whether the PropertyType was recognized by the profile selector.
    */
    virtual bool GetSelectorPropertyValue(const FName& PropertyType, FString& PropertyValueOUT) { PropertyValueOUT.Reset(); return false; }
 
    virtual ~IDeviceProfileSelectorModule()
    {
    }
 
protected:
    float ConstrainedAspectRatio;
    FVector4f SafeZones;
};