Namespace Unity.QuickSearch | Quick Search | 2.0.0
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace Unity.QuickSearch

    Classes

    CustomObjectIndexerAttribute

    Allow a user to register a custom Indexing function for a specific type. The registered function must be of type: static void Function(CustomObjectIndexerTarget context, ObjectIndexer indexer);

    [CustomObjectIndexer(typeof(Material))]
    internal static void MaterialShaderReferences(CustomObjectIndexerTarget context, ObjectIndexer indexer)
    {
       var material = context.target as Material;
       if (material == null)
           return;
    
       if (material.shader)
       {
           var fullShaderName = material.shader.name.ToLowerInvariant();
           var shortShaderName = System.IO.Path.GetFileNameWithoutExtension(fullShaderName);
           indexer.AddProperty("ref", shortShaderName, context.documentIndex, saveKeyword: false);
           indexer.AddProperty("ref", fullShaderName, context.documentIndex, saveKeyword: false);
       }
    }

    FuzzySearch

    Utility class to perform matching against query text using a fuzzy search algorithm.

    NameEntry

    The name entry holds a name and an identifier at once.

    ObjectIndexer

    Specialized SearchIndexer used to index Unity Assets. See Unity.QuickSearch.AssetIndexer for a specialized SearchIndexer used to index simple assets and see Unity.QuickSearch.SceneIndexer for an indexer used to index scene and prefabs.

    Query<T>

    A Query defines an operation that can be used to filter a data set.

    Query<TData, TPayload>

    A Query defines an operation that can be used to filter a data set.

    QueryEngine

    A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators. Default query engine of type object.

    QueryEngine<TData>

    A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators.

    QueryEngineFilterAttribute

    Base attribute class used to define a custom filter on a QueryEngine. All filter types supported by QueryEngine.AddFilter are supported by this attribute.

    QueryEngineParameterTransformerAttribute

    Base attribute class that defines a custom parameter transformer function.

    QueryError

    A QueryError holds the definition of a query parsing error.

    QuickSearch

    Quick Search Editor Window

    SearchAction

    Define an action that can be applied on SearchItem of a specific provider type.

    SearchActionsProviderAttribute

    Attribute used to declare a static method that define new actions for specific search providers.

    SearchContext

    The search context encapsulate all the states necessary to perform a query. It allows the full customization of how a query would be performed.

    SearchDocument

    Represents a searchable document that has been indexed.

    SearchIndexer

    Base class for an Indexer of document which allow retrieving of a document given a specific pattern in roughly log(n).

    SearchItem

    Search items are returned by the search provider when some results need to be shown to the user after a search is made. The search item holds all the data that will be used to sort and present the search results.

    SearchItemProviderAttribute

    Attribute used to declare a static method that will create a new search provider at load time.

    SearchProvider

    SearchProvider manages search for specific type of items and manages thumbnails, description and subfilters, etc.

    SearchSelection

    Class giving readonly access to the current list of selected items in QuickSearch.

    SearchService

    Principal Quick Search API to initiate searches and fetch results.

    SearchUtils

    Utilities used by multiple components of QuickSearch.

    Structs

    CustomObjectIndexerTarget

    Descriptor for the object that is about to be indexed. It stores a reference to the object itself as well a an already setup SerializedObject.

    ParseResult<T>

    A ParseResult holds the result of a parsing operation.

    QueryValidationOptions

    Struct containing the available query validation options.

    SearchResult

    Encapsulate an element that was retrieved from a query in a g.

    Interfaces

    ISearchExpression

    A Search Expression can be populated with variables and providers. It can then be evaluated to yield a list of SearchItem

    ISearchList

    A search list represents a collection of search results that is filled

    ISearchView

    Search view interface used by the search context to execute a few UI operations.

    Enums

    DisplayMode

    DisplayMode for a ISearchView

    FetchPreviewOptions

    Defines at set of options that indicates to the search provider how the preview should be fetched.

    SearchFlags

    Various search options used to fetch items.

    SearchItemOptions

    Indicates how the search item description needs to be formatted when presented to the user.

    ShowDetailsOptions

    Defines what details are shown in the details panel for the search view.

    TextCursorPlacement

    Where to place the cursor in the text are of a ISearchView (see SetSearchText(String, TextCursorPlacement)).

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023