Класс SearchProvider

SearchProvider класс выполняет поиск элементов конкретных типов и управляет миниатюрами, описаниями и подфильтрами.

Он имеет следующие основные API:

public class SearchProvider
{
    public SearchProvider(string id, string displayName = null);

    // Creates an Item bound to this provider.
    public SearchItem CreateItem(string id, string label = null, string description = null, Texture2D thumbnail = null);

    // Utility functions to check whether the search text matches a string.
    public static bool MatchSearchGroups(string searchContext, string content);
    public static bool MatchSearchGroups(string searchContext, string content,
                                        out int startIndex, out int endIndex);

    // The provider's unique ID.
    public NameId name;
    // Text token to "filter" a provider (for example, "me:", "p:", and "s:").
    public string filterId;
    // This provider is only active when a search explicitly specifies it with
    // its filterId.
    public bool isExplicitProvider;
    // Handler to fetch and format the label of a search item.
    public FetchStringHandler fetchLabel;
    // Handler to provide an async description for an item. Called just before
    // Search displays the item.
    // Allows a plug-in provider to fetch long descriptions only when
    // Search needs them.
    public FetchStringHandler fetchDescription;
    // Handler to provider an async thumbnail for an item. Called just before
    // Search displays the item.
    // Allows a plug-in provider to fetch/generate previews only when
    // Search needs them.
    public PreviewHandler fetchThumbnail;
    // Handler to support drag interactions. It is up to the SearchProvider
    // to properly set up the DragAndDrop manager.
    public StartDragHandler startDrag;
    // Called when the selection changes and Search can track it.
    public TrackSelectionHandler trackSelection;
    // MANDATORY: Handler to get items for a search context.
    public GetItemsHandler fetchItems;
    // A Search Provider can return a list of words that help the user complete
    // their search query.
    public GetKeywordsHandler fetchKeywords;
    // List of sub-filters that are visible in the FilterWindow for a
    // SearchProvider (see AssetProvider for an example).
    public List<NameId> subCategories;
    // Called when the Search window opens. Allows the Provider to perform
    // some caching.
    public Action onEnable;
    // Called when the Search window closes. Allows the Provider to release
    // cached resources.
    public Action onDisable;
    // Int to sort the Provider. Affects the order of search results and the
    // order in which providers are shown in the FilterWindow.
    public int priority;
    // Called when Search opens in "contextual mode". If you return true
    // it means the provider is enabled for this search context.
    public IsEnabledForContextualSearch isEnabledForContextualSearch;
}

Кэширование и высвобождение ресурсов

При запуске окна Поиск оно вызывает onEnable, которые можно использовать для кэширования ресурсов.

Когда вы закрываете окно Поиск, оно вызывает onDisable, которые вы можете использовать для высвобождения ресурсов.

Инициализация

Поскольку список элементов Search использует алгоритм виртуальной прокрутки, некоторые SearchItem областях (например, label, thumbnail, и description) извлекаются по требованию, если они еще не предоставлены.

Чтобы заполнить эти поля после создания элементов, необходимо инициализировать SearchProvider с помощью определенных обработчиков (fetchLabel, fetchDescription, fetchThumbnail).

Выбор элемента отслеживания

Вы можете зарегистрировать обратный звонок на trackSelection чтобы поиск выполнял определенные действия, когда вы выбираете элемент в результатах поиска с помощью мыши или клавиатуры. Например, Активы и Scene провайдеры используют trackSelection callback для ping выбранного элемента в Поиске.

Включение перетаскивания

Некоторые поставщики поиска возвращают элементы, которые можно перетаскивать в Scene. Если вы создаете пользовательский поставщик, элементы которого поддерживают перетаскивание, реализуйте startDrag.

Например, поставщики Ассеты и Scene заполняют структуру DragAndDrop соответствующим элементом UIDs, чтобы обеспечить надлежащее взаимодействие перетаскивания.

Включение поставщика в контекстный поиск

Когда вы открываете окно Поиск с помощью ярлыка Alt Shift + C, он запускает контекстный поиск, то есть Поиск ищет окно, которое имеет фокус.

Когда вы запускаете контекстный поиск, поставщики, переопределяющие isEnabledForContextualSearch проверить, должны ли они быть включены, как в следующем примере:

// Taken from Scene hierarchy provider:
// Makes the provider part of the contextual search if the Scene view or the
// Hierarchy window has focus.
isEnabledForContextualSearch = () =>
                QuickSearchTool.IsFocusedWindowTypeName("SceneView") ||
                QuickSearchTool.IsFocusedWindowTypeName("SceneHierarchyWindow");