pose_library/asset_browser.py

   1 # SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 """Functions for finding and working with Asset Browsers."""
   4
   5 from typing import Iterable, Optional, Tuple
   6
   7 import bpy
   8 from bpy_extras import asset_utils
   9
  10
  11 if "functions" not in locals():
  12     from . import functions
  13 else:
  14     import importlib
  15
  16     functions = importlib.reload(functions)
  17
  18
  19 def biggest_asset_browser_area(screen: bpy.types.Screen) -> Optional[bpy.types.Area]:
  20     """Return the asset browser Area that's largest on screen.
  21
  22     :param screen: context.window.screen
  23
  24     :return: the Area, or None if no Asset Browser area exists.
  25     """
  26
  27     def area_sorting_key(area: bpy.types.Area) -> Tuple[bool, int]:
  28         """Return area size in pixels."""
  29         return area.width * area.height
  30
  31     areas = list(suitable_areas(screen))
  32     if not areas:
  33         return None
  34
  35     return max(areas, key=area_sorting_key)
  36
  37
  38 def suitable_areas(screen: bpy.types.Screen) -> Iterable[bpy.types.Area]:
  39     """Generator, yield Asset Browser areas."""
  40
  41     for area in screen.areas:
  42         space_data = area.spaces[0]
  43         if not asset_utils.SpaceAssetInfo.is_asset_browser(space_data):
  44             continue
  45         yield area
  46
  47
  48 def area_from_context(context: bpy.types.Context) -> Optional[bpy.types.Area]:
  49     """Return an Asset Browser suitable for the given category.
  50
  51     Prefers the current Asset Browser if available, otherwise the biggest.
  52     """
  53
  54     space_data = context.space_data
  55     if asset_utils.SpaceAssetInfo.is_asset_browser(space_data):
  56         return context.area
  57
  58     # Try the current screen first.
  59     browser_area = biggest_asset_browser_area(context.screen)
  60     if browser_area:
  61         return browser_area
  62
  63     for win in context.window_manager.windows:
  64         if win.screen == context.screen:
  65             continue
  66         browser_area = biggest_asset_browser_area(win.screen)
  67         if browser_area:
  68             return browser_area
  69
  70     return None
  71
  72
  73 def activate_asset(asset: bpy.types.Action, asset_browser: bpy.types.Area, *, deferred: bool) -> None:
  74     """Select & focus the asset in the browser."""
  75
  76     space_data = asset_browser.spaces[0]
  77     assert asset_utils.SpaceAssetInfo.is_asset_browser(space_data)
  78     space_data.activate_asset_by_id(asset, deferred=deferred)
  79
  80
  81 def active_catalog_id(asset_browser: bpy.types.Area) -> str:
  82     """Return the ID of the catalog shown in the asset browser."""
  83     return params(asset_browser).catalog_id
  84
  85
  86 def params(asset_browser: bpy.types.Area) -> bpy.types.FileAssetSelectParams:
  87     """Return the asset browser parameters given its Area."""
  88     space_data = asset_browser.spaces[0]
  89     assert asset_utils.SpaceAssetInfo.is_asset_browser(space_data)
  90     return space_data.params
  91
  92
  93 def tag_redraw(screen: bpy.types.Screen) -> None:
  94     """Tag all asset browsers for redrawing."""
  95
  96     for area in suitable_areas(screen):
  97         area.tag_redraw()