SettingsProvider

класс в UnityEditor

Описание

SettingsProvider — это класс конфигурации, который указывает, как параметр Project или настройка должны отображаться в окне настроек или настроек.

Чтобы добавить новые настройки проекта или страницы настроек, определите SettingsProvider. Класс SettingsProvider предоставляет хуки для отображения любого пользовательского интерфейса (используя либо IMGUI, либо UIElements для его рисования). Он также предоставляет API, который позволяет указывать ключевые слова, используемые в окнах настроек и настроек, двумя способами:

1) Панель поиска отфильтровывает поставщиков настроек, для которых нет соответствующих ключевых слов.

2) Ярлыки свойств выделены соответствующими ключевыми словами.

В этом примере показано несколько способов создания и настройки различных поставщиков настроек:

using System.Collections.Generic;
using System.IO;
using System.Linq;
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;
using UnityEditor.UIElements;

// Create a new type of SettingsAsset.
class MyCustomSettings : ScriptableObject
{
    public const string k_MyCustomSettingsPath = "Assets/Editor/MyCustomSettings.asset";

    [SerializeField]
    private int m_Number;

    [SerializeField]
    private string m_SomeString;

    internal static MyCustomSettings GetOrCreateSettings()
    {
        var settings = AssetDatabase.LoadAssetAtPath(k_MyCustomSettingsPath);
        if (settings == null)
        {
            settings = ScriptableObject.CreateInstance();
            settings.m_Number = 42;
            settings.m_SomeString = "The answer to the universe";
            AssetDatabase.CreateAsset(settings, k_MyCustomSettingsPath);
            AssetDatabase.SaveAssets();
        }
        return settings;
    }

    internal static SerializedObject GetSerializedSettings()
    {
        return new SerializedObject(GetOrCreateSettings());
    }
}

// Register a SettingsProvider using IMGUI for the drawing framework:
static class MyCustomSettingsIMGUIRegister
{
    [SettingsProvider]
    public static SettingsProvider CreateMyCustomSettingsProvider()
    {
        // First parameter is the path in the Settings window.
        // Second parameter is the scope of this setting: it only appears in the ProjectSettings window.
        var provider = new SettingsProvider("Project/MyCustomIMGUISettings", SettingsScope.Project)
        {
            // By default the last token of the path is used as display name if no label is provided.
            label = "Custom IMGUI",
            // Create the SettingsProvider and initialize its drawing (IMGUI) function in place:
            guiHandler = (searchContext) =>
            {
                var settings = MyCustomSettings.GetSerializedSettings();
                EditorGUILayout.PropertyField(settings.FindProperty("m_Number"), new GUIContent("My Number"));
                EditorGUILayout.PropertyField(settings.FindProperty("m_SomeString"), new GUIContent("My String"));
                settings.ApplyModifiedPropertiesWithoutUndo();
            },

            // Populate the search keywords to enable smart search filtering and label highlighting:
            keywords = new HashSet(new[] { "Number", "Some String" })
        };

        return provider;
    }
}

// Register a SettingsProvider using UIElements for the drawing framework:
static class MyCustomSettingsUIElementsRegister
{
    [SettingsProvider]
    public static SettingsProvider CreateMyCustomSettingsProvider()
    {
        // First parameter is the path in the Settings window.
        // Second parameter is the scope of this setting: it only appears in the Settings window for the Project scope.
        var provider = new SettingsProvider("Project/MyCustomUIElementsSettings", SettingsScope.Project)
        {
            label = "Custom UI Elements",
            // activateHandler is called when the user clicks on the Settings item in the Settings window.
            activateHandler = (searchContext, rootElement) =>
            {
                var settings = MyCustomSettings.GetSerializedSettings();

                // rootElement is a VisualElement. If you add any children to it, the OnGUI function
                // isn't called because the SettingsProvider uses the UIElements drawing framework.
                var styleSheet = AssetDatabase.LoadAssetAtPath<StyleSheet>("Assets/Editor/settings_ui.uss");
                rootElement.styleSheets.Add(styleSheet);
                var title = new Label()
                {
                    text = "Custom UI Elements"
                };
                title.AddToClassList("title");
                rootElement.Add(title);

                var properties = new VisualElement()
                {
                    style =
                    {
                        flexDirection = FlexDirection.Column
                    }
                };
                properties.AddToClassList("property-list");
                rootElement.Add(properties);

                properties.Add(new PropertyField(settings.FindProperty("m_SomeString")));
                properties.Add(new PropertyField(settings.FindProperty("m_Number")));

                rootElement.Bind(settings);
            },

            // Populate the search keywords to enable smart search filtering and label highlighting:
            keywords = new HashSet(new[] { "Number", "Some String" })
        };

        return provider;
    }
}

// Create MyCustomSettingsProvider by deriving from SettingsProvider:
class MyCustomSettingsProvider : SettingsProvider
{
    private SerializedObject m_CustomSettings;

    class Styles
    {
        public static GUIContent number = new GUIContent("My Number");
        public static GUIContent someString = new GUIContent("Some string");
    }

    const string k_MyCustomSettingsPath = "Assets/Editor/MyCustomSettings.asset";
    public MyCustomSettingsProvider(string path, SettingsScope scope = SettingsScope.User)
        : base(path, scope) {}

    public static bool IsSettingsAvailable()
    {
        return File.Exists(k_MyCustomSettingsPath);
    }

    public override void OnActivate(string searchContext, VisualElement rootElement)
    {
        // This function is called when the user clicks on the MyCustom element in the Settings window.
        m_CustomSettings = MyCustomSettings.GetSerializedSettings();
    }

    public override void OnGUI(string searchContext)
    {
        // Use IMGUI to display UI:
        EditorGUILayout.PropertyField(m_CustomSettings.FindProperty("m_Number"), Styles.number);
        EditorGUILayout.PropertyField(m_CustomSettings.FindProperty("m_SomeString"), Styles.someString);
        m_CustomSettings.ApplyModifiedPropertiesWithoutUndo();
    }

    // Register the SettingsProvider
    [SettingsProvider]
    public static SettingsProvider CreateMyCustomSettingsProvider()
    {
        if (IsSettingsAvailable())
        {
            var provider = new MyCustomSettingsProvider("Project/MyCustomSettingsProvider", SettingsScope.Project);

            // Automatically extract all keywords from the Styles.
            provider.keywords = GetSearchKeywordsFromGUIContentProperties();
            return provider;
        }

        // SettingsAsset doesn't exist yet; no need to display anything in the Settings window.
        return null;
    }
}

Свойства

activateHandler	Переопределяет SettingsProvider.OnActivate.
deactivateHandler	Переопределяет SettingsProvider.OnDeactivate.
footerBarGuiHandler	Переопределяет SettingsProvider.OnFooterBarGUI.
guiHandler	Переопределяет SettingsProvider.OnGUI.
hasSearchInterestHandler	Переопределяет SettingsProvider.HasSearchInterest.
spectorUpdateHandler	Переопределяет SettingsProvider.OnInspectorUpdate.
keywords	Получает или задает список ключевых слов для сравнения с тем, что ищет пользователь. Когда пользователь вводит значения в поле поиска в окне настроек, SettingsProvider.HasSearchInterest пытается сопоставить эти ключевые слова с этим списком.
label	Получает или задает отображаемое имя поставщика настроек, которое отображается в окне настроек. Если не задано, в окне настроек вместо этого используется последний токен SettingsProvider.settingsPath.
scope	Получает область действия SettingsProvider. Scope определяет, отображается ли SettingsProvider в окне настроек (SettingsScope.User) или в окне настроек (SettingsScope.Project).
settingsPath	Получает путь, используемый для размещения SettingsProvider в древовидном представлении окна настроек. Путь должен быть уникальным среди всех других путей к настройкам и должен использовать «/» в качестве разделителя.
titleBarGuiHandler	Переопределяет SettingsProvider.OnTitleBarGUI.

Конструкторы

SettingsProvider

Создает новый SettingsProvider.

Публичные Методы

HasSearchInterest	Проверяет, должен ли появляться SettingsProvider, когда пользователь вводит что-то в поле поиска окна настроек. SettingsProvider пытается сопоставить условия поиска (даже частично) с любым из SettingsProvider.keywords. Поиск нечувствителен к регистру.
OnActivate	Используйте эту функцию для реализации обработчика, когда пользователь щелкает Настройки в окне Настройки. Вы можете получить актив настроек или настроить пользовательский интерфейс UIElements из этой функции.
OnDeactivate	Используйте эту функцию для реализации обработчика, когда пользователь щелкает другой параметр или когда окно настроек закрывается.
OnFooterBarGUI	Используйте эту функцию, чтобы переопределить отрисовку нижнего колонтитула для SettingsProvider с помощью IMGUI.
OnGUI	Используйте эту функцию для рисования пользовательского интерфейса на основе IMGUI. Это предполагает, что вы не добавили никаких дочерних элементов в rootElement, переданный функции OnActivate.
OnInspectorUpdate	OnInspectorUpdate вызывается со скоростью 10 кадров в секунду, чтобы дать инспектору возможность обновиться. Дополнительные сведения см. в разделе EditorWindow.OnInspectorUpdate.
OnTitleBarGUI	Используйте эту функцию, чтобы переопределить отрисовку заголовка для SettingsProvider с помощью IMGUI. Это позволяет добавить пользовательский интерфейс (например, кнопку на панели инструментов) рядом с заголовком. AssetSettingsProvider использует этот механизм для отображения кнопок «добавить в пресет» и «помощь».
Repaint	Запросить окно настроек для перерисовки.

Статические Методы

GetSearchKeywordsFromGUIContentProperties	Извлечение ключевых слов для поиска из всех общедоступных статических элементов определенного типа.
GetSearchKeywordsFromPath	Извлечение ключевых слов для поиска из сериализованных свойств актива по определенному пути.
GetSearchKeywordsFromSerializedObject	Извлеките ключевые слова для поиска из сериализованных свойств SerializedObject.

Вы можете отблагодарить автора, за перевод документации на русский язык. ₽ Спасибо