Filtering shelf content


When opening the "filter" panel of the shelf, it is possible to access three type of query :

  1. Path : allow to refine the result of a search by a folder/folder structure.
  2. Usage : List all the possible usage that are available in the application
  3. Text query : Allow to add any other type of query freely (like custom keywords)

Multiple selections are allowed when defining a new search query.

Path

The path query allow to refine a query based on a path. The tree-view list all the available shelf (defined in the main preferences).
It is possible to therefore use it for filtering by custom shelf path or for specific sub-folders in the hierachy.

Usage

Usage define what a resource is and how to use it in Substance Painter. Some can be defined by the filetype of the ressource, some other don't. 
For example :

  • pbr.glsl : Shader file, can only be used at one place.
  • effect.sbsar : Substance file, can be a mask generator, a filter or even a material.

That's why it is important to specify properly the usage of a resource when importing it into the shelf, otherwise it will be impossible for the application to recognize it properly.

Text

The text query support multiple type of filtering, some being more advanced that the regular interface.
They can be enabled by typing the right keywords.

  • Available search types :
    • "n:" : name
    • "s:" : shelf (includes "session" and "project")
    • "p:" : path
    • "u:" : usage
  • Escaping : it is possible to either use "\" before the character that need to be escaped or use quotes instead, example :
    • a\ name\ with\ spaces
    • "a name with spaces"
  • Specific attributes (or group) : to search in specific attributes, prepend a 'or group' with a type specifier. Example :
    • n:a,b,c,d : name is a or b or c or d
  • Search behavior :
    • To filter specific usages, add the specific keyword to your search for example : "images ambient"
    • To add multiple request, use a comma ",", for example : "cobalt,gold" (if a comma is you used, the search will only show a resource that match both keyword at the same time)
    • To search for an exact name, use an exclamation point "!" at the end, example : di! (will return dirt but not drips, this keyword disable the fuzzy matching)
    • To exclude a pattern from a search, use an hyphen "-", for example : u:image  n:-normal (will return images that don't contain "normal")
  • Matching functions (pattern suffix) :
    • default : approximate matching (fuzzy)
    • contains : !
    • regex : #
    • equal : =
    • starts with : ^
    • ends with : &