Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Public Member Functions | Protected Member Functions | Properties | List of all members
Doloro.DataManagement.DynamicResources.Search.SignatureFilter< T > Class Template Reference

Detailed Description

Checks that the object has certain signature. (Case insensitive)

Template Parameters
TType of signature holder.

DynamicResourcesDatabase.Find(string, string)

Type Constraints
T :UnityEngine.Object 
T :ISignedResource 
Inheritance diagram for Doloro.DataManagement.DynamicResources.Search.SignatureFilter< T >:
Inheritance graph
[legend]
Collaboration diagram for Doloro.DataManagement.DynamicResources.Search.SignatureFilter< T >:
Collaboration graph
[legend]

Public Member Functions

 SignatureFilter (string bundle)
 Creates filter that allows only resources from the certain bundle. More...
 
 SignatureFilter (string bundle, string key)
 Creates filter that allows only resources with a certain sign. More...
 
virtual bool IsResourcePassingFilter (GameObject resource, out UnityEngine.Object filteredResource)
 Looking for component with a type defined at the HandlingType property. More...
 
virtual bool IsResourcePassingFilter (UnityEngine.Object resource, out UnityEngine.Object filteredResource)
 Checks is the resource is can be casted to the HandlingType and handles it if possible. More...
 
bool IsResourcePassingFilter (UnityEngine.GameObject resource, out UnityEngine.Object filteredResource)
 Passing the resource through the query filter. More...
 

Protected Member Functions

override bool OnResourceFilter (object resource, out UnityEngine.Object filteredResource)
 Checks the signature of filtering object with requested. More...
 

Properties

OrderOptions Order [get]
 Check order handling by the filter.
 
string Bundle [get]
 Searching bundle key. null or whitespace means local resource bundle.
 
string Key [get]
 Searching resource key.
 
override string GetStaticSignature [get]
 Returns key in format: HandlingType.FullName:SingFilter:Bundle|..Key|ALL More...
 
virtual Type HandlingType [get]
 Type that will be handled by the query. More...
 
bool IsComponentsHandler [get]
 Checks is handling type is component-like.
 

Constructor & Destructor Documentation

◆ SignatureFilter() [1/2]

Doloro.DataManagement.DynamicResources.Search.SignatureFilter< T >.SignatureFilter ( string  bundle)

Creates filter that allows only resources from the certain bundle.

Parameters
bundle

◆ SignatureFilter() [2/2]

Doloro.DataManagement.DynamicResources.Search.SignatureFilter< T >.SignatureFilter ( string  bundle,
string  key 
)

Creates filter that allows only resources with a certain sign.

Parameters
bundle
key

Member Function Documentation

◆ IsResourcePassingFilter() [1/3]

virtual bool Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.IsResourcePassingFilter ( GameObject  resource,
out UnityEngine.Object  filteredResource 
)
virtualinherited

Looking for component with a type defined at the HandlingType property.

Handle it via OnResourceFilter(object, out UnityEngine.Object) if found.

Parameters
resourceInput resource for check.
filteredResourceSub-resource that was selected by filter as the target. Will be registered in filter->resource pair in Resource collection.
Returns
Checks is the resource passing the filter. False if check is impossible.

◆ IsResourcePassingFilter() [2/3]

bool Doloro.DataManagement.DynamicResources.Search.IResourceFilter.IsResourcePassingFilter ( UnityEngine.GameObject  resource,
out UnityEngine.Object  filteredResource 
)
inherited

Passing the resource through the query filter.

Parameters
resourceComparable resource.
filteredResourceSub-resource that was selected by filter as the target. Will be registered in filter->resource pair in Resource collection.
Returns
True if the resource passing query filter.

◆ IsResourcePassingFilter() [3/3]

virtual bool Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.IsResourcePassingFilter ( UnityEngine.Object  resource,
out UnityEngine.Object  filteredResource 
)
virtualinherited

Checks is the resource is can be casted to the HandlingType and handles it if possible.

Parameters
resourceInput resource for check.
Returns
Parameters
filteredResourceSub-resource that was selected by filter as the target. Will be registered in filter->resource pair in Resource collection.
Checks is the resource passing the filter. False if check is impossible.

Implements Doloro.DataManagement.DynamicResources.Search.IResourceFilter.

◆ OnResourceFilter()

override bool Doloro.DataManagement.DynamicResources.Search.SignatureFilter< T >.OnResourceFilter ( object  resource,
out UnityEngine.Object  filteredResource 
)
protectedvirtual

Checks the signature of filtering object with requested.

Parameters
resourceFiltering resource.
filteredResourceOutput resource that passed filter.
Returns
Result of filtering.

Reimplemented from Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.

Property Documentation

◆ GetStaticSignature

override string Doloro.DataManagement.DynamicResources.Search.SignatureFilter< T >.GetStaticSignature
get

Returns key in format: HandlingType.FullName:SingFilter:Bundle|..Key|ALL

Implements Doloro.DataManagement.DynamicResources.Search.IResourceFilter.

◆ HandlingType

virtual Type Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.HandlingType
getinherited

Type that will be handled by the query.

Could be:

  • Inherited from the UnityEngine.Component for UnityEngine.GameObject resources.
  • Could be interface or parent class for UnityEngine.Object resources.
The documentation for this class was generated from the following file: