Bumped version to 1.13.1

When using Blender Cloud Add-on 1.12 or older, Flamenco Server will
automatically convert the Manager settings to version 1. As a result,
upgrading is recommended but not required to keep working with a newer
Flamenco Server.

CHANGELOG.md

@@ -1,5 +1,42 @@
 # Blender Cloud changelog
 
+## Version 1.13 (in development)
+
+- Upgraded BAT to 1.1.1 for a compatibility fix with Blender 2.79
+- Flamenco: Support for Flamenco Manager settings versioning + for settings version 2.
+  When using Blender Cloud Add-on 1.12 or older, Flamenco Server will automatically convert the
+  Manager settings to version 1.
+
+
+## Version 1.12 (2019-03-25)
+
+- Flamenco: Change how progressive render tasks are created. Instead of the artist setting a fixed
+  number of sample chunks, they can now set a maximum number of samples for each render task.
+  Initial render tasks are created with a low number of samples, and subsequent tasks have an
+  increasing number of samples, up to the set maximum. The total number of samples of the final
+  render is still equal to the number of samples configured in the blend file.
+  Requires Flamenco Server 2.2 or newer.
+- Flamenco: Added a hidden "Submit & Quit" button. This button can be enabled in the add-on
+  preferences and and then be available on the Flamenco Render panel. Pressing the button will
+  silently close Blender after the job has been submitted to Flamenco (for example to click,
+  walk away, and free up memory for when the same machine is part of the render farm).
+- Flamenco: Name render jobs just 'thefile' instead of 'Render thefile.flamenco.blend'.
+  This makes the job overview on Flamenco Server cleaner.
+- Flamenco: support Shaman servers. See https://www.flamenco.io/docs/user_manual/shaman/
+  for more info.
+- Flamenco: The 'blender-video-chunks' job type now also allows MP4 and MOV video containers.
+
+
+## Version 1.11.1 (2019-01-04)
+
+- Bundled missing Texture Browser icons.
+
+
+## Version 1.11.0 (2019-01-04)
+
+- Texture Browser now works on Blender 2.8.
+- Blender Sync: Fixed compatibility issue with Blender 2.8.
+
 
 ## Version 1.10.0 (2019-01-02)
 

blender_cloud/__init__.py

@@ -21,7 +21,7 @@
 bl_info = {
     'name': 'Blender Cloud',
     "author": "Sybren A. Stüvel, Francesco Siddi, Inês Almeida, Antony Riakiotakis",
-    'version': (1, 10, 0),
+    'version': (1, 13, 1),
     'blender': (2, 80, 0),
     'location': 'Addon Preferences panel, and Ctrl+Shift+Alt+A anywhere for texture browser',
     'description': 'Texture library browser and Blender Sync. Requires the Blender ID addon '

blender_cloud/appdirs.py

@@ -511,7 +511,7 @@ if system == "win32":
         _get_win_folder = _get_win_folder_with_pywin32
     except ImportError:
         try:
-            from ctypes import windll
+            from ctypes import windll  # type: ignore
             _get_win_folder = _get_win_folder_with_ctypes
         except ImportError:
             try:

blender_cloud/async_loop.py

@@ -23,6 +23,7 @@ import traceback
 import concurrent.futures
 import logging
 import gc
+import typing
 
 import bpy
 
@@ -238,7 +239,7 @@ class AsyncModalOperatorMixin:
         self._stop_async_task()
         context.window_manager.event_timer_remove(self.timer)
 
-    def _new_async_task(self, async_task: asyncio.coroutine, future: asyncio.Future = None):
+    def _new_async_task(self, async_task: typing.Coroutine, future: asyncio.Future = None):
         """Stops the currently running async task, and starts another one."""
 
         self.log.debug('Setting up a new task %r, so any existing task must be stopped', async_task)

blender_cloud/blender.py

@@ -40,6 +40,11 @@ ADDON_NAME = 'blender_cloud'
 log = logging.getLogger(__name__)
 icons = None
 
+if bpy.app.version < (2, 80):
+    SYNC_SELECT_VERSION_ICON = 'DOTSDOWN'
+else:
+    SYNC_SELECT_VERSION_ICON = 'DOWNARROW_HLT'
+
 
 @functools.lru_cache()
 def factor(factor: float) -> dict:
@@ -262,6 +267,13 @@ class BlenderCloudPreferences(AddonPreferences):
         description='When enabled, Blender will open a webbrowser',
         default=True,
     )
+    flamenco_show_quit_after_submit_button = BoolProperty(
+        name='Show "Submit & Quit" button',
+        description='When enabled, next to the "Render on Flamenco" button there will be a button '
+                    '"Submit & Quit" that silently quits Blender after submitting the render job '
+                    'to Flamenco',
+        default=False,
+    )
 
     def draw(self, context):
         import textwrap
@@ -371,21 +383,20 @@ class BlenderCloudPreferences(AddonPreferences):
                           icon='TRIA_UP').action = 'PUSH'
 
         versions = bss.available_blender_versions
-        version = bss.version
         if bss.status in {'NONE', 'IDLE'}:
-            if not versions or not version:
+            if not versions:
                 row_pull.operator('pillar.sync',
                                   text='Find version to load',
                                   icon='TRIA_DOWN').action = 'REFRESH'
             else:
                 props = row_pull.operator('pillar.sync',
-                                          text='Load %s settings' % version,
+                                          text='Load %s settings' % bss.version,
                                           icon='TRIA_DOWN')
                 props.action = 'PULL'
-                props.blender_version = version
+                props.blender_version = bss.version
                 row_pull.operator('pillar.sync',
                                   text='',
-                                  icon='DOTSDOWN').action = 'SELECT'
+                                  icon=SYNC_SELECT_VERSION_ICON).action = 'SELECT'
         else:
             row_pull.label(text='Cloud Sync is running.')
 
@@ -398,7 +409,7 @@ class BlenderCloudPreferences(AddonPreferences):
         projects = bcp.available_projects
         project = bcp.project
         if bcp.status in {'NONE', 'IDLE'}:
-            if not projects or not project:
+            if not projects:
                 row_buttons.operator('pillar.projects',
                                      text='Find project to load',
                                      icon='FILE_REFRESH')
@@ -438,7 +449,7 @@ class BlenderCloudPreferences(AddonPreferences):
         manager_box = manager_split.row(align=True)
 
         if bcp.status in {'NONE', 'IDLE'}:
-            if not bcp.available_managers or not bcp.manager:
+            if not bcp.available_managers:
                 manager_box.operator('flamenco.managers',
                                      text='Find Flamenco Managers',
                                      icon='FILE_REFRESH')
@@ -484,6 +495,7 @@ class BlenderCloudPreferences(AddonPreferences):
 
         flamenco_box.prop(self, 'flamenco_relative_only')
         flamenco_box.prop(self, 'flamenco_open_browser_after_submit')
+        flamenco_box.prop(self, 'flamenco_show_quit_after_submit_button')
 
 
 class PillarCredentialsUpdate(pillar.PillarOperatorMixin,

blender_cloud/flamenco/__init__.py

@@ -69,6 +69,21 @@ VIDEO_CONTAINER_TO_EXTENSION = {
     'FLASH': '.flv',
 }
 
+SHAMAN_URL_SCHEMES = {'shaman://', 'shaman+http://', 'shaman+https://'}
+
+
+def scene_sample_count(scene) -> int:
+    """Determine nr of render samples for this scene."""
+    if scene.cycles.progressive == 'BRANCHED_PATH':
+        samples = scene.cycles.aa_samples
+    else:
+        samples = scene.cycles.samples
+
+    if scene.cycles.use_square_samples:
+        samples **= 2
+
+    return samples
+
 
 @pyside_cache('manager')
 def available_managers(self, context):
@@ -105,6 +120,24 @@ def manager_updated(self: 'FlamencoManagerGroup', context):
                                             pppm)
 
 
+def silently_quit_blender():
+    """Quit Blender without any confirmation popup."""
+
+    try:
+        prefs = bpy.context.preferences
+    except AttributeError:
+        # Backward compatibility with Blender < 2.80
+        prefs = bpy.context.user_preferences
+
+    try:
+        prefs.view.use_save_prompt = False
+    except AttributeError:
+        # Backward compatibility with Blender < 2.80
+        prefs.view.use_quit_dialog = False
+
+    bpy.ops.wm.quit_blender()
+
+
 class FlamencoManagerGroup(PropertyGroup):
     manager = EnumProperty(
         items=available_managers,
@@ -166,18 +199,26 @@ class FLAMENCO_OT_fmanagers(async_loop.AsyncModalOperatorMixin,
         from ..blender import preferences
 
         prefs = preferences()
+        mypref = self.mypref
 
         self.log.info('Going to fetch managers for user %s', self.user_id)
 
-        self.mypref.status = 'FETCHING'
+        mypref.status = 'FETCHING'
         params = {'where': '{"projects" : "%s"}' % prefs.project.project}
         managers = await pillar_call(Manager.all, params)
 
         # We need to convert to regular dicts before storing in ID properties.
         # Also don't store more properties than we need.
-        as_list = [{'_id': p['_id'], 'name': p['name']} for p in managers['_items']]
+        as_list = [{'_id': man['_id'], 'name': man['name']}
+                   for man in managers['_items']]
+
+        current_manager = mypref.manager
+        mypref.available_managers = as_list
+
+        # Prevent warnings about the current manager not being in the EnumProperty items.
+        if as_list and not any(man['_id'] == current_manager for man in as_list):
+            mypref.manager = as_list[0]['_id']
 
-        self.mypref.available_managers = as_list
         self.quit()
 
     def quit(self):
@@ -209,6 +250,8 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
     stop_upon_exception = True
     log = logging.getLogger('%s.FLAMENCO_OT_render' % __name__)
 
+    quit_after_submit = BoolProperty()
+
     async def async_execute(self, context):
         # Refuse to start if the file hasn't been saved. It's okay if
         # it's dirty, but we do need a filename and a location.
@@ -268,17 +311,10 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
 
         # Add extra settings specific to the job type
         if scene.flamenco_render_job_type == 'blender-render-progressive':
-            if scene.cycles.progressive == 'BRANCHED_PATH':
-                samples = scene.cycles.aa_samples
-            else:
-                samples = scene.cycles.samples
-
-            if scene.cycles.use_square_samples:
-                samples **= 2
-
-            settings['cycles_num_chunks'] = scene.flamenco_render_schunk_count
+            samples = scene_sample_count(scene)
+            settings['cycles_sample_cap'] = scene.flamenco_render_chunk_sample_cap
             settings['cycles_sample_count'] = samples
-            settings['format'] = 'EXR'
+            settings['format'] = 'OPEN_EXR'
 
         # Let Flamenco Server know whether we'll output images or video.
         output_format = settings.get('format') or scene.render.image_settings.file_format
@@ -302,31 +338,88 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
             self.quit()
             return
 
-        # BAT-pack the files to the destination directory.
-        outdir, outfile, missing_sources = await self.bat_pack(filepath)
-        if not outfile:
-            return
-        settings['filepath'] = manager.replace_path(outfile)
-
         # Create the job at Flamenco Server.
         context.window_manager.flamenco_status = 'COMMUNICATING'
-
         project_id = prefs.project.project
+        job_name = self._make_job_name(filepath)
         try:
             job_info = await create_job(self.user_id,
                                         project_id,
                                         manager_id,
                                         scene.flamenco_render_job_type,
                                         settings,
-                                        'Render %s' % filepath.name,
+                                        job_name,
                                         priority=scene.flamenco_render_job_priority,
                                         start_paused=scene.flamenco_start_paused)
         except Exception as ex:
-            self.report({'ERROR'}, 'Error creating Flamenco job: %s' % ex)
+            message = str(ex)
+            if isinstance(ex, pillarsdk.exceptions.BadRequest):
+                payload = ex.response.json()
+                try:
+                    message = payload['_error']['message']
+                except KeyError:
+                    pass
+            self.log.exception('Error creating Flamenco job')
+            self.report({'ERROR'}, 'Error creating Flamenco job: %s' % message)
             self.quit()
             return
 
-        # Store the job ID in a file in the output dir.
+        # BAT-pack the files to the destination directory.
+        job_id = job_info['_id']
+        outdir, outfile, missing_sources = await self.bat_pack(job_id, filepath)
+        if not outfile:
+            return
+
+        # Store the job ID in a file in the output dir, if we can.
+        # TODO: Make it possible to create this file first and then send it to BAT for packing.
+        if outdir is not None:
+            await self._create_jobinfo_json(
+                outdir, job_info, manager_id, project_id, missing_sources)
+
+        # Now that the files have been transfered, PATCH the job at the Manager
+        # to kick off the job compilation.
+        job_filepath = manager.replace_path(outfile)
+        self.log.info('Final file path: %s', job_filepath)
+        new_settings = {'filepath': job_filepath}
+        await self.compile_job(job_id, new_settings)
+
+        # We can now remove the local copy we made with bpy.ops.wm.save_as_mainfile().
+        # Strictly speaking we can already remove it after the BAT-pack, but it may come in
+        # handy in case of failures.
+        try:
+            self.log.info('Removing temporary file %s', filepath)
+            filepath.unlink()
+        except Exception as ex:
+            self.report({'ERROR'}, 'Unable to remove file: %s' % ex)
+            self.quit()
+            return
+
+        if prefs.flamenco_open_browser_after_submit:
+            import webbrowser
+            from urllib.parse import urljoin
+            from ..blender import PILLAR_WEB_SERVER_URL
+
+            url = urljoin(PILLAR_WEB_SERVER_URL, '/flamenco/jobs/%s/redir' % job_id)
+            webbrowser.open_new_tab(url)
+
+        # Do a final report.
+        if missing_sources:
+            names = (ms.name for ms in missing_sources)
+            self.report({'WARNING'}, 'Flamenco job created with missing files: %s' %
+                        '; '.join(names))
+        else:
+            self.report({'INFO'}, 'Flamenco job created.')
+
+        if self.quit_after_submit:
+            silently_quit_blender()
+
+        self.quit()
+
+    async def _create_jobinfo_json(self, outdir: Path, job_info: dict,
+                                   manager_id: str, project_id: str,
+                                   missing_sources: typing.List[Path]):
+        from ..blender import preferences
+        prefs = preferences()
         with open(str(outdir / 'jobinfo.json'), 'w', encoding='utf8') as outfile:
             import json
 
@@ -354,34 +447,16 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
             }
             json.dump(info, outfile, sort_keys=True, indent=4, cls=utils.JSONEncoder)
 
-        # We can now remove the local copy we made with bpy.ops.wm.save_as_mainfile().
-        # Strictly speaking we can already remove it after the BAT-pack, but it may come in
-        # handy in case of failures.
-        try:
-            self.log.info('Removing temporary file %s', filepath)
-            filepath.unlink()
-        except Exception as ex:
-            self.report({'ERROR'}, 'Unable to remove file: %s' % ex)
-            self.quit()
-            return
+    def _make_job_name(self, filepath: Path) -> str:
+        """Turn a file to render into the render job name."""
 
-        if prefs.flamenco_open_browser_after_submit:
-            import webbrowser
-            from urllib.parse import urljoin
-            from ..blender import PILLAR_WEB_SERVER_URL
+        job_name = filepath.name
+        if job_name.endswith('.blend'):
+            job_name = job_name[:-6]
+        if job_name.endswith('.flamenco'):
+            job_name = job_name[:-9]
 
-            url = urljoin(PILLAR_WEB_SERVER_URL, '/flamenco/jobs/%s/redir' % job_info['_id'])
-            webbrowser.open_new_tab(url)
-
-        # Do a final report.
-        if missing_sources:
-            names = (ms.name for ms in missing_sources)
-            self.report({'WARNING'}, 'Flamenco job created with missing files: %s' %
-                        '; '.join(names))
-        else:
-            self.report({'INFO'}, 'Flamenco job created.')
-
-        self.quit()
+        return job_name
 
     def validate_job_settings(self, context, settings: dict) -> bool:
         """Perform settings validations for the selected job type.
@@ -397,8 +472,9 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
                 self.report({'ERROR'}, 'Job type requires chunks of at least 10 frames.')
                 return False
 
-            if settings['output_file_extension'] != '.mkv':
-                self.report({'ERROR'}, 'Job type requires rendering to Matroska files.')
+            if settings['output_file_extension'] not in {'.mkv', '.mp4', '.mov'}:
+                self.report({'ERROR'}, 'Job type requires rendering to Matroska or '
+                                       'MP4 files, not %r.' % settings['output_file_extension'])
                 return False
 
         return True
@@ -422,6 +498,14 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
         old_use_overwrite = render.use_overwrite
         old_use_placeholder = render.use_placeholder
 
+        disable_denoiser = (context.scene.flamenco_render_job_type == 'blender-render-progressive'
+                            and render.engine == 'CYCLES')
+        if disable_denoiser:
+            use_denoising = [layer.cycles.use_denoising
+                             for layer in context.scene.view_layers]
+        else:
+            use_denoising = []
+
         try:
 
             # The file extension should be determined by the render settings, not necessarily
@@ -432,6 +516,10 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
             render.use_overwrite = False
             render.use_placeholder = False
 
+            if disable_denoiser:
+                for layer in context.scene.view_layers:
+                    layer.cycles.use_denoising = False
+
             filepath = Path(context.blend_data.filepath).with_suffix('.flamenco.blend')
             self.log.info('Saving copy to temporary file %s', filepath)
             bpy.ops.wm.save_as_mainfile(filepath=str(filepath),
@@ -443,16 +531,26 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
             render.use_overwrite = old_use_overwrite
             render.use_placeholder = old_use_placeholder
 
+            if disable_denoiser:
+                for denoise, layer in zip(use_denoising, context.scene.view_layers):
+                    layer.cycles.use_denoising = denoise
+
         return filepath
 
-    async def bat_pack(self, filepath: Path) -> (Path, typing.Optional[Path], typing.List[Path]):
+    async def bat_pack(self, job_id: str, filepath: Path) \
+            -> typing.Tuple[typing.Optional[Path], typing.Optional[PurePath], typing.List[Path]]:
         """BAT-packs the blendfile to the destination directory.
 
         Returns the path of the destination blend file.
 
+        :param job_id: the job ID given to us by Flamenco Server.
         :param filepath: the blend file to pack (i.e. the current blend file)
-        :returns: the destination directory, the destination blend file or None
-            if there were errors BAT-packing, and a list of missing paths.
+        :returns: A tuple of:
+            - The destination directory, or None if it does not exist on a
+              locally-reachable filesystem (for example when sending files to
+              a Shaman server).
+            - The destination blend file, or None if there were errors BAT-packing,
+            - A list of missing paths.
         """
 
         from datetime import datetime
@@ -460,19 +558,49 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
 
         prefs = preferences()
 
+        proj_abspath = bpy.path.abspath(prefs.cloud_project_local_path)
+        projdir = Path(proj_abspath).resolve()
+        exclusion_filter = (prefs.flamenco_exclude_filter or '').strip()
+        relative_only = prefs.flamenco_relative_only
+
+        self.log.debug('projdir: %s', projdir)
+
+        if any(prefs.flamenco_job_file_path.startswith(scheme) for scheme in SHAMAN_URL_SCHEMES):
+            endpoint, _ = bat_interface.parse_shaman_endpoint(prefs.flamenco_job_file_path)
+            self.log.info('Sending BAT pack to Shaman at %s', endpoint)
+            try:
+                outfile, missing_sources = await bat_interface.copy(
+                    bpy.context, filepath, projdir, '/', exclusion_filter,
+                    packer_class=bat_interface.ShamanPacker,
+                    relative_only=relative_only,
+                    endpoint=endpoint,
+                    checkout_id=job_id,
+                    manager_id=prefs.flamenco_manager.manager,
+                )
+            except bat_interface.FileTransferError as ex:
+                self.log.error('Could not transfer %d files, starting with %s',
+                               len(ex.files_remaining), ex.files_remaining[0])
+                self.report({'ERROR'}, 'Unable to transfer %d files' % len(ex.files_remaining))
+                self.quit()
+                return None, None, []
+            except bat_interface.Aborted:
+                self.log.warning('BAT Pack was aborted')
+                self.report({'WARNING'}, 'Aborted Flamenco file packing/transferring')
+                self.quit()
+                return None, None, []
+
+            bpy.context.window_manager.flamenco_status = 'DONE'
+            outfile = PurePath('{shaman}') / outfile
+            return None, outfile, missing_sources
+
         # Create a unique directory that is still more or less identifyable.
         # This should work better than a random ID.
         unique_dir = '%s-%s-%s' % (datetime.now().isoformat('-').replace(':', ''),
                                    self.db_user['username'],
                                    filepath.stem)
         outdir = Path(prefs.flamenco_job_file_path) / unique_dir
-        proj_abspath = bpy.path.abspath(prefs.cloud_project_local_path)
-        projdir = Path(proj_abspath).resolve()
-        exclusion_filter = (prefs.flamenco_exclude_filter or '').strip()
-        relative_only = prefs.flamenco_relative_only
 
         self.log.debug('outdir : %s', outdir)
-        self.log.debug('projdir: %s', projdir)
 
         try:
             outdir.mkdir(parents=True)
@@ -501,6 +629,20 @@ class FLAMENCO_OT_render(async_loop.AsyncModalOperatorMixin,
         bpy.context.window_manager.flamenco_status = 'DONE'
         return outdir, outfile, missing_sources
 
+    async def compile_job(self, job_id: str, new_settings: dict) -> None:
+        """Request Flamenco Server to start compiling the job."""
+
+        payload = {
+            'op': 'construct',
+            'settings': new_settings,
+        }
+
+        from .sdk import Job
+        from ..pillar import pillar_call
+
+        job = Job({'_id': job_id})
+        await pillar_call(job.patch, payload, caching=False)
+
 
 def scene_frame_range(context) -> str:
     """Returns the frame range string for the current scene."""
@@ -654,6 +796,18 @@ class FLAMENCO_OT_disable_output_path_override(Operator):
         return {'FINISHED'}
 
 
+class FLAMENCO_OT_set_recommended_sample_cap(Operator):
+    bl_idname = 'flamenco.set_recommended_sample_cap'
+    bl_label = 'Set Recommended Maximum Sample Count'
+    bl_description = 'Set the recommended maximum samples per render task'
+
+    sample_cap = IntProperty()
+
+    def execute(self, context):
+        context.scene.flamenco_render_chunk_sample_cap = self.sample_cap
+        return {'FINISHED'}
+
+
 async def create_job(user_id: str,
                      project_id: str,
                      manager_id: str,
@@ -671,7 +825,7 @@ async def create_job(user_id: str,
     from ..pillar import pillar_call
 
     job_attrs = {
-        'status': 'queued',
+        'status': 'waiting-for-files',
         'priority': priority,
         'name': job_name,
         'settings': job_settings,
@@ -830,6 +984,41 @@ class FLAMENCO_PT_render(bpy.types.Panel, FlamencoPollMixin):
         labeled_row.label(text='Job Type:')
         labeled_row.prop(context.scene, 'flamenco_render_job_type', text='')
 
+        # Job-type-specific options go directly below the job type selector.
+        box = layout.box()
+        if getattr(context.scene, 'flamenco_render_job_type', None) == 'blender-render-progressive':
+            if bpy.app.version < (2, 80):
+                box.alert = True
+                box.label(text='Progressive rendering requires Blender 2.80 or newer.',
+                          icon='ERROR')
+                # This isn't entirely fair, as Blender 2.79 could hypothetically
+                # be used to submit a job to farm running Blender 2.80.
+                return
+
+            if context.scene.render.engine != 'CYCLES':
+                box.alert = True
+                box.label(text='Progressive rendering requires Cycles', icon='ERROR')
+                return
+
+            box.prop(context.scene, 'flamenco_render_chunk_sample_cap')
+
+            sample_count = scene_sample_count(context.scene)
+            recommended_cap = sample_count // 4
+
+            split = box.split(**blender.factor(0.4))
+            split.label(text='Total Sample Count: %d' % sample_count)
+            props = split.operator('flamenco.set_recommended_sample_cap',
+                                   text='Recommended Max Samples per Task: %d' % recommended_cap)
+            props.sample_cap = recommended_cap
+
+            if any(layer.cycles.use_denoising for layer in context.scene.view_layers):
+                box.label(text='Progressive Rendering will disable Denoising.', icon='ERROR')
+
+            box.prop(context.scene, 'flamenco_render_fchunk_size',
+                     text='Minimum Frames per Task')
+        else:
+            box.prop(context.scene, 'flamenco_render_fchunk_size')
+
         labeled_row = layout.split(**blender.factor(0.25), align=True)
         labeled_row.label(text='Frame Range:')
         prop_btn_row = labeled_row.row(align=True)
@@ -837,12 +1026,8 @@ class FLAMENCO_PT_render(bpy.types.Panel, FlamencoPollMixin):
         prop_btn_row.operator('flamenco.scene_to_frame_range', text='', icon='ARROW_LEFTRIGHT')
 
         layout.prop(context.scene, 'flamenco_render_job_priority')
-        layout.prop(context.scene, 'flamenco_render_fchunk_size')
         layout.prop(context.scene, 'flamenco_start_paused')
 
-        if getattr(context.scene, 'flamenco_render_job_type', None) == 'blender-render-progressive':
-            layout.prop(context.scene, 'flamenco_render_schunk_count')
-
         paths_layout = layout.column(align=True)
 
         labeled_row = paths_layout.split(**blender.factor(0.25), align=True)
@@ -881,12 +1066,22 @@ class FLAMENCO_PT_render(bpy.types.Panel, FlamencoPollMixin):
             labeled_row.label(text='Effective Output Path:')
             labeled_row.label(text=str(render_output))
 
+        self.draw_odd_size_warning(layout, context.scene.render)
+
         # Show current status of Flamenco.
         flamenco_status = context.window_manager.flamenco_status
         if flamenco_status in {'IDLE', 'ABORTED', 'DONE'}:
-            layout.operator(FLAMENCO_OT_render.bl_idname,
-                            text='Render on Flamenco',
-                            icon='RENDER_ANIMATION')
+            if prefs.flamenco_show_quit_after_submit_button:
+                ui = layout.split(**blender.factor(0.75), align=True)
+            else:
+                ui = layout
+            ui.operator(FLAMENCO_OT_render.bl_idname,
+                        text='Render on Flamenco',
+                        icon='RENDER_ANIMATION').quit_after_submit = False
+            if prefs.flamenco_show_quit_after_submit_button:
+                ui.operator(FLAMENCO_OT_render.bl_idname,
+                            text='Submit & Quit',
+                            icon='RENDER_ANIMATION').quit_after_submit = True
             if bpy.app.debug:
                 layout.operator(FLAMENCO_OT_copy_files.bl_idname)
         elif flamenco_status == 'INVESTIGATING':
@@ -907,6 +1102,29 @@ class FLAMENCO_PT_render(bpy.types.Panel, FlamencoPollMixin):
         elif flamenco_status != 'IDLE' and context.window_manager.flamenco_status_txt:
             layout.label(text=context.window_manager.flamenco_status_txt)
 
+    def draw_odd_size_warning(self, layout, render):
+        render_width = render.resolution_x * render.resolution_percentage // 100
+        render_height = render.resolution_y * render.resolution_percentage // 100
+
+        odd_width = render_width % 2
+        odd_height = render_height % 2
+
+        if not odd_width and not odd_height:
+            return
+
+        box = layout.box()
+        box.alert = True
+
+        if odd_width and odd_height:
+            msg = 'Both X (%d) and Y (%d) resolution are' % (render_width, render_height)
+        elif odd_width:
+            msg = 'X resolution (%d) is' % render_width
+        else:
+            msg = 'Y resolution (%d) is' % render_height
+
+        box.label(text=msg + ' not divisible by 2.', icon='ERROR')
+        box.label(text='Any video rendered from these frames will be padded with black pixels.')
+
 
 def activate():
     """Activates draw callbacks, menu items etc. for Flamenco."""
@@ -960,21 +1178,25 @@ def register():
 
     scene = bpy.types.Scene
     scene.flamenco_render_fchunk_size = IntProperty(
-        name='Frame Chunk Size',
-        description='Maximum number of frames to render per task',
+        name='Frames per Task',
+        description='Number of frames to render per task. For progressive renders this is used '
+                    'when the sample limit is reached -- before that more frames are used',
         min=1,
         default=1,
     )
-    scene.flamenco_render_schunk_count = IntProperty(
-        name='Number of Sample Chunks',
-        description='Number of Cycles samples chunks to use per frame',
-        min=2,
-        default=3,
-        soft_max=10,
+    scene.flamenco_render_chunk_sample_cap = IntProperty(
+        name='Maximum Samples per Task',
+        description='Maximum number of samples per render task; a lower number creates more '
+                    'shorter-running tasks. Values between 1/10 and 1/4 of the total sample count '
+                    'seem sensible',
+        min=1,
+        soft_min=5,
+        default=100,
+        soft_max=1000,
     )
     scene.flamenco_render_frame_range = StringProperty(
         name='Frame Range',
-        description='Frames to render, in "printer range" notation'
+        description='Frames to render, in "printer range" notation',
     )
     scene.flamenco_render_job_type = EnumProperty(
         name='Job Type',
@@ -996,7 +1218,7 @@ def register():
 
     scene.flamenco_render_job_priority = IntProperty(
         name='Job Priority',
-        min=0,
+        min=1,
         default=50,
         max=100,
         description='Higher numbers mean higher priority'
@@ -1056,7 +1278,7 @@ def unregister():
             log.warning('Unable to unregister class %r, probably already unregistered', cls)
 
     for name in ('flamenco_render_fchunk_size',
-                 'flamenco_render_schunk_count',
+                 'flamenco_render_chunk_sample_cap',
                  'flamenco_render_frame_range',
                  'flamenco_render_job_type',
                  'flamenco_start_paused',

blender_cloud/flamenco/bat_interface.py

@@ -6,10 +6,11 @@ import pathlib
 import re
 import threading
 import typing
+import urllib.parse
 
 import bpy
 from blender_asset_tracer import pack
-from blender_asset_tracer.pack import progress, transfer
+from blender_asset_tracer.pack import progress, transfer, shaman
 
 log = logging.getLogger(__name__)
 
@@ -19,6 +20,7 @@ _packer_lock = threading.RLock()
 # For using in other parts of the add-on, so only this file imports BAT.
 Aborted = pack.Aborted
 FileTransferError = transfer.FileTransferError
+parse_shaman_endpoint = shaman.parse_endpoint
 
 
 class BatProgress(progress.Callback):
@@ -63,8 +65,8 @@ class BatProgress(progress.Callback):
         else:
             self._txt('Pack of %s done' % output_blendfile.name)
 
-    def pack_aborted(self):
-        self._txt('Aborted')
+    def pack_aborted(self, reason: str):
+        self._txt('Aborted: %s' % reason)
         self._status('ABORTED')
 
     def trace_blendfile(self, filename: pathlib.Path) -> None:
@@ -93,13 +95,46 @@ class BatProgress(progress.Callback):
         pass
 
 
+class ShamanPacker(shaman.ShamanPacker):
+    """Packer with support for getting an auth token from Flamenco Server."""
+
+    def __init__(self,
+                 bfile: pathlib.Path,
+                 project: pathlib.Path,
+                 target: str,
+                 endpoint: str,
+                 checkout_id: str,
+                 *,
+                 manager_id: str,
+                 **kwargs) -> None:
+        self.manager_id = manager_id
+        super().__init__(bfile, project, target, endpoint, checkout_id, **kwargs)
+
+    def _get_auth_token(self) -> str:
+        """get a token from Flamenco Server"""
+
+        from ..blender import PILLAR_SERVER_URL
+        from ..pillar import blender_id_subclient, uncached_session, SUBCLIENT_ID
+
+        url = urllib.parse.urljoin(PILLAR_SERVER_URL,
+                                   'flamenco/jwt/generate-token/%s' % self.manager_id)
+        auth_token = blender_id_subclient()['token']
+
+        resp = uncached_session.get(url, auth=(auth_token, SUBCLIENT_ID))
+        resp.raise_for_status()
+        return resp.text
+
+
 async def copy(context,
                base_blendfile: pathlib.Path,
                project: pathlib.Path,
-               target: pathlib.Path,
+               target: str,
                exclusion_filter: str,
                *,
-               relative_only: bool) -> typing.Tuple[pathlib.Path, typing.Set[pathlib.Path]]:
+               relative_only: bool,
+               packer_class=pack.Packer,
+               **packer_args) \
+        -> typing.Tuple[pathlib.Path, typing.Set[pathlib.Path]]:
     """Use BAT🦇 to copy the given file and dependencies to the target location.
 
     :raises: FileTransferError if a file couldn't be transferred.
@@ -108,11 +143,11 @@ async def copy(context,
     global _running_packer
 
     loop = asyncio.get_event_loop()
-
     wm = bpy.context.window_manager
 
-    with pack.Packer(base_blendfile, project, target, compress=True, relative_only=relative_only) \
-            as packer:
+    packer = packer_class(base_blendfile, project, target,
+                          compress=True, relative_only=relative_only, **packer_args)
+    with packer:
         with _packer_lock:
             if exclusion_filter:
                 # There was a mistake in an older version of the property tooltip,

blender_cloud/flamenco/sdk.py

@@ -1,5 +1,6 @@
 import functools
 import pathlib
+import typing
 
 from pillarsdk.resource import List, Find, Create
 
@@ -9,8 +10,19 @@ class Manager(List, Find):
     path = 'flamenco/managers'
     PurePlatformPath = pathlib.PurePath
 
-    @functools.lru_cache()
-    def _sorted_path_replacements(self) -> list:
+    @functools.lru_cache(maxsize=1)
+    def _path_replacements(self) -> list:
+        """Defer to _path_replacements_vN() to get path replacement vars."""
+        settings_version = self.settings_version or 1
+        try:
+            settings_func = getattr(self, '_path_replacements_v%d' % settings_version)
+        except AttributeError:
+            raise RuntimeError('This manager has unsupported settings version %d; '
+                               'upgrade Blender Cloud add-on')
+
+        return settings_func()
+
+    def _path_replacements_v1(self) -> typing.List[typing.Tuple[str, str]]:
         import platform
 
         if self.path_replacement is None:
@@ -18,22 +30,51 @@ class Manager(List, Find):
 
         items = self.path_replacement.to_dict().items()
 
-        def by_length(item):
-            return -len(item[0]), item[0]
-
         this_platform = platform.system().lower()
         return [(varname, platform_replacements[this_platform])
-                for varname, platform_replacements in sorted(items, key=by_length)
+                for varname, platform_replacements in items
                 if this_platform in platform_replacements]
 
+    def _path_replacements_v2(self) -> typing.List[typing.Tuple[str, str]]:
+        import platform
+
+        if not self.variables:
+            return []
+
+        this_platform = platform.system().lower()
+        audiences = {'users', 'all'}
+
+        replacements = []
+        for var_name, variable in self.variables.to_dict().items():
+            # Path replacement requires bidirectional variables.
+            if variable.get('direction') != 'twoway':
+                continue
+
+            for var_value in variable.get('values', []):
+                if var_value.get('audience') not in audiences:
+                    continue
+                if var_value.get('platform', '').lower() != this_platform:
+                    continue
+
+                replacements.append((var_name, var_value.get('value')))
+        return replacements
+
     def replace_path(self, some_path: pathlib.PurePath) -> str:
         """Performs path variable replacement.
 
         Tries to find platform-specific path prefixes, and replaces them with
         variables.
         """
+        assert isinstance(some_path, pathlib.PurePath), \
+            'some_path should be a PurePath, not %r' % some_path
 
-        for varname, path in self._sorted_path_replacements():
+        def by_length(item):
+            return -len(item[1]), item[1]
+
+        replacements = self._path_replacements()
+        replacements.sort(key=by_length)
+
+        for varname, path in replacements:
             replacement = self.PurePlatformPath(path)
             try:
                 relpath = some_path.relative_to(replacement)
@@ -52,3 +93,14 @@ class Job(List, Find, Create):
     """
     path = 'flamenco/jobs'
     ensure_query_projections = {'project': 1}
+
+    def patch(self, payload: dict, api=None):
+        import pillarsdk.utils
+
+        api = api or self.api
+
+        url = pillarsdk.utils.join_url(self.path, str(self['_id']))
+        headers = pillarsdk.utils.merge_dict(self.http_headers(),
+                                             {'Content-Type': 'application/json'})
+        response = api.patch(url, payload, headers=headers)
+        return response

blender_cloud/pillar.py

@@ -26,7 +26,8 @@ from contextlib import closing, contextmanager
 import urllib.parse
 import pathlib
 
-import requests
+import requests.adapters
+import requests.packages.urllib3.util.retry
 import requests.structures
 import pillarsdk
 import pillarsdk.exceptions
@@ -42,7 +43,16 @@ RFC1123_DATE_FORMAT = '%a, %d %b %Y %H:%M:%S GMT'
 
 _pillar_api = {}  # will become a mapping from bool (cached/non-cached) to pillarsdk.Api objects.
 log = logging.getLogger(__name__)
+
+_retries = requests.packages.urllib3.util.retry.Retry(
+    total=10,
+    backoff_factor=0.05,
+)
+_http_adapter = requests.adapters.HTTPAdapter(max_retries=_retries)
 uncached_session = requests.session()
+uncached_session.mount('https://', _http_adapter)
+uncached_session.mount('http://', _http_adapter)
+
 _testing_blender_id_profile = None  # Just for testing, overrides what is returned by blender_id_profile.
 _downloaded_urls = set()  # URLs we've downloaded this Blender session.
 
@@ -96,18 +106,18 @@ class CloudPath(pathlib.PurePosixPath):
     def project_uuid(self) -> str:
         assert self.parts[0] == '/'
         if len(self.parts) <= 1:
-            return None
+            return ''
         return self.parts[1]
 
     @property
-    def node_uuids(self) -> list:
+    def node_uuids(self) -> tuple:
         assert self.parts[0] == '/'
         return self.parts[2:]
 
     @property
     def node_uuid(self) -> str:
         if len(self.parts) <= 2:
-            return None
+            return ''
 
         return self.parts[-1]
 

blender_cloud/project_specific.py

@@ -114,7 +114,7 @@ def handle_project_update(_=None, _2=None):
             except TypeError:
                 log.warning('manager %s for this project could not be found', flamenco_manager_id)
         elif prefs.flamenco_manager.available_managers:
-            prefs.flamenco_manager.manager = prefs.flamenco_manager.available_managers[0]
+            prefs.flamenco_manager.manager = prefs.flamenco_manager.available_managers[0]['_id']
 
 
 def store(_=None, _2=None):

blender_cloud/settings_sync.py

@@ -25,6 +25,7 @@ import functools
 import logging
 import pathlib
 import tempfile
+import typing
 import shutil
 
 import bpy
@@ -100,7 +101,7 @@ async def find_sync_group_id(home_project_id: str,
                              user_id: str,
                              blender_version: str,
                              *,
-                             may_create=True) -> str:
+                             may_create=True) -> typing.Tuple[str, str]:
     """Finds the group node in which to store sync assets.
 
     If the group node doesn't exist and may_create=True, it creates it.
@@ -122,7 +123,7 @@ async def find_sync_group_id(home_project_id: str,
 
     if not may_create and sync_group is None:
         log.info("Sync folder doesn't exist, and not creating it either.")
-        return None, None
+        return '', ''
 
     # Find/create the sub-group for the requested Blender version
     try:
@@ -144,7 +145,7 @@ async def find_sync_group_id(home_project_id: str,
     if not may_create and sub_sync_group is None:
         log.info("Sync folder for Blender version %s doesn't exist, "
                  "and not creating it either.", blender_version)
-        return sync_group['_id'], None
+        return sync_group['_id'], ''
 
     return sync_group['_id'], sub_sync_group['_id']
 
@@ -203,9 +204,9 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
     bl_description = 'Synchronises Blender settings with Blender Cloud'
 
     log = logging.getLogger('bpy.ops.%s' % bl_idname)
-    home_project_id = None
-    sync_group_id = None  # top-level sync group node ID
-    sync_group_versioned_id = None  # sync group node ID for the given Blender version.
+    home_project_id = ''
+    sync_group_id = ''  # top-level sync group node ID
+    sync_group_versioned_id = ''  # sync group node ID for the given Blender version.
 
     action = bpy.props.EnumProperty(
         items=[
@@ -387,12 +388,12 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
         """Loads files from the Pillar server."""
 
         # If the sync group node doesn't exist, offer a list of groups that do.
-        if self.sync_group_id is None:
+        if not self.sync_group_id:
             self.bss_report({'ERROR'},
                             'There are no synced Blender settings in your Blender Cloud.')
             return
 
-        if self.sync_group_versioned_id is None:
+        if not self.sync_group_versioned_id:
             self.bss_report({'ERROR'}, 'Therre are no synced Blender settings for version %s' %
                             self.blender_version)
             return
@@ -415,11 +416,20 @@ class PILLAR_OT_sync(pillar.PillarOperatorMixin,
         bss = bpy.context.window_manager.blender_sync_status
         bss.available_blender_versions = versions
 
-        if versions:
+        if not versions:
             # There are versions to sync, so we can remove the status message.
             # However, if there aren't any, the status message shows why, and
             # shouldn't be erased.
-            self.bss_report({'INFO'}, '')
+            return
+
+        # Prevent warnings that the current value of the EnumProperty isn't valid.
+        current_version = '%d.%d' % bpy.app.version[:2]
+        if current_version in versions:
+            bss.version = current_version
+        else:
+            bss.version = versions[0]
+
+        self.bss_report({'INFO'}, '')
 
     async def download_settings_file(self, fname: str, temp_dir: str):
         config_dir = pathlib.Path(bpy.utils.user_resource('CONFIG'))

blender_cloud/texture_browser/__init__.py

@@ -18,249 +18,35 @@
 
 import asyncio
 import logging
-import threading
 import os
+import threading
+import typing
 
 import bpy
 import bgl
-import blf
 
 import pillarsdk
-from . import async_loop, pillar, cache, blender, utils
+from .. import async_loop, pillar, cache, blender, utils
+from . import menu_item as menu_item_mod  # so that we can have menu items called 'menu_item'
+from . import nodes
+
+if bpy.app.version < (2, 80):
+    from . import draw_27 as draw
+else:
+    from . import draw
 
 REQUIRED_ROLES_FOR_TEXTURE_BROWSER = {'subscriber', 'demo'}
 MOUSE_SCROLL_PIXELS_PER_TICK = 50
 
-ICON_WIDTH = 128
-ICON_HEIGHT = 128
 TARGET_ITEM_WIDTH = 400
 TARGET_ITEM_HEIGHT = 128
 ITEM_MARGIN_X = 5
 ITEM_MARGIN_Y = 5
 ITEM_PADDING_X = 5
 
-library_path = '/tmp'
-library_icons_path = os.path.join(os.path.dirname(__file__), "icons")
 log = logging.getLogger(__name__)
 
 
-class SpecialFolderNode(pillarsdk.Node):
-    NODE_TYPE = 'SPECIAL'
-
-
-class UpNode(SpecialFolderNode):
-    NODE_TYPE = 'UP'
-
-    def __init__(self):
-        super().__init__()
-        self['_id'] = 'UP'
-        self['node_type'] = self.NODE_TYPE
-
-
-class ProjectNode(SpecialFolderNode):
-    NODE_TYPE = 'PROJECT'
-
-    def __init__(self, project):
-        super().__init__()
-
-        assert isinstance(project, pillarsdk.Project), 'wrong type for project: %r' % type(project)
-
-        self.merge(project.to_dict())
-        self['node_type'] = self.NODE_TYPE
-
-
-class MenuItem:
-    """GUI menu item for the 3D View GUI."""
-
-    icon_margin_x = 4
-    icon_margin_y = 4
-    text_margin_x = 6
-
-    text_size = 12
-    text_size_small = 10
-
-    DEFAULT_ICONS = {
-        'FOLDER': os.path.join(library_icons_path, 'folder.png'),
-        'SPINNER': os.path.join(library_icons_path, 'spinner.png'),
-        'ERROR': os.path.join(library_icons_path, 'error.png'),
-    }
-
-    FOLDER_NODE_TYPES = {'group_texture', 'group_hdri', UpNode.NODE_TYPE, ProjectNode.NODE_TYPE}
-    SUPPORTED_NODE_TYPES = {'texture', 'hdri'}.union(FOLDER_NODE_TYPES)
-
-    def __init__(self, node, file_desc, thumb_path: str, label_text):
-        self.log = logging.getLogger('%s.MenuItem' % __name__)
-        if node['node_type'] not in self.SUPPORTED_NODE_TYPES:
-            self.log.info('Invalid node type in node: %s', node)
-            raise TypeError('Node of type %r not supported; supported are %r.' % (
-                node['node_type'], self.SUPPORTED_NODE_TYPES))
-
-        assert isinstance(node, pillarsdk.Node), 'wrong type for node: %r' % type(node)
-        assert isinstance(node['_id'], str), 'wrong type for node["_id"]: %r' % type(node['_id'])
-        self.node = node  # pillarsdk.Node, contains 'node_type' key to indicate type
-        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
-        self.label_text = label_text
-        self.small_text = self._small_text_from_node()
-        self._thumb_path = ''
-        self.icon = None
-        self._is_folder = node['node_type'] in self.FOLDER_NODE_TYPES
-        self._is_spinning = False
-
-        # Determine sorting order.
-        # by default, sort all the way at the end and folders first.
-        self._order = 0 if self._is_folder else 10000
-        if node and node.properties and node.properties.order is not None:
-            self._order = node.properties.order
-
-        self.thumb_path = thumb_path
-
-        # Updated when drawing the image
-        self.x = 0
-        self.y = 0
-        self.width = 0
-        self.height = 0
-
-    def _small_text_from_node(self) -> str:
-        """Return the components of the texture (i.e. which map types are available)."""
-
-        if not self.node:
-            return ''
-
-        try:
-            node_files = self.node.properties.files
-        except AttributeError:
-            # Happens for nodes that don't have .properties.files.
-            return ''
-        if not node_files:
-            return ''
-
-        map_types = {f.map_type for f in node_files if f.map_type}
-        map_types.discard('color')  # all textures have colour
-        if not map_types:
-            return ''
-        return ', '.join(sorted(map_types))
-
-    def sort_key(self):
-        """Key for sorting lists of MenuItems."""
-        return self._order, self.label_text
-
-    @property
-    def thumb_path(self) -> str:
-        return self._thumb_path
-
-    @thumb_path.setter
-    def thumb_path(self, new_thumb_path: str):
-        self._is_spinning = new_thumb_path == 'SPINNER'
-
-        self._thumb_path = self.DEFAULT_ICONS.get(new_thumb_path, new_thumb_path)
-        if self._thumb_path:
-            self.icon = bpy.data.images.load(filepath=self._thumb_path)
-        else:
-            self.icon = None
-
-    @property
-    def node_uuid(self) -> str:
-        return self.node['_id']
-
-    def represents(self, node) -> bool:
-        """Returns True iff this MenuItem represents the given node."""
-
-        node_uuid = node['_id']
-        return self.node_uuid == node_uuid
-
-    def update(self, node, file_desc, thumb_path: str, label_text=None):
-        # We can get updated information about our Node, but a MenuItem should
-        # always represent one node, and it shouldn't be shared between nodes.
-        if self.node_uuid != node['_id']:
-            raise ValueError("Don't change the node ID this MenuItem reflects, "
-                             "just create a new one.")
-        self.node = node
-        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
-        self.thumb_path = thumb_path
-
-        if label_text is not None:
-            self.label_text = label_text
-
-        if thumb_path == 'ERROR':
-            self.small_text = 'This open is broken'
-        else:
-            self.small_text = self._small_text_from_node()
-
-    @property
-    def is_folder(self) -> bool:
-        return self._is_folder
-
-    @property
-    def is_spinning(self) -> bool:
-        return self._is_spinning
-
-    def update_placement(self, x, y, width, height):
-        """Use OpenGL to draw this one menu item."""
-
-        self.x = x
-        self.y = y
-        self.width = width
-        self.height = height
-
-    def draw(self, highlighted: bool):
-        bgl.glEnable(bgl.GL_BLEND)
-        if highlighted:
-            bgl.glColor4f(0.555, 0.555, 0.555, 0.8)
-        else:
-            bgl.glColor4f(0.447, 0.447, 0.447, 0.8)
-
-        bgl.glRectf(self.x, self.y, self.x + self.width, self.y + self.height)
-
-        texture = self.icon
-        if texture:
-            err = texture.gl_load(filter=bgl.GL_NEAREST, mag=bgl.GL_NEAREST)
-            assert not err, 'OpenGL error: %i' % err
-
-        bgl.glColor4f(0.0, 0.0, 1.0, 0.5)
-        # bgl.glLineWidth(1.5)
-
-        # ------ TEXTURE ---------#
-        if texture:
-            bgl.glBindTexture(bgl.GL_TEXTURE_2D, texture.bindcode[0])
-            bgl.glEnable(bgl.GL_TEXTURE_2D)
-        bgl.glBlendFunc(bgl.GL_SRC_ALPHA, bgl.GL_ONE_MINUS_SRC_ALPHA)
-
-        bgl.glColor4f(1, 1, 1, 1)
-        bgl.glBegin(bgl.GL_QUADS)
-        bgl.glTexCoord2d(0, 0)
-        bgl.glVertex2d(self.x + self.icon_margin_x, self.y)
-        bgl.glTexCoord2d(0, 1)
-        bgl.glVertex2d(self.x + self.icon_margin_x, self.y + ICON_HEIGHT)
-        bgl.glTexCoord2d(1, 1)
-        bgl.glVertex2d(self.x + self.icon_margin_x + ICON_WIDTH, self.y + ICON_HEIGHT)
-        bgl.glTexCoord2d(1, 0)
-        bgl.glVertex2d(self.x + self.icon_margin_x + ICON_WIDTH, self.y)
-        bgl.glEnd()
-        bgl.glDisable(bgl.GL_TEXTURE_2D)
-        bgl.glDisable(bgl.GL_BLEND)
-
-        if texture:
-            texture.gl_free()
-
-        # draw some text
-        font_id = 0
-        text_dpi = blender.ctx_preferences().system.dpi
-        text_x = self.x + self.icon_margin_x + ICON_WIDTH + self.text_margin_x
-        text_y = self.y + ICON_HEIGHT * 0.5 - 0.25 * self.text_size
-        blf.position(font_id, text_x, text_y, 0)
-        blf.size(font_id, self.text_size, text_dpi)
-        blf.draw(font_id, self.label_text)
-
-        # draw the small text
-        bgl.glColor4f(1.0, 1.0, 1.0, 0.5)
-        blf.size(font_id, self.text_size_small, text_dpi)
-        blf.position(font_id, text_x, self.y + 0.5 * self.text_size_small, 0)
-        blf.draw(font_id, self.small_text)
-
-    def hits(self, mouse_x: int, mouse_y: int) -> bool:
-        return self.x < mouse_x < self.x + self.width and self.y < mouse_y < self.y + self.height
-
-
 class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                           async_loop.AsyncModalOperatorMixin,
                           bpy.types.Operator):
@@ -273,17 +59,17 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
     project_name = ''
 
     # This contains a stack of Node objects that lead up to the currently browsed node.
-    path_stack = []
+    path_stack = []  # type: typing.List[pillarsdk.Node]
 
     # This contains a stack of MenuItem objects that lead up to the currently browsed node.
-    menu_item_stack = []
+    menu_item_stack = []  # type: typing.List[menu_item_mod.MenuItem]
 
     timer = None
     log = logging.getLogger('%s.BlenderCloudBrowser' % __name__)
 
     _menu_item_lock = threading.Lock()
-    current_display_content = []  # list of MenuItems currently displayed
-    loaded_images = set()
+    current_display_content = []  # type: typing.List[menu_item_mod.MenuItem]
+    loaded_images = set()  # type: typing.Set[str]
     thumbnails_cache = ''
     maximized_area = False
 
@@ -422,7 +208,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
 
         bpy.context.window.cursor_set('HAND')
 
-    def descend_node(self, menu_item: MenuItem):
+    def descend_node(self, menu_item: menu_item_mod.MenuItem):
         """Descends the node hierarchy by visiting this menu item's node.
 
         Also keeps track of the current node, so that we know where the "up" button should go.
@@ -431,7 +217,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         node = menu_item.node
         assert isinstance(node, pillarsdk.Node), 'Wrong type %s' % node
 
-        if isinstance(node, UpNode):
+        if isinstance(node, nodes.UpNode):
             # Going up.
             self.log.debug('Going up to %r', self.current_path)
             self.current_path = self.current_path.parent
@@ -443,7 +229,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                 self.project_name = ''
         else:
             # Going down, keep track of where we were
-            if isinstance(node, ProjectNode):
+            if isinstance(node, nodes.ProjectNode):
                 self.project_name = node['name']
 
             self.current_path /= node['_id']
@@ -486,13 +272,14 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         self.loaded_images.clear()
         self.current_display_content.clear()
 
-    def add_menu_item(self, *args) -> MenuItem:
-        menu_item = MenuItem(*args)
+    def add_menu_item(self, *args) -> menu_item_mod.MenuItem:
+        menu_item = menu_item_mod.MenuItem(*args)
 
         # Just make this thread-safe to be on the safe side.
         with self._menu_item_lock:
             self.current_display_content.append(menu_item)
-            self.loaded_images.add(menu_item.icon.filepath_raw)
+            if menu_item.icon is not None:
+                self.loaded_images.add(menu_item.icon.filepath_raw)
 
         self.sort_menu()
 
@@ -520,7 +307,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             return
 
         with self._menu_item_lock:
-            self.current_display_content.sort(key=MenuItem.sort_key)
+            self.current_display_content.sort(key=menu_item_mod.MenuItem.sort_key)
 
     async def async_download_previews(self):
         self._state = 'BROWSING'
@@ -550,17 +337,17 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             self.log.debug('No node UUID and no project UUID, listing available projects')
             children = await pillar.get_texture_projects()
             for proj_dict in children:
-                self.add_menu_item(ProjectNode(proj_dict), None, 'FOLDER', proj_dict['name'])
+                self.add_menu_item(nodes.ProjectNode(proj_dict), None, 'FOLDER', proj_dict['name'])
             return
 
         # Make sure we can go up again.
-        self.add_menu_item(UpNode(), None, 'FOLDER', '.. up ..')
+        self.add_menu_item(nodes.UpNode(), None, 'FOLDER', '.. up ..')
 
         # Download all child nodes
         self.log.debug('Iterating over child nodes of %r', self.current_path)
         for child in children:
             # print('  - %(_id)s = %(name)s' % child)
-            if child['node_type'] not in MenuItem.SUPPORTED_NODE_TYPES:
+            if child['node_type'] not in menu_item_mod.MenuItem.SUPPORTED_NODE_TYPES:
                 self.log.debug('Skipping node of type %r', child['node_type'])
                 continue
             self.add_menu_item(child, None, 'FOLDER', child['name'])
@@ -610,12 +397,9 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
             drawer(context)
 
         # For debugging: draw the state
-        font_id = 0
-        bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-        blf.size(font_id, 20, 72)
-        blf.position(font_id, 5, 5, 0)
-        blf.draw(font_id, '%s %s' % (self._state, self.project_name))
-        bgl.glDisable(bgl.GL_BLEND)
+        draw.text((5, 5),
+                  '%s %s' % (self._state, self.project_name),
+                  rgba=(1.0, 1.0, 1.0, 1.0), fsize=12)
 
     @staticmethod
     def _window_region(context):
@@ -626,6 +410,12 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
 
     def _draw_browser(self, context):
         """OpenGL drawing code for the BROWSING state."""
+        from . import draw
+
+        if not self.current_display_content:
+            self._draw_text_on_colour(context, "Communicating with Blender Cloud",
+                                      (0.0, 0.0, 0.0, 0.6))
+            return
 
         window_region = self._window_region(context)
         content_width = window_region.width - ITEM_MARGIN_X * 2
@@ -643,46 +433,33 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         block_height = item_height + ITEM_MARGIN_Y
 
         bgl.glEnable(bgl.GL_BLEND)
-        bgl.glColor4f(0.0, 0.0, 0.0, 0.6)
-        bgl.glRectf(0, 0, window_region.width, window_region.height)
+        draw.aabox((0, 0), (window_region.width, window_region.height),
+                   (0.0, 0.0, 0.0, 0.6))
 
-        if self.current_display_content:
-            bottom_y = float('inf')
+        bottom_y = float('inf')
 
-            # The -1 / +2 are for extra rows that are drawn only half at the top/bottom.
-            first_item_idx = max(0, int(-self.scroll_offset // block_height - 1) * col_count)
-            items_per_page = int(content_height // item_height + 2) * col_count
-            last_item_idx = first_item_idx + items_per_page
+        # The -1 / +2 are for extra rows that are drawn only half at the top/bottom.
+        first_item_idx = max(0, int(-self.scroll_offset // block_height - 1) * col_count)
+        items_per_page = int(content_height // item_height + 2) * col_count
+        last_item_idx = first_item_idx + items_per_page
 
-            for item_idx, item in enumerate(self.current_display_content):
-                x = content_x + (item_idx % col_count) * block_width
-                y = content_y - (item_idx // col_count) * block_height - self.scroll_offset
+        for item_idx, item in enumerate(self.current_display_content):
+            x = content_x + (item_idx % col_count) * block_width
+            y = content_y - (item_idx // col_count) * block_height - self.scroll_offset
 
-                item.update_placement(x, y, item_width, item_height)
+            item.update_placement(x, y, item_width, item_height)
 
-                if first_item_idx <= item_idx < last_item_idx:
-                    # Only draw if the item is actually on screen.
-                    item.draw(highlighted=item.hits(self.mouse_x, self.mouse_y))
+            if first_item_idx <= item_idx < last_item_idx:
+                # Only draw if the item is actually on screen.
+                item.draw(highlighted=item.hits(self.mouse_x, self.mouse_y))
 
-                bottom_y = min(y, bottom_y)
-            self.scroll_offset_space_left = window_region.height - bottom_y
-            self.scroll_offset_max = (self.scroll_offset -
-                                      self.scroll_offset_space_left +
-                                      0.25 * block_height)
-
-        else:
-            font_id = 0
-            text = "Communicating with Blender Cloud"
-            bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-            blf.size(font_id, 20, 72)
-            text_width, text_height = blf.dimensions(font_id, text)
-            blf.position(font_id,
-                         content_x + content_width * 0.5 - text_width * 0.5,
-                         content_y - content_height * 0.3 + text_height * 0.5, 0)
-            blf.draw(font_id, text)
+            bottom_y = min(y, bottom_y)
+        self.scroll_offset_space_left = window_region.height - bottom_y
+        self.scroll_offset_max = (self.scroll_offset -
+                                  self.scroll_offset_space_left +
+                                  0.25 * block_height)
 
         bgl.glDisable(bgl.GL_BLEND)
-        # bgl.glColor4f(0.0, 0.0, 0.0, 1.0)
 
     def _draw_downloading(self, context):
         """OpenGL drawing code for the DOWNLOADING_TEXTURE state."""
@@ -705,21 +482,15 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                                   'Initializing',
                                   (0.0, 0.0, 0.2, 0.6))
 
-    def _draw_text_on_colour(self, context, text, bgcolour):
+    def _draw_text_on_colour(self, context, text: str, bgcolour):
         content_height, content_width = self._window_size(context)
+
         bgl.glEnable(bgl.GL_BLEND)
-        bgl.glColor4f(*bgcolour)
-        bgl.glRectf(0, 0, content_width, content_height)
 
-        font_id = 0
-        bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-        blf.size(font_id, 20, 72)
-        text_width, text_height = blf.dimensions(font_id, text)
+        draw.aabox((0, 0), (content_width, content_height), bgcolour)
+        draw.text((content_width * 0.5, content_height * 0.7),
+                  text, fsize=20, align='C')
 
-        blf.position(font_id,
-                     content_width * 0.5 - text_width * 0.5,
-                     content_height * 0.7 + text_height * 0.5, 0)
-        blf.draw(font_id, text)
         bgl.glDisable(bgl.GL_BLEND)
 
     def _window_size(self, context):
@@ -736,33 +507,21 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
         content_height, content_width = self._window_size(context)
 
         bgl.glEnable(bgl.GL_BLEND)
-        bgl.glColor4f(0.2, 0.0, 0.0, 0.6)
-        bgl.glRectf(0, 0, content_width, content_height)
+        draw.aabox((0, 0), (content_width, content_height), (0.2, 0.0, 0.0, 0.6))
 
-        font_id = 0
         ex = self.async_task.exception()
         if isinstance(ex, pillar.UserNotLoggedInError):
             ex_msg = 'You are not logged in on Blender ID. Please log in at User Preferences, ' \
-                     'System, Blender ID.'
+                     'Add-ons, Blender ID Authentication.'
         else:
             ex_msg = str(ex)
             if not ex_msg:
                 ex_msg = str(type(ex))
         text = "An error occurred:\n%s" % ex_msg
-        lines = textwrap.wrap(text)
+        lines = textwrap.wrap(text, width=100)
 
-        bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
-        blf.size(font_id, 20, 72)
-        _, text_height = blf.dimensions(font_id, 'yhBp')
+        draw.text((content_width * 0.1, content_height * 0.9), lines, fsize=16)
 
-        def position(line_nr):
-            blf.position(font_id,
-                         content_width * 0.1,
-                         content_height * 0.8 - line_nr * text_height, 0)
-
-        for line_idx, line in enumerate(lines):
-            position(line_idx)
-            blf.draw(font_id, line)
         bgl.glDisable(bgl.GL_BLEND)
 
     def _draw_subscribe(self, context):
@@ -775,7 +534,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
                                   'Click to renew your Blender Cloud subscription',
                                   (0.0, 0.0, 0.2, 0.6))
 
-    def get_clicked(self) -> MenuItem:
+    def get_clicked(self) -> typing.Optional[menu_item_mod.MenuItem]:
 
         for item in self.current_display_content:
             if item.hits(self.mouse_x, self.mouse_y):
@@ -783,7 +542,7 @@ class BlenderCloudBrowser(pillar.PillarOperatorMixin,
 
         return None
 
-    def handle_item_selection(self, context, item: MenuItem):
+    def handle_item_selection(self, context, item: menu_item_mod.MenuItem):
         """Called when the user clicks on a menu item that doesn't represent a folder."""
 
         from pillarsdk.utils import sanitize_filename
@@ -935,13 +694,11 @@ class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
         self._state = 'QUIT'
 
     async def download_and_replace(self, context):
-        from .pillar import sanitize_filename
-
         self._state = 'DOWNLOADING_TEXTURE'
 
         current_image = bpy.data.images[self.image_name]
         node = current_image['bcloud_node']
-        filename = '%s.taken_from_file' % sanitize_filename(node['name'])
+        filename = '%s.taken_from_file' % pillar.sanitize_filename(node['name'])
 
         local_path = os.path.dirname(bpy.path.abspath(current_image.filepath))
         top_texture_directory = bpy.path.abspath(context.scene.local_texture_dir)
@@ -951,21 +708,27 @@ class PILLAR_OT_switch_hdri(pillar.PillarOperatorMixin,
         resolution = next(file_ref['resolution'] for file_ref in node['properties']['files']
                           if file_ref['file'] == file_uuid)
 
-        self.log.info('Downloading file %r-%s to %s', file_uuid, resolution, local_path)
-        self.log.debug('Metadata will be stored at %s', meta_path)
+        my_log = self.log
+        my_log.info('Downloading file %r-%s to %s', file_uuid, resolution, local_path)
+        my_log.debug('Metadata will be stored at %s', meta_path)
 
         def file_loading(file_path, file_desc, map_type):
-            self.log.info('Texture downloading to %s (%s)',
-                          file_path, utils.sizeof_fmt(file_desc['length']))
+            my_log.info('Texture downloading to %s (%s)',
+                        file_path, utils.sizeof_fmt(file_desc['length']))
 
         async def file_loaded(file_path, file_desc, map_type):
             if context.scene.local_texture_dir.startswith('//'):
                 file_path = bpy.path.relpath(file_path)
 
-            self.log.info('Texture downloaded to %s', file_path)
+            my_log.info('Texture downloaded to %s', file_path)
             current_image['bcloud_file_uuid'] = file_uuid
             current_image.filepath = file_path  # This automatically reloads the image from disk.
 
+            # This forces users of the image to update.
+            for datablocks in bpy.data.user_map({current_image}).values():
+                for datablock in datablocks:
+                    datablock.update_tag()
+
         await pillar.download_file_by_uuid(file_uuid,
                                            local_path,
                                            meta_path,

blender_cloud/texture_browser/draw.py

@@ -0,0 +1,107 @@
+"""OpenGL drawing code for the texture browser.
+
+Requires Blender 2.80 or newer.
+"""
+
+import typing
+
+import bgl
+import blf
+import bpy
+import gpu
+from gpu_extras.batch import batch_for_shader
+
+if bpy.app.background:
+    shader = None
+    texture_shader = None
+else:
+    shader = gpu.shader.from_builtin('2D_UNIFORM_COLOR')
+    texture_shader = gpu.shader.from_builtin('2D_IMAGE')
+
+Float2 = typing.Tuple[float, float]
+Float3 = typing.Tuple[float, float, float]
+Float4 = typing.Tuple[float, float, float, float]
+
+
+def text(pos2d: Float2, display_text: typing.Union[str, typing.List[str]],
+         rgba: Float4 = (1.0, 1.0, 1.0, 1.0),
+         fsize=12,
+         align='L'):
+    """Draw text with the top-left corner at 'pos2d'."""
+
+    dpi = bpy.context.preferences.system.dpi
+    gap = 12
+    x_pos, y_pos = pos2d
+    font_id = 0
+    blf.size(font_id, fsize, dpi)
+
+    # Compute the height of one line.
+    mwidth, mheight = blf.dimensions(font_id, "Tp")  # Use high and low letters.
+    mheight *= 1.5
+
+    # Split text into lines.
+    if isinstance(display_text, str):
+        mylines = display_text.split("\n")
+    else:
+        mylines = display_text
+    maxwidth = 0
+    maxheight = len(mylines) * mheight
+
+    for idx, line in enumerate(mylines):
+        text_width, text_height = blf.dimensions(font_id, line)
+        if align == 'C':
+            newx = x_pos - text_width / 2
+        elif align == 'R':
+            newx = x_pos - text_width - gap
+        else:
+            newx = x_pos
+
+        # Draw
+        blf.position(font_id, newx, y_pos - mheight * idx, 0)
+        blf.color(font_id, rgba[0], rgba[1], rgba[2], rgba[3])
+        blf.draw(font_id, " " + line)
+
+        # saves max width
+        if maxwidth < text_width:
+            maxwidth = text_width
+
+    return maxwidth, maxheight
+
+
+def aabox(v1: Float2, v2: Float2, rgba: Float4):
+    """Draw an axis-aligned box."""
+    coords = [
+        (v1[0], v1[1]),
+        (v1[0], v2[1]),
+        (v2[0], v2[1]),
+        (v2[0], v1[1]),
+    ]
+    shader.bind()
+    shader.uniform_float("color", rgba)
+
+    batch = batch_for_shader(shader, 'TRI_FAN', {"pos": coords})
+    batch.draw(shader)
+
+
+def aabox_with_texture(v1: Float2, v2: Float2):
+    """Draw an axis-aligned box with a texture."""
+    coords = [
+        (v1[0], v1[1]),
+        (v1[0], v2[1]),
+        (v2[0], v2[1]),
+        (v2[0], v1[1]),
+    ]
+    texture_shader.bind()
+    texture_shader.uniform_int("image", 0)
+
+    batch = batch_for_shader(texture_shader, 'TRI_FAN', {
+        "pos": coords,
+        "texCoord": ((0, 0), (0, 1), (1, 1), (1, 0)),
+    })
+    batch.draw(texture_shader)
+
+
+def bind_texture(texture: bpy.types.Image):
+    """Bind a Blender image to a GL texture slot."""
+    bgl.glActiveTexture(bgl.GL_TEXTURE0)
+    bgl.glBindTexture(bgl.GL_TEXTURE_2D, texture.bindcode)

blender_cloud/texture_browser/draw_27.py

@@ -0,0 +1,90 @@
+"""OpenGL drawing code for the texture browser.
+
+Requires Blender 2.79 or older.
+"""
+
+import typing
+
+import bgl
+import blf
+import bpy
+
+Float2 = typing.Tuple[float, float]
+Float3 = typing.Tuple[float, float, float]
+Float4 = typing.Tuple[float, float, float, float]
+
+
+def text(pos2d: Float2, display_text: typing.Union[str, typing.List[str]],
+         rgba: Float4 = (1.0, 1.0, 1.0, 1.0),
+         fsize=12,
+         align='L'):
+    """Draw text with the top-left corner at 'pos2d'."""
+
+    dpi = bpy.context.user_preferences.system.dpi
+    gap = 12
+    x_pos, y_pos = pos2d
+    font_id = 0
+    blf.size(font_id, fsize, dpi)
+
+    # Compute the height of one line.
+    mwidth, mheight = blf.dimensions(font_id, "Tp")  # Use high and low letters.
+    mheight *= 1.5
+
+    # Split text into lines.
+    if isinstance(display_text, str):
+        mylines = display_text.split("\n")
+    else:
+        mylines = display_text
+    maxwidth = 0
+    maxheight = len(mylines) * mheight
+
+    for idx, line in enumerate(mylines):
+        text_width, text_height = blf.dimensions(font_id, line)
+        if align == 'C':
+            newx = x_pos - text_width / 2
+        elif align == 'R':
+            newx = x_pos - text_width - gap
+        else:
+            newx = x_pos
+
+        # Draw
+        blf.position(font_id, newx, y_pos - mheight * idx, 0)
+        bgl.glColor4f(*rgba)
+        blf.draw(font_id, " " + line)
+
+        # saves max width
+        if maxwidth < text_width:
+            maxwidth = text_width
+
+    return maxwidth, maxheight
+
+
+def aabox(v1: Float2, v2: Float2, rgba: Float4):
+    """Draw an axis-aligned box."""
+
+    bgl.glColor4f(*rgba)
+    bgl.glRectf(*v1, *v2)
+
+
+def aabox_with_texture(v1: Float2, v2: Float2):
+    """Draw an axis-aligned box with a texture."""
+
+    bgl.glColor4f(1.0, 1.0, 1.0, 1.0)
+
+    bgl.glEnable(bgl.GL_TEXTURE_2D)
+    bgl.glBegin(bgl.GL_QUADS)
+    bgl.glTexCoord2d(0, 0)
+    bgl.glVertex2d(v1[0], v1[1])
+    bgl.glTexCoord2d(0, 1)
+    bgl.glVertex2d(v1[0], v2[1])
+    bgl.glTexCoord2d(1, 1)
+    bgl.glVertex2d(v2[0], v2[1])
+    bgl.glTexCoord2d(1, 0)
+    bgl.glVertex2d(v2[0], v1[1])
+    bgl.glEnd()
+    bgl.glDisable(bgl.GL_TEXTURE_2D)
+
+
+def bind_texture(texture: bpy.types.Image):
+    """Bind a Blender image to a GL texture slot."""
+    bgl.glBindTexture(bgl.GL_TEXTURE_2D, texture.bindcode[0])

blender_cloud/texture_browser/menu_item.py

@@ -0,0 +1,192 @@
+import logging
+import os.path
+
+import bpy
+import bgl
+
+import pillarsdk
+from . import nodes
+
+if bpy.app.version < (2, 80):
+    from . import draw_27 as draw
+else:
+    from . import draw
+
+
+library_icons_path = os.path.join(os.path.dirname(__file__), "icons")
+
+ICON_WIDTH = 128
+ICON_HEIGHT = 128
+
+
+class MenuItem:
+    """GUI menu item for the 3D View GUI."""
+
+    icon_margin_x = 4
+    icon_margin_y = 4
+    text_margin_x = 6
+
+    text_size = 12
+    text_size_small = 10
+
+    DEFAULT_ICONS = {
+        'FOLDER': os.path.join(library_icons_path, 'folder.png'),
+        'SPINNER': os.path.join(library_icons_path, 'spinner.png'),
+        'ERROR': os.path.join(library_icons_path, 'error.png'),
+    }
+
+    FOLDER_NODE_TYPES = {'group_texture', 'group_hdri',
+                         nodes.UpNode.NODE_TYPE, nodes.ProjectNode.NODE_TYPE}
+    SUPPORTED_NODE_TYPES = {'texture', 'hdri'}.union(FOLDER_NODE_TYPES)
+
+    def __init__(self, node, file_desc, thumb_path: str, label_text):
+        self.log = logging.getLogger('%s.MenuItem' % __name__)
+        if node['node_type'] not in self.SUPPORTED_NODE_TYPES:
+            self.log.info('Invalid node type in node: %s', node)
+            raise TypeError('Node of type %r not supported; supported are %r.' % (
+                node['node_type'], self.SUPPORTED_NODE_TYPES))
+
+        assert isinstance(node, pillarsdk.Node), 'wrong type for node: %r' % type(node)
+        assert isinstance(node['_id'], str), 'wrong type for node["_id"]: %r' % type(node['_id'])
+        self.node = node  # pillarsdk.Node, contains 'node_type' key to indicate type
+        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
+        self.label_text = label_text
+        self.small_text = self._small_text_from_node()
+        self._thumb_path = ''
+        self.icon = None
+        self._is_folder = node['node_type'] in self.FOLDER_NODE_TYPES
+        self._is_spinning = False
+
+        # Determine sorting order.
+        # by default, sort all the way at the end and folders first.
+        self._order = 0 if self._is_folder else 10000
+        if node and node.properties and node.properties.order is not None:
+            self._order = node.properties.order
+
+        self.thumb_path = thumb_path
+
+        # Updated when drawing the image
+        self.x = 0
+        self.y = 0
+        self.width = 0
+        self.height = 0
+
+    def _small_text_from_node(self) -> str:
+        """Return the components of the texture (i.e. which map types are available)."""
+
+        if not self.node:
+            return ''
+
+        try:
+            node_files = self.node.properties.files
+        except AttributeError:
+            # Happens for nodes that don't have .properties.files.
+            return ''
+        if not node_files:
+            return ''
+
+        map_types = {f.map_type for f in node_files if f.map_type}
+        map_types.discard('color')  # all textures have colour
+        if not map_types:
+            return ''
+        return ', '.join(sorted(map_types))
+
+    def sort_key(self):
+        """Key for sorting lists of MenuItems."""
+        return self._order, self.label_text
+
+    @property
+    def thumb_path(self) -> str:
+        return self._thumb_path
+
+    @thumb_path.setter
+    def thumb_path(self, new_thumb_path: str):
+        self._is_spinning = new_thumb_path == 'SPINNER'
+
+        self._thumb_path = self.DEFAULT_ICONS.get(new_thumb_path, new_thumb_path)
+        if self._thumb_path:
+            self.icon = bpy.data.images.load(filepath=self._thumb_path)
+        else:
+            self.icon = None
+
+    @property
+    def node_uuid(self) -> str:
+        return self.node['_id']
+
+    def represents(self, node) -> bool:
+        """Returns True iff this MenuItem represents the given node."""
+
+        node_uuid = node['_id']
+        return self.node_uuid == node_uuid
+
+    def update(self, node, file_desc, thumb_path: str, label_text=None):
+        # We can get updated information about our Node, but a MenuItem should
+        # always represent one node, and it shouldn't be shared between nodes.
+        if self.node_uuid != node['_id']:
+            raise ValueError("Don't change the node ID this MenuItem reflects, "
+                             "just create a new one.")
+        self.node = node
+        self.file_desc = file_desc  # pillarsdk.File object, or None if a 'folder' node.
+        self.thumb_path = thumb_path
+
+        if label_text is not None:
+            self.label_text = label_text
+
+        if thumb_path == 'ERROR':
+            self.small_text = 'This open is broken'
+        else:
+            self.small_text = self._small_text_from_node()
+
+    @property
+    def is_folder(self) -> bool:
+        return self._is_folder
+
+    @property
+    def is_spinning(self) -> bool:
+        return self._is_spinning
+
+    def update_placement(self, x, y, width, height):
+        """Use OpenGL to draw this one menu item."""
+
+        self.x = x
+        self.y = y
+        self.width = width
+        self.height = height
+
+    def draw(self, highlighted: bool):
+        bgl.glEnable(bgl.GL_BLEND)
+        if highlighted:
+            color = (0.555, 0.555, 0.555, 0.8)
+        else:
+            color = (0.447, 0.447, 0.447, 0.8)
+
+        draw.aabox((self.x, self.y), (self.x + self.width, self.y + self.height), color)
+
+        texture = self.icon
+        if texture:
+            err = texture.gl_load(filter=bgl.GL_NEAREST, mag=bgl.GL_NEAREST)
+            assert not err, 'OpenGL error: %i' % err
+
+        # ------ TEXTURE ---------#
+        if texture:
+            draw.bind_texture(texture)
+        bgl.glBlendFunc(bgl.GL_SRC_ALPHA, bgl.GL_ONE_MINUS_SRC_ALPHA)
+
+        draw.aabox_with_texture(
+            (self.x + self.icon_margin_x, self.y),
+            (self.x + self.icon_margin_x + ICON_WIDTH, self.y + ICON_HEIGHT),
+        )
+        bgl.glDisable(bgl.GL_BLEND)
+
+        if texture:
+            texture.gl_free()
+
+        # draw some text
+        text_x = self.x + self.icon_margin_x + ICON_WIDTH + self.text_margin_x
+        text_y = self.y + ICON_HEIGHT * 0.5 - 0.25 * self.text_size
+        draw.text((text_x, text_y), self.label_text, fsize=self.text_size)
+        draw.text((text_x, self.y + 0.5 * self.text_size_small), self.small_text,
+                  fsize=self.text_size_small, rgba=(1.0, 1.0, 1.0, 0.5))
+
+    def hits(self, mouse_x: int, mouse_y: int) -> bool:
+        return self.x < mouse_x < self.x + self.width and self.y < mouse_y < self.y + self.height

blender_cloud/texture_browser/nodes.py

@@ -0,0 +1,26 @@
+import pillarsdk
+
+
+class SpecialFolderNode(pillarsdk.Node):
+    NODE_TYPE = 'SPECIAL'
+
+
+class UpNode(SpecialFolderNode):
+    NODE_TYPE = 'UP'
+
+    def __init__(self):
+        super().__init__()
+        self['_id'] = 'UP'
+        self['node_type'] = self.NODE_TYPE
+
+
+class ProjectNode(SpecialFolderNode):
+    NODE_TYPE = 'PROJECT'
+
+    def __init__(self, project):
+        super().__init__()
+
+        assert isinstance(project, pillarsdk.Project), 'wrong type for project: %r' % type(project)
+
+        self.merge(project.to_dict())
+        self['node_type'] = self.NODE_TYPE

blender_cloud/utils.py

@@ -18,6 +18,7 @@
 
 import json
 import pathlib
+import typing
 
 
 def sizeof_fmt(num: int, suffix='B') -> str:
@@ -29,12 +30,12 @@ def sizeof_fmt(num: int, suffix='B') -> str:
     for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
         if abs(num) < 1024:
             return '%.1f %s%s' % (num, unit, suffix)
-        num /= 1024
+        num //= 1024
 
     return '%.1f Yi%s' % (num, suffix)
 
 
-def find_in_path(path: pathlib.Path, filename: str) -> pathlib.Path:
+def find_in_path(path: pathlib.Path, filename: str) -> typing.Optional[pathlib.Path]:
     """Performs a breadth-first search for the filename.
 
     Returns the path that contains the file, or None if not found.

requirements.txt

@@ -3,7 +3,7 @@
 lockfile==0.12.2
 pillarsdk==1.7.0
 wheel==0.29.0
-blender-asset-tracer>=0.8
+blender-asset-tracer==1.1.1
 
 # Secondary requirements:
 asn1crypto==0.24.0

setup.py

@@ -236,12 +236,16 @@ setup(
               'wheels': BuildWheels},
     name='blender_cloud',
     description='The Blender Cloud addon allows browsing the Blender Cloud from Blender.',
-    version='1.10.0',
+    version='1.13.1',
     author='Sybren A. Stüvel',
     author_email='sybren@stuvel.eu',
     packages=find_packages('.'),
-    data_files=[('blender_cloud', ['README.md', 'README-flamenco.md', 'CHANGELOG.md']),
-                ('blender_cloud/icons', glob.glob('blender_cloud/icons/*'))],
+    data_files=[
+        ('blender_cloud', ['README.md', 'README-flamenco.md', 'CHANGELOG.md']),
+        ('blender_cloud/icons', glob.glob('blender_cloud/icons/*')),
+        ('blender_cloud/texture_browser/icons',
+         glob.glob('blender_cloud/texture_browser/icons/*'))
+    ],
     scripts=[],
     url='https://developer.blender.org/diffusion/BCA/',
     license='GNU General Public License v2 or later (GPLv2+)',