Version: 2021.1
LanguageEnglish
  • C#

ObjectIndexer

class in UnityEditor.Search

/

Inherits from:Search.SearchIndexer

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A specialized SearchIndexer which provides methods to index a Unity Object from custom indexers.

The ObjectIndexer can only be used in the context of a CustomObjectIndexerAttribute and therefore cannot be instanciated explicitly.

[CustomObjectIndexer(typeof(Collider))]
static void IndexObjectSize(CustomObjectIndexerTarget target, ObjectIndexer indexer)
{
    var collider = target.target as Collider;
    if (collider == null)
        return;

    var boundingBoxSize = collider.bounds.size;
    var totalSize = boundingBoxSize.x * boundingBoxSize.y;

    indexer.IndexNumber(target.documentIndex, "testsize", totalSize);
}

Note that you can use all of the SearchIndexer Add* indexing methods to add words, properties and numbers to the search index database. You can also use the following higher level functions (i.e. IndexWord, IndexNumber, IndexProperty, IndexWordComponents and IndexPropertyComponents) to index common Unity Object properties.

Public Methods

IndexNumberAdds a key-number value pair to the index. The key won't be added with variations.
IndexPropertyAdds a property value to the index. A property is specified with a key and a string value. The value will be stored with multiple variations.
IndexPropertyComponentsIndexes multiple variations of a property value.
IndexWordAdds a new word coming from a specific document to the index. The word will be added with multiple variations allowing partial search.
IndexWordComponentsSplits a word into multiple variations.

Inherited Members

Properties

documentCountReturns the number of documents in the index.
keywordCountReturns the number keywords in the index.
minWordIndexationLengthMinimal indexed word size. Default is 2.
nameName of the index. Generally this name is set by a user from SearchDatabase.Settings.
resolveDocumentHandlerHandler used to resolve a document ID to some other data string.
skipEntryHandlerHandler used to skip entries.

Public Methods

AddDocumentAdds a new document to be indexed.
AddExactWordAdds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.
AddNumberAdds a key-number value pair to the index. The key won't be added with variations.
AddPropertyAdds a property value to the index. A property is specified with a key and a string value. The value will be stored with multiple variations.
AddWordAdds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.
FinishFinalizes the current index, sorting and compiling of all the indexes.
GetDocumentReturns a search document by its index.
GetMetaInfoGet metadata of a specific document.
IndexDocumentFunction to override in a concrete SearchIndexer to index the content of a document.
IsReadyIndicates if the index is fully built, up to date, and ready for search.
LoadBytesLoads the index asynchronously (in another thread) from a binary buffer.
ReadReads a stream and populates the index from it.
SaveBytesGet the bytes representation of this index. See SearchIndexer.Write.
SearchRuns a search query in the index.
SetMetaInfoSet arbiraty metadata on a specific document.
SkipEntryCalled when the index is built to see if a specified document needs to be indexed. See SearchIndexer.skipEntryHandler.
StartStarts indexing entries.
WriteWrites a binary representation of the index on a stream.