DeviceProfileManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    DeviceProfileManager.h: Declares the FDeviceProfileManager class.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "DeviceProfileMatching.h"
#include "CoreGlobals.h"
#include "HAL/IConsoleManager.h"
#include "DeviceProfileManager.generated.h"
 
class UDeviceProfile;
 
// Delegate used to refresh the UI when the profiles change
DECLARE_MULTICAST_DELEGATE( FOnDeviceProfileManagerUpdated );
 
// Delegate used to notify systems when the active device profile changes
DECLARE_MULTICAST_DELEGATE( FOnActiveDeviceProfileChanged );
 
#if ALLOW_OTHER_PLATFORM_CONFIG
// Delegate used to notify systems when the preview device profile changes
DECLARE_MULTICAST_DELEGATE( FOnPreviewDeviceProfileChanged );
#endif
 
// Delegate used to notify systems pre reapply device profiles
DECLARE_MULTICAST_DELEGATE( FWillReapplyDeviceProfiles );
// Delegate used to notify systems post reapplied device profiles
DECLARE_MULTICAST_DELEGATE( FOnReapplyDeviceProfiles );
 
struct FPushedCVarSetting
{
    FPushedCVarSetting() : SetBy(ECVF_Default)  {}
    FPushedCVarSetting(const FString& InValue, EConsoleVariableFlags InFlags)
        : Value(InValue)
        , SetBy(EConsoleVariableFlags(InFlags & ECVF_SetByMask))
    {}
 
    FString Value;
    EConsoleVariableFlags SetBy;
};
 
 UCLASS( config=DeviceProfiles, transient , MinimalAPI)
class UDeviceProfileManager : public UObject
{
public:
 
    GENERATED_BODY()
 
    
    static ENGINE_API void InitializeCVarsForActiveDeviceProfile(bool bPushSettings = false, bool bIsDeviceProfilePreview = false, bool bForceReload = false);
 
    ENGINE_API void ReapplyDeviceProfile(bool bForceReload = false, TSet<FString>* ModifiedCVars=nullptr);
 
    ENGINE_API bool DoActiveProfilesReference(const TSet<FString>& DeviceProfilesToQuery);
 
    ENGINE_API UDeviceProfile* CreateProfile(const FString& ProfileName, const FString& ProfileType, const FString& ParentName=TEXT(""), const TCHAR* ConfigPlatform=nullptr);
 
    ENGINE_API bool HasLoadableProfileName(const FString& ProfileName, FName OptionalPlatformName = FName());
 
    ENGINE_API TArray<FString> GetLoadableProfileNames(FName OptionalPlatformName = FName()) const;
 
    ENGINE_API void DeleteProfile( UDeviceProfile* Profile );
 
    ENGINE_API UDeviceProfile* FindProfile(const FString& ProfileName, bool bCreateProfileOnFail = true, FName OptionalPlatformName = FName());
 
    ENGINE_API void SetOverrideDeviceProfile(UDeviceProfile* DeviceProfile);
 
    ENGINE_API void RestoreDefaultDeviceProfile();
 
#if ALLOW_OTHER_PLATFORM_CONFIG
    ENGINE_API void SetPreviewDeviceProfile(UDeviceProfile* DeviceProfile, FName PreviewModeTag=NAME_None);
 
    ENGINE_API void RestorePreviewDeviceProfile(FName PreviewModeTag=NAME_None);
 
    FOnPreviewDeviceProfileChanged& OnPreviewDeviceProfileChanged() { return PreviewDeviceProfileChangedDelegate; }
#endif
 
    ENGINE_API void LoadProfiles();
 
    ENGINE_API FOnDeviceProfileManagerUpdated& OnManagerUpdated();
 
    ENGINE_API FOnActiveDeviceProfileChanged& OnActiveDeviceProfileChanged();
 
    ENGINE_API FWillReapplyDeviceProfiles& WillReapplyDeviceProfiles();
 
    ENGINE_API FOnReapplyDeviceProfiles& OnReapplyDeviceProfiles();
 
    ENGINE_API void GetProfileConfigFiles(OUT TArray<FString>& OutConfigFiles);
 
    ENGINE_API void SaveProfiles(bool bSaveToDefaults = false);
 
    ENGINE_API UDeviceProfile* GetActiveProfile() const;
 
    ENGINE_API UDeviceProfile* GetPreviewDeviceProfile() const;
 
    ENGINE_API void GetAllPossibleParentProfiles(const UDeviceProfile* ChildProfile, OUT TArray<UDeviceProfile*>& PossibleParentProfiles) const;
 
    ENGINE_API const FString GetActiveDeviceProfileName();
 
    ENGINE_API const FString GetActiveDeviceProfileMatchedFragmentsString(bool bEnabledOnly, bool bIncludeTags, bool bAlphaSort);
 
    UE_DEPRECATED(4.25, "Use either GetActiveDeviceProfileName to have the current active device profile or GetPlatformDeviceProfileName to have the default one. Note, GetActiveDeviceProfileName will fallback on GetPlatformDeviceProfileName, if there is no active device profile ")
    static ENGINE_API const FString GetActiveProfileName();
 
    static ENGINE_API const FString GetPlatformDeviceProfileName();
    
    static ENGINE_API bool GetScalabilityCVar(const FString& CvarName, int32& OutValue);
    static ENGINE_API bool GetScalabilityCVar(const FString& CvarName, float& OutValue);
 
    ENGINE_API void ChangeTaggedFragmentState(FName FragmentTag, bool bNewState);
 
    ENGINE_API const FSelectedFragmentProperties* GetActiveDeviceProfileFragmentByTag(FName& FragmentTag) const;
 
 
    enum class EDeviceProfileMode : uint8
    {
        DPM_SetCVars,
        DPM_CacheValues,
        DPM_CacheValuesIgnoreMatchingRules, // GatherDeviceProfileCVars will not return any matching rules cvars. Used when entire matching rules state is applied later (see GetAllReferencedDeviceProfileCVars).
        DPM_SetCVarsForSingleDP,
        DPM_SetCVarsForSingleFragment,
    };
 
    static ENGINE_API TMap<FName, FString> GatherDeviceProfileCVars(const FString& DeviceProfileName, EDeviceProfileMode GatherMode);
 
    static ENGINE_API TMap<FName, TSet<FString>> GetAllReferencedDeviceProfileCVars(UDeviceProfile* DeviceProfile);
 
    TArray<TTuple<FName, FString>> GetDPChain(const FString& DeviceProfileName, FConfigCacheIni* ConfigSystem);
 
private:
    ENGINE_API void SetActiveDeviceProfile( UDeviceProfile* DeviceProfile );
 
    ENGINE_API void HandleDeviceProfileOverrideChange();
 
    ENGINE_API bool AreProfilesTheSame(UDeviceProfile* Profile1, UDeviceProfile* Profile2) const;
 
    ENGINE_API bool AreTextureGroupsTheSame(UDeviceProfile* Profile1, UDeviceProfile* Profile2) const;
 
    static ENGINE_API void SetDeviceProfileCVars(const FString& DeviceProfileName);
 
 
    static ENGINE_API TArray<FSelectedFragmentProperties> FindMatchingFragments(const FString& ParentDP, class FConfigCacheIni* PreviewConfigSystem);
 
    static ENGINE_API TArray<FString> FindAllReferencedFragmentsFromMatchedRules(const FString& ParentDP, FConfigCacheIni* ConfigSystem);
 
    static ENGINE_API const FString FragmentPropertyArrayToFragmentString(const TArray<FSelectedFragmentProperties>& FragmentProperties, bool bEnabledOnly, bool bIncludeTags, bool bAlphaSort);
 
    static ENGINE_API class IDeviceProfileSelectorModule* GetDeviceProfileSelectorModule();
 
#if ALLOW_OTHER_PLATFORM_CONFIG && WITH_EDITOR
    static ENGINE_API class IDeviceProfileSelectorModule* GetPreviewDeviceProfileSelectorModule(class FConfigCacheIni* PreviewConfigSystem);
#endif
public:
 
    static ENGINE_API class UDeviceProfileManager* DeviceProfileManagerSingleton;
    static ENGINE_API UDeviceProfileManager& Get(bool bFromPostCDOContruct = false);
 
    virtual void PostCDOContruct() override
    {
        Get(true); // get this taken care of now
    }
 
 
public:
 
    // Holds the collection of managed profiles.
    UPROPERTY( EditAnywhere, Category=Properties )
    TArray< TObjectPtr<UDeviceProfile> > Profiles;
 
private:
    // Cached copy of profiles at load
    UPROPERTY()
    TArray< TObjectPtr<UDeviceProfile> > BackupProfiles;
 
    // Holds a delegate to be invoked profiles are updated.
    FOnDeviceProfileManagerUpdated ManagerUpdatedDelegate;
 
    // Holds a delegate to be invoked when the active deviceprofile changes
    FOnActiveDeviceProfileChanged ActiveDeviceProfileChangedDelegate;
 
#if ALLOW_OTHER_PLATFORM_CONFIG
    // Holds a delegate to be invoked when the preview deviceprofile changes
    FOnPreviewDeviceProfileChanged PreviewDeviceProfileChangedDelegate;
#endif
 
    // Holds a delegate to be invoked pre reapply device profiles
    FWillReapplyDeviceProfiles PreReapplyDeviceProfilesDelegate;
    // Holds a delegate to be invoked post reapply device profiles
    FOnReapplyDeviceProfiles PostReapplyDeviceProfilesDelegate;
 
    // Holds the selected device profile
    UDeviceProfile* ActiveDeviceProfile;
 
    // Add to profile to get load time backup
    static ENGINE_API FString BackupSuffix;
 
    // Original values of all the CVars modified by the DP.
    // Used to undo the DP before applying new state.
    static ENGINE_API TMap<FString, FPushedCVarSetting> PushedSettings;
 
    // Holds the device profile that has been overridden, null no override active.
    UDeviceProfile* BaseDeviceProfile = nullptr;
 
    // Holds the device profile that we are previewing.
    UDeviceProfile* PreviewDeviceProfile = nullptr;
 
    // Stores any scalability group settings set by the active device profile.
    static ENGINE_API TMap<FString, FString> DeviceProfileScalabilityCVars;
 
    // Stores any scalability group settings set by the preview device profile.
    static ENGINE_API TMap<FString, FString> PreviewDeviceProfileScalabilityCVars;
    
    // The list of fragments that have been selected by the active profile.
    static ENGINE_API TArray<FSelectedFragmentProperties> PlatformFragmentsSelected;
};