EM_Task/UnrealEd/Classes/Settings/ContentBrowserSettings.h

// Copyright Epic Games, Inc. All Rights Reserved.

/*=============================================================================
        ContentBrowserSettings.h: Declares the UContentBrowserSettings class.
=============================================================================*/

#pragma once

#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "ContentBrowserSettings.generated.h"

/**
 * Implements content browser settings.  These are global not per-project
 */
UCLASS(config = EditorSettings)
class UNREALED_API UContentBrowserSettings: public UObject
{
    GENERATED_UCLASS_BODY()

public:
    /** The number of objects to load at once in the Content Browser before displaying a warning about loading many assets */
    UPROPERTY(EditAnywhere, config, Category = ContentBrowser, meta = (DisplayName = "Assets to Load at Once Before Warning", ClampMin = "1"))
    int32 NumObjectsToLoadBeforeWarning;

    /** Whether the Content Browser should open the Sources Panel by default */
    UPROPERTY(EditAnywhere, config, Category = ContentBrowser)
    bool bOpenSourcesPanelByDefault;

    /** Whether to render thumbnails for loaded assets in real-time in the Content Browser */
    UPROPERTY(config)
    bool RealTimeThumbnails;

    /** Whether to display folders in the asset view of the content browser. Note that this implies 'Show Only Assets in Selected Folders'. */
    UPROPERTY(config)
    bool DisplayFolders;

    /** Whether to empty display folders in the asset view of the content browser. */
    UPROPERTY(config)
    bool DisplayEmptyFolders;

    /** Whether to filter recursively when a filter is applied in the asset view of the content browser. */
    UPROPERTY(config)
    bool FilterRecursively = true;

    /** Whether to group root folders under a common folder in the path view */
    UPROPERTY(config)
    bool ShowAllFolder = false;

    /** Whether to organize folders in the content browser */
    UPROPERTY(config)
    bool OrganizeFolders = false;

    /** The number of objects to keep in the Content Browser Recently Opened filter */
    UPROPERTY(EditAnywhere, config, Category = ContentBrowser, meta = (DisplayName = "Number of Assets to Keep in the Recently Opened Filter", ClampMin = "1", ClampMax = "30"))
    int32 NumObjectsInRecentList;

    /** Whether the Content Browser should open the Sources Panel by default */
    UPROPERTY(EditAnywhere, config, Category = ContentBrowser)
    bool bShowFullCollectionNameInToolTip;

    /** Enables the rendering of Material Instance thumbnail previews */
    UPROPERTY(EditAnywhere, config, Category = ContentBrowser)
    bool bEnableRealtimeMaterialInstanceThumbnails = true;

public:
    /** Sets whether we are allowed to display the engine folder or not, optional flag for setting override instead */
    void SetDisplayEngineFolder(bool bInDisplayEngineFolder, bool bOverride = false)
    {
        bOverride ? OverrideDisplayEngineFolder = bInDisplayEngineFolder : DisplayEngineFolder = bInDisplayEngineFolder;
    }

    /** Gets whether we are allowed to display the engine folder or not, optional flag ignoring the override */
    bool GetDisplayEngineFolder(bool bExcludeOverride = false) const
    {
        return ((bExcludeOverride ? false : OverrideDisplayEngineFolder) || DisplayEngineFolder);
    }

    /** Sets whether we are allowed to display the developers folder or not, optional flag for setting override instead */
    void SetDisplayDevelopersFolder(bool bInDisplayDevelopersFolder, bool bOverride = false)
    {
        bOverride ? OverrideDisplayDevelopersFolder = bInDisplayDevelopersFolder : DisplayDevelopersFolder = bInDisplayDevelopersFolder;
    }

    /** Gets whether we are allowed to display the developers folder or not, optional flag ignoring the override */
    bool GetDisplayDevelopersFolder(bool bExcludeOverride = false) const
    {
        return ((bExcludeOverride ? false : OverrideDisplayDevelopersFolder) || DisplayDevelopersFolder);
    }

    /** Sets whether we are allowed to display the L10N folder (contains localized assets) or not */
    void SetDisplayL10NFolder(bool bInDisplayL10NFolder)
    {
        DisplayL10NFolder = bInDisplayL10NFolder;
    }

    /** Gets whether we are allowed to display the L10N folder (contains localized assets) or not */
    bool GetDisplayL10NFolder() const
    {
        return DisplayL10NFolder;
    }

    /** Sets whether we are allowed to display the plugin folders or not, optional flag for setting override instead */
    void SetDisplayPluginFolders(bool bInDisplayPluginFolders, bool bOverride = false)
    {
        bOverride ? OverrideDisplayPluginFolders = bInDisplayPluginFolders : DisplayPluginFolders = bInDisplayPluginFolders;
    }

    /** Gets whether we are allowed to display the plugin folders or not, optional flag ignoring the override */
    bool GetDisplayPluginFolders(bool bExcludeOverride = false) const
    {
        return ((bExcludeOverride ? false : OverrideDisplayPluginFolders) || DisplayPluginFolders);
    }

    /** Sets whether we are allowed to display favorite folders or not */
    void SetDisplayFavorites(bool bInDisplayFavorites)
    {
        DisplayFavorites = bInDisplayFavorites;
    }

    /** Gets whether we are allowed to display the favorite folders or not*/
    bool GetDisplayFavorites() const
    {
        return DisplayFavorites;
    }

    /** Sets whether we should dock the collections view under the paths view */
    void SetDockCollections(bool bInDockCollections)
    {
        DockCollections = bInDockCollections;
    }

    /** Gets whether we should dock the collections view under the paths view */
    bool GetDockCollections() const
    {
        return DockCollections;
    }

    /** Sets whether we are allowed to display C++ folders or not */
    void SetDisplayCppFolders(bool bDisplay)
    {
        DisplayCppFolders = bDisplay;
    }

    /** Gets whether we are allowed to display the C++ folders or not*/
    bool GetDisplayCppFolders() const
    {
        return DisplayCppFolders;
    }

    /** Sets whether text searches should also search in asset class names */
    void SetIncludeClassNames(bool bInclude)
    {
        IncludeClassNames = bInclude;
    }

    /** Gets whether text searches should also search in asset class names */
    bool GetIncludeClassNames() const
    {
        return IncludeClassNames;
    }

    /** Sets whether text searches should also search asset paths (instead of asset name only) */
    void SetIncludeAssetPaths(bool bInclude)
    {
        IncludeAssetPaths = bInclude;
    }

    /** Gets whether text searches should also search asset paths (instead of asset name only) */
    bool GetIncludeAssetPaths() const
    {
        return IncludeAssetPaths;
    }

    /** Sets whether text searches should also search for collection names */
    void SetIncludeCollectionNames(bool bInclude)
    {
        IncludeCollectionNames = bInclude;
    }

    /** Gets whether text searches should also search for collection names */
    bool GetIncludeCollectionNames() const
    {
        return IncludeCollectionNames;
    }

    /**
     * Returns an event delegate that is executed when a setting has changed.
     *
     * @return The delegate.
     */
    DECLARE_EVENT_OneParam(UContentBrowserSettings, FSettingChangedEvent, FName /*PropertyName*/);
    static FSettingChangedEvent& OnSettingChanged() { return SettingChangedEvent; }

protected:
    // UObject overrides

    virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;

private:
    /** Whether to display the engine folder in the assets view of the content browser. */
    UPROPERTY(config)
    bool DisplayEngineFolder;

    /** If true, overrides the DisplayEngine setting */
    bool OverrideDisplayEngineFolder;

    /** Whether to display the developers folder in the path view of the content browser */
    UPROPERTY(config)
    bool DisplayDevelopersFolder;

    UPROPERTY(config)
    bool DisplayL10NFolder;

    /** If true, overrides the DisplayDev setting */
    bool OverrideDisplayDevelopersFolder;

    /** List of plugin folders to display in the content browser. */
    UPROPERTY(config)
    bool DisplayPluginFolders;

    /** Temporary override for the DisplayPluginFolders setting */
    bool OverrideDisplayPluginFolders;

    UPROPERTY(config)
    bool DisplayFavorites;

    UPROPERTY(config)
    bool DockCollections;

    UPROPERTY(config)
    bool DisplayCppFolders;

    UPROPERTY(config)
    bool IncludeClassNames;

    UPROPERTY(config)
    bool IncludeAssetPaths;

    UPROPERTY(config)
    bool IncludeCollectionNames;

    // Holds an event delegate that is executed when a setting has changed.
    static FSettingChangedEvent SettingChangedEvent;
};