Class CachedComponentFilter<TFilterType, TRootType>
Class that allows for cached retrieval/filtering of multiple types of components into lists
Proper usage of this class is:
using (var componentFilter = new CachedComponentFilter<typeToFind,componentTypeThatContains>(instanceOfComponent))
{
}
Inheritance
CachedComponentFilter<TFilterType, TRootType>
Syntax
public class CachedComponentFilter<TFilterType, TRootType> : IDisposable where TFilterType : class where TRootType : Component
Type Parameters
Name |
Description |
TFilterType |
|
TRootType |
|
Constructors
CachedComponentFilter(TFilterType[], Boolean)
Declaration
public CachedComponentFilter(TFilterType[] componentList, bool includeDisabled = true)
Parameters
Type |
Name |
Description |
TFilterType[] |
componentList |
|
Boolean |
includeDisabled |
|
CachedComponentFilter(TRootType, CachedSearchType, Boolean)
Declaration
public CachedComponentFilter(TRootType componentRoot, CachedSearchType cachedSearchType = CachedSearchType.Children | CachedSearchType.Self, bool includeDisabled = true)
Parameters
Methods
Dispose()
Declaration
Dispose(Boolean)
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type |
Name |
Description |
Boolean |
disposing |
|
GetMatchingComponents<TChildType>()
Declaration
public TChildType[] GetMatchingComponents<TChildType>()
where TChildType : class, TFilterType
Returns
Type |
Description |
TChildType[] |
|
Type Parameters
Name |
Description |
TChildType |
|
StoreMatchingComponents<TChildType>(List<TChildType>)
Declaration
public void StoreMatchingComponents<TChildType>(List<TChildType> outputList)
where TChildType : class, TFilterType
Parameters
Type |
Name |
Description |
List<TChildType> |
outputList |
|
Type Parameters
Name |
Description |
TChildType |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.