# ##### BEGIN GPL LICENSE BLOCK ##### # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software Foundation, # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. # # ##### END GPL LICENSE BLOCK ##### import datetime import json import logging import numpy as np import os import platform import re import shutil import sys import uuid from typing import Optional import bpy from mathutils import Vector from . import ( client_lib, client_tasks, datas, global_vars, image_utils, paths, persistent_preferences, reports, search, ) bk_logger = logging.getLogger(__name__) ABOVE_NORMAL_PRIORITY_CLASS = 0x00008000 BELOW_NORMAL_PRIORITY_CLASS = 0x00004000 HIGH_PRIORITY_CLASS = 0x00000080 IDLE_PRIORITY_CLASS = 0x00000040 NORMAL_PRIORITY_CLASS = 0x00000020 REALTIME_PRIORITY_CLASS = 0x00000100 supported_material_click = ( "MESH", "CURVE", "META", "FONT", "SURFACE", "VOLUME", "GPENCIL", ) supported_material_drag = ( "MESH", "CURVE", "META", "FONT", "SURFACE", "VOLUME", "GPENCIL", ) # supported_material_drag = ('MESH') def experimental_enabled() -> bool: """Check if experimental features are enabled. Experimental features are always be enabled for staff and validators.""" preferences = bpy.context.preferences.addons[__package__].preferences # type: ignore return preferences.experimental_features or profile_is_validator() # type: ignore def get_process_flags(): flags = BELOW_NORMAL_PRIORITY_CLASS if sys.platform != "win32": # TODO test this on windows flags = 0 return flags def activate(ob): try: bpy.ops.object.select_all(action="DESELECT") except Exception as e: reports.add_report( f"utils.activate: {str(e)}", 3, type="ERROR", ) raise e ob.select_set(True) bpy.context.view_layer.objects.active = ob def selection_get(): aob = bpy.context.view_layer.objects.active selobs = bpy.context.view_layer.objects.selected[:] return (aob, selobs) def selection_set(sel): try: bpy.ops.object.select_all(action="DESELECT") except Exception as e: reports.add_report( f"utils.selection_set: {str(e)}", 3, type="ERROR", ) raise e try: bpy.context.view_layer.objects.active = sel[0] for ob in sel[1]: ob.select_set(True) except Exception as e: bk_logger.exception(f"failed to select objects: {str(e)}") def get_active_model() -> Optional[bpy.types.Object]: if bpy.context.view_layer.objects.active is not None: ob = bpy.context.view_layer.objects.active while ob.parent is not None: ob = ob.parent return ob return None def get_active_HDR(): ui_props = bpy.context.window_manager.blenderkitUI image = ui_props.hdr_upload_image return image def get_active_nodegroup(): ui_props = bpy.context.window_manager.blenderkitUI nodegroup = ui_props.nodegroup_upload return nodegroup def get_selected_models(): """ Detect all hierarchies that contain asset data from selection. Only parents that have actual ['asset data'] get returned Returns list of objects containing asset data. """ obs = bpy.context.selected_objects[:] done = {} parents = [] for ob in obs: if ob not in done: while ( ob.parent is not None and ob not in done and ob.blenderkit.asset_base_id == "" and ob.instance_collection is None ): done[ob] = True ob = ob.parent if ob not in parents and ob not in done: if ob.blenderkit.name != "" or ob.instance_collection is not None: parents.append(ob) done[ob] = True # if no blenderkit - like objects were found, use the original selection. if len(parents) == 0: parents = obs return parents def get_selected_replace_adepts(): """ Detect all hierarchies that contain either asset data from selection, or selected objects themselves. Returns list of objects for replacement. """ obs = bpy.context.selected_objects[:] done = {} parents = [] for selected_ob in obs: ob = selected_ob if ob not in done: while ( ob.parent is not None and ob not in done and ob.blenderkit.asset_base_id == "" and ob.instance_collection is None ): done[ob] = True # print('step,',ob.name) ob = ob.parent # print('fin', ob.name) if ob not in parents and ob not in done: if ob.blenderkit.name != "" or ob.instance_collection is not None: parents.append(ob) done[ob] = True # print(parents) # if no blenderkit - like objects were found, use the original selection. if len(parents) == 0: parents = obs pprint("replace adepts") pprint(str(parents)) return parents def exclude_collection(name, state=True): """ Set the exclude state of collection Parameters ---------- name - name of collection state - default True. Returns ------- None """ vl = bpy.context.view_layer.layer_collection cc = [vl] found = False while len(cc) > 0 and not found: c = cc.pop() if c.name == name: c.exclude = state found = True cc.extend(c.children) def move_collection(child, parent): """ Move a collection to a new parrent Parameters ---------- child - collection parent - parent Returns ------- None """ vl = bpy.context.scene.collection cc = [vl] found = False while len(cc) > 0 and not found: c = cc.pop() if c.name != parent.name and c.children.find(child.name) > -1: c.children.unlink(child) if c.name == parent.name and c.children.find(child.name) == -1: c.children.link(child) cc.extend(c.children) def get_search_props(): # returns saved search properties scene = bpy.context.scene wm = bpy.context.window_manager if scene is None: return uiprops = bpy.context.window_manager.blenderkitUI props = None if uiprops.asset_type in ("MODEL", "PRINTABLE"): if not hasattr(wm, "blenderkit_models"): return props = wm.blenderkit_models if uiprops.asset_type == "SCENE": if not hasattr(wm, "blenderkit_scene"): return props = wm.blenderkit_scene if uiprops.asset_type == "HDR": if not hasattr(wm, "blenderkit_HDR"): return props = wm.blenderkit_HDR if uiprops.asset_type == "MATERIAL": if not hasattr(wm, "blenderkit_mat"): return props = wm.blenderkit_mat if uiprops.asset_type == "TEXTURE": if not hasattr(wm, "blenderkit_tex"): return # props = scene.blenderkit_tex if uiprops.asset_type == "BRUSH": if not hasattr(wm, "blenderkit_brush"): return props = wm.blenderkit_brush if uiprops.asset_type == "NODEGROUP": if not hasattr(wm, "blenderkit_nodegroup"): return props = wm.blenderkit_nodegroup if uiprops.asset_type == "ADDON": if not hasattr(wm, "blenderkit_addon"): return props = wm.blenderkit_addon return props def get_active_asset_by_type(asset_type="model"): asset_type = asset_type.lower() if asset_type in ("model", "printable"): if bpy.context.view_layer.objects.active is not None: ob = get_active_model() return ob if asset_type == "scene": return bpy.context.scene if asset_type == "hdr": return get_active_HDR() if asset_type == "material": if ( bpy.context.view_layer.objects.active is not None and bpy.context.active_object.active_material is not None ): return bpy.context.active_object.active_material if asset_type == "texture": return None if asset_type == "brush": b = get_active_brush() return b if asset_type == "nodegroup": b = get_active_nodegroup() return b return None def get_equivalent_datablock(asset_type, name): """Get the datablock that blocks us from renaming the asset, and rename it to something a bit else.""" if asset_type == "MATERIAL": return bpy.data.materials.get(name) elif asset_type == "OBJECT": return bpy.data.objects.get(name) elif asset_type == "SCENE": return bpy.data.scenes.get(name) elif asset_type == "HDR": return bpy.data.images.get(name) elif asset_type == "BRUSH": return bpy.data.brushes.get(name) elif asset_type == "NODEGROUP": return bpy.data.node_groups.get(name) elif asset_type == "ADDON": return bpy.data.addons.get(name) return None def get_active_asset(): scene = bpy.context.scene ui_props = bpy.context.window_manager.blenderkitUI if ui_props.asset_type in ("MODEL", "PRINTABLE"): if bpy.context.view_layer.objects.active is not None: ob = get_active_model() return ob if ui_props.asset_type == "SCENE": return bpy.context.scene if ui_props.asset_type == "HDR": return get_active_HDR() elif ui_props.asset_type == "MATERIAL": if ( bpy.context.view_layer.objects.active is not None and bpy.context.active_object.active_material is not None ): return bpy.context.active_object.active_material elif ui_props.asset_type == "TEXTURE": return None elif ui_props.asset_type == "BRUSH": return get_active_brush() elif ui_props.asset_type == "NODEGROUP": return get_active_nodegroup() elif ui_props.asset_type == "ADDON": return None # Addons don't have an active asset concept return None def get_upload_props(): """Get uploaded object properties based on the selected asset_type.""" ui_props = bpy.context.window_manager.blenderkitUI if ui_props.asset_type in ("MODEL", "PRINTABLE"): if bpy.context.view_layer.objects.active is not None: ob = get_active_model() return ob.blenderkit if ui_props.asset_type == "SCENE": s = bpy.context.scene return s.blenderkit if ui_props.asset_type == "HDR": hdr = ( ui_props.hdr_upload_image ) # bpy.data.images.get(ui_props.hdr_upload_image) if not hdr: return None return hdr.blenderkit elif ui_props.asset_type == "MATERIAL": if ( bpy.context.view_layer.objects.active is not None and bpy.context.active_object.active_material is not None ): return bpy.context.active_object.active_material.blenderkit elif ui_props.asset_type == "TEXTURE": return None elif ui_props.asset_type == "BRUSH": b = get_active_brush() if b is not None: return b.blenderkit elif ui_props.asset_type == "NODEGROUP": b = get_active_nodegroup() if b is not None: return b.blenderkit elif ui_props.asset_type == "ADDON": return None # Addons don't have upload props return None def previmg_name(index, fullsize=False): if not fullsize: return ".bkit_preview_" + str(index).zfill(3) else: return ".bkit_preview_full_" + str(index).zfill(3) def get_active_brush(): context = bpy.context brush = None if context.sculpt_object: brush = context.tool_settings.sculpt.brush elif ( context.image_paint_object ): # could be just else, but for future possible more types... brush = context.tool_settings.image_paint.brush return brush def get_scene_id(): """gets scene id and possibly also generates a new one""" bpy.context.scene["uuid"] = bpy.context.scene.get("uuid", str(uuid.uuid4())) return bpy.context.scene["uuid"] def get_preferences_as_dict(): user_preferences = bpy.context.preferences.addons[__package__].preferences prefs = { # SYSTEM STUFF - TODO: is this needed in here? (Why to save this into JSON?) Is used for sending data to client, but really should be separate parameter. "debug_value": bpy.app.debug_value, "binary_path": bpy.app.binary_path, "addon_dir": os.path.dirname(__file__), "addon_module_name": __package__, # refers to name of the add-on, legacy=blenderkit, extensions=bl_ext.user_default.blenderkit or anything else "app_id": os.getpid(), # STATISTICS "download_counter": user_preferences.download_counter, "asset_popup_counter": user_preferences.asset_popup_counter, "welcome_operator_counter": user_preferences.welcome_operator_counter, # MAIN PREFERENCES "api_key": user_preferences.api_key, "api_key_refresh": user_preferences.api_key_refresh, "api_key_timeout": user_preferences.api_key_timeout, "experimental_features": user_preferences.experimental_features, "keep_preferences": user_preferences.keep_preferences, # FILE PATHS "directory_behaviour": user_preferences.directory_behaviour, "global_dir": user_preferences.global_dir, "project_subdir": user_preferences.project_subdir, "unpack_files": user_preferences.unpack_files, # GUI "show_on_start": user_preferences.show_on_start, "thumb_size": user_preferences.thumb_size, "maximized_assetbar_rows": user_preferences.maximized_assetbar_rows, "search_field_width": user_preferences.search_field_width, "search_in_header": user_preferences.search_in_header, "tips_on_start": user_preferences.tips_on_start, "announcements_on_start": user_preferences.announcements_on_start, # NETWORK "client_port": user_preferences.client_port, "ip_version": user_preferences.ip_version, "ssl_context": user_preferences.ssl_context, "proxy_which": user_preferences.proxy_which, "proxy_address": user_preferences.proxy_address, "trusted_ca_certs": user_preferences.trusted_ca_certs, # UPDATES "auto_check_update": user_preferences.auto_check_update, "enable_prereleases": user_preferences.enable_prereleases, "updater_interval_months": user_preferences.updater_interval_months, "updater_interval_days": user_preferences.updater_interval_days, # IMPORT SETTINGS "resolution": user_preferences.resolution, } return prefs def get_preferences() -> datas.Prefs: """Get preferences as dataclass object.""" user_preferences = bpy.context.preferences.addons[__package__].preferences # type: ignore prefs = datas.Prefs( # SYSTEM STUFF - TODO: is this needed in here? (Why to save this into JSON?) Is used for sending data to client, but really should be separate parameter. debug_value=bpy.app.debug_value, binary_path=bpy.app.binary_path, addon_dir=os.path.dirname(__file__), addon_module_name=__package__, # refers to name of the add-on, legacy=blenderkit, extensions=bl_ext.user_default.blenderkit or anything else app_id=os.getpid(), # STATISTICS download_counter=user_preferences.download_counter, # type: ignore[union-attr] asset_popup_counter=user_preferences.asset_popup_counter, # type: ignore[union-attr] welcome_operator_counter=user_preferences.welcome_operator_counter, # type: ignore[union-attr] # MAIN PREFERENCES api_key=user_preferences.api_key, # type: ignore[union-attr] api_key_refresh=user_preferences.api_key_refresh, # type: ignore[union-attr] api_key_timeout=user_preferences.api_key_timeout, # type: ignore[union-attr] experimental_features=user_preferences.experimental_features, # type: ignore[union-attr] keep_preferences=user_preferences.keep_preferences, # type: ignore[union-attr] # FILE PATHS directory_behaviour=user_preferences.directory_behaviour, # type: ignore[union-attr] global_dir=user_preferences.global_dir, # type: ignore[union-attr] project_subdir=user_preferences.project_subdir, # type: ignore[union-attr] unpack_files=user_preferences.unpack_files, # type: ignore[union-attr] # GUI show_on_start=user_preferences.show_on_start, # type: ignore[union-attr] thumb_size=user_preferences.thumb_size, # type: ignore[union-attr] maximized_assetbar_rows=user_preferences.maximized_assetbar_rows, # type: ignore[union-attr] search_field_width=user_preferences.search_field_width, # type: ignore[union-attr] search_in_header=user_preferences.search_in_header, # type: ignore[union-attr] tips_on_start=user_preferences.tips_on_start, # type: ignore[union-attr] announcements_on_start=user_preferences.announcements_on_start, # type: ignore[union-attr] # NETWORK client_port=user_preferences.client_port, # type: ignore[union-attr] ip_version=user_preferences.ip_version, # type: ignore[union-attr] ssl_context=user_preferences.ssl_context, # type: ignore[union-attr] proxy_which=user_preferences.proxy_which, # type: ignore[union-attr] proxy_address=user_preferences.proxy_address, # type: ignore[union-attr] trusted_ca_certs=user_preferences.trusted_ca_certs, # type: ignore[union-attr] # UPDATES auto_check_update=user_preferences.auto_check_update, # type: ignore[union-attr] enable_prereleases=user_preferences.enable_prereleases, # type: ignore[union-attr] updater_interval_months=user_preferences.updater_interval_months, # type: ignore[union-attr] updater_interval_days=user_preferences.updater_interval_days, # type: ignore[union-attr] # IMPORT SETTINGS resolution=user_preferences.resolution, # type: ignore[union-attr] material_import_automap=user_preferences.material_import_automap, # type: ignore[union-attr] ) return prefs def save_prefs_without_save_userpref(user_preferences, context): """Save preferences (update global_vars.PREFS, write to JSON if needed) without calling bpy.ops.wm.save_userpref().""" save_prefs(user_preferences, context, save_userprefs=False) def save_prefs(user_preferences, context, **kwargs): # first check context, so we don't do this on registration, blender startup, or blender factory startup if bpy.app.background is True or bpy.app.factory_startup is True: return global_vars.PREFS = get_preferences_as_dict() if user_preferences.preferences_lock is True: return if kwargs.get("save_userprefs", True): bpy.ops.wm.save_userpref() if ( user_preferences.keep_preferences is True ): # TODO: write statistics even if keep_preferences is False persistent_preferences.write_preferences_to_JSON(global_vars.PREFS) def api_key_property_updated(user_preferences, context): """Check if api_key is of valid length so random typo does not get saved. If length is not correct, then reset api_key to empty string. Call save_prefs() when api_key is correct. """ if len(user_preferences.api_key) >= 25: if user_preferences.preferences_lock == False: client_lib.get_user_profile() search.refresh_search() return save_prefs(user_preferences, context) if len(user_preferences.api_key) == 0: return save_prefs(user_preferences, context) user_preferences.api_key = "" reports.add_report( "Login failed. Wrong API key length. Please login again, or paste a correct API Key.", type="ERROR", ) return # save_prefs not called, as setting api_key to empty string will trigger this function again def uploadable_asset_poll(): """returns true if active asset type can be uploaded""" ui_props = bpy.context.window_manager.blenderkitUI if ui_props.asset_type in ("MODEL", "PRINTABLE"): return bpy.context.view_layer.objects.active is not None if ui_props.asset_type == "MATERIAL": return ( bpy.context.view_layer.objects.active is not None and bpy.context.active_object.active_material is not None ) if ui_props.asset_type == "HDR": return ui_props.hdr_upload_image is not None if ui_props.asset_type == "NODEGROUP": return ui_props.nodegroup_upload is not None return True def get_hidden_texture(name, force_reload=False): if name[0] != ".": name = f".{name}" t = bpy.data.textures.get(name) if t is None: t = bpy.data.textures.new(name, "IMAGE") if t.image is None or t.image.name != name: img = bpy.data.images.get(name) if img: t.image = img return t def img_to_preview(img, copy_original=False): """ Convert image to preview, handling alpha channel properly by filling transparent areas with theme color. """ if bpy.app.version[0] >= 3: img.preview_ensure() if not copy_original: return # Only process if image has alpha channel and needs filling if img.channels == 4 and ( img.alpha_mode == "STRAIGHT" or img.alpha_mode == "PREMUL" ): # Get theme color (default Blender background) theme = bpy.context.preferences.themes[0] bg_color = theme.user_interface.wcol_box.inner[:] # Convert image pixels to numpy array for faster processing pixels = np.array(img.pixels[:]).reshape(img.size[1], img.size[0], 4) # Create alpha mask alpha_mask = pixels[:, :, 3][:, :, np.newaxis] # Create background color array bg = np.array([bg_color[0], bg_color[1], bg_color[2], 1.0]) bg_array = np.tile(bg, (img.size[1], img.size[0], 1)) # Blend image with background based on alpha blended = pixels * alpha_mask + bg_array * (1 - alpha_mask) # Update preview if img.preview.image_size != img.size: img.preview.image_size = (img.size[0], img.size[1]) # Convert back to flat array and update preview pixels img.preview.image_pixels_float = blended.flatten() else: # For non-alpha images, just copy pixels as before if img.preview.image_size != img.size: img.preview.image_size = (img.size[0], img.size[1]) img.preview.image_pixels_float = img.pixels[:] def get_hidden_image( tpath, bdata_name, force_reload: bool = False, colorspace: str = "" ): """Get hidden image by name. If not found, load it from tpath.""" if bdata_name[0] == ".": hidden_name = bdata_name else: hidden_name = f".{bdata_name}" img = bpy.data.images.get(hidden_name) # type: ignore[union-attr] if tpath.startswith("//"): tpath = bpy.path.abspath(tpath) if img is None or (img.filepath != tpath): if tpath.startswith("//"): tpath = bpy.path.abspath(tpath) if not os.path.exists(tpath) or os.path.isdir(tpath): tpath = paths.get_addon_thumbnail_path("thumbnail_notready.jpg") if img is None: img = bpy.data.images.load(tpath, check_existing=True) # type: ignore[union-attr] img_to_preview(img) img.name = hidden_name # type: ignore[union-attr] else: if img.filepath != tpath: if img.packed_file is not None: img.unpack(method="USE_ORIGINAL") img.filepath = tpath img.reload() img_to_preview(img) image_utils.set_colorspace(img, colorspace) elif force_reload: if img.packed_file is not None: img.unpack(method="USE_ORIGINAL") img.reload() img_to_preview(img) image_utils.set_colorspace(img, colorspace) return img def get_thumbnail(name): """Get addon thumbnail image by name.""" p = paths.get_addon_thumbnail_path(name) name = f".{name}" img = bpy.data.images.get(name) if img is None: img = bpy.data.images.load(p, check_existing=True) image_utils.set_colorspace(img) img.name = name return img def files_size_to_text(size: int) -> str: """ Convert a file size in bytes to a human-readable string in bytes, KiB, MiB, GiB or TiB. Args: size (int): The size in bytes. Returns: str: The human-readable file size string. E.g.: "18.9 MiB", "1.2 GiB", "1 GiB" etc. """ if size < 0: print("Size must be non-negative") return "0" kib = 1024 mib = kib * 1024 gib = mib * 1024 tib = gib * 1024 if size >= tib: rounded = round(size / tib, 1) if rounded.is_integer(): rounded = int(rounded) return f"{rounded} TiB" elif size >= gib: rounded = round(size / gib, 1) if rounded.is_integer(): rounded = int(rounded) return f"{rounded} GiB" elif size >= mib: rounded = round(size / mib, 1) if rounded.is_integer(): rounded = int(rounded) return f"{rounded} MiB" elif size >= kib: rounded = round(size / kib, 1) if rounded.is_integer(): rounded = int(rounded) return f"{rounded} KiB" if size == 1: return "1 byte" return f"{size} bytes" def get_brush_props(context): brush = get_active_brush() if brush is not None: return brush.blenderkit return None def p(text, text1="", text2="", text3="", text4="", text5="", level="DEBUG"): """debug printing depending on blender's debug value""" if 1: # bpy.app.debug_value != 0: # print('-----BKit debug-----\n') # traceback.print_stack() texts = [text1, text2, text3, text4, text5] text = str(text) for t in texts: if t != "": text += " " + str(t) bk_logger.debug(text) # print('---------------------\n') def copy_asset(fp1, fp2): """Synchronizes the asset between directories, including it's texture subdirectories.""" if 1: bk_logger.debug("copy asset") bk_logger.debug(fp1 + " " + fp2) if not os.path.exists(fp2): shutil.copyfile(fp1, fp2) bk_logger.debug("copied") source_dir = os.path.dirname(fp1) target_dir = os.path.dirname(fp2) for subdir in os.scandir(source_dir): if not subdir.is_dir(): continue target_subdir = os.path.join(target_dir, subdir.name) if os.path.exists(target_subdir): continue bk_logger.debug(str(subdir) + " " + str(target_subdir)) shutil.copytree(subdir, target_subdir) bk_logger.debug("copied") # except Exception as e: # print('BlenderKit failed to copy asset') # print(fp1, fp2) # print(e) def pprint(data, data1=None, data2=None, data3=None, data4=None): """pretty print jsons""" p(json.dumps(data, indent=4, sort_keys=True)) def get_hierarchy(object) -> list[bpy.types.Object]: """Get all objects in a hierarchy tree.""" obs: list[bpy.types.Object] = [] doobs = [object] while len(doobs) > 0: o = doobs.pop() doobs.extend(o.children) obs.append(o) return obs def delete_hierarchy(object): """Delete object and all other objects in the hierarchy. In 3.2 and newer use temp_override to delete objects that are not selected. In 3.1 or older use selected_objects override to delete objects that are not selected. https://wiki.blender.org/wiki/Reference/Release_Notes/3.2/Python_API """ objects = get_hierarchy(object) if bpy.app.version < (3, 2, 0): bpy.ops.object.delete({"selected_objects": objects}) return with bpy.context.temp_override(selected_objects=objects): bpy.ops.object.delete() def get_bounds_snappable(obs, use_modifiers=False): # progress('getting bounds of object(s)') parent = obs[0] while parent.parent is not None: parent = parent.parent maxx = maxy = maxz = -10000000 minx = miny = minz = 10000000 s = bpy.context.scene obcount = 0 # calculates the mesh obs. Good for non-mesh objects matrix_parent = parent.matrix_world depsgraph = bpy.context.evaluated_depsgraph_get() for ob in obs: # bb=ob.bound_box mw = ob.matrix_world subp = ob.parent # while parent.parent is not None: # mw = if ob.type == "MESH" or ob.type == "CURVE": # If to_mesh() works we can use it on curves and any other ob type almost. # disabled to_mesh for 2.8 by now, not wanting to use dependency graph yet. object_eval = ob.evaluated_get(depsgraph) if ob.type == "CURVE": mesh = object_eval.to_mesh() else: mesh = object_eval.data # to_mesh(context.depsgraph, apply_modifiers=self.applyModifiers, calc_undeformed=False) obcount += 1 if mesh is not None: for c in mesh.vertices: coord = c.co parent_coord = ( matrix_parent.inverted() @ mw @ Vector((coord[0], coord[1], coord[2])) ) # copy this when it works below. minx = min(minx, parent_coord.x) miny = min(miny, parent_coord.y) minz = min(minz, parent_coord.z) maxx = max(maxx, parent_coord.x) maxy = max(maxy, parent_coord.y) maxz = max(maxz, parent_coord.z) # bpy.data.meshes.remove(mesh) if ob.type == "CURVE": object_eval.to_mesh_clear() elif ob.type == "VOLUME": # Ensure evaluated bound box (so grids/sequences are loaded) object_eval = ob.evaluated_get(depsgraph) bb = object_eval.bound_box obcount += 1 for c in bb: coord = c parent_coord = ( matrix_parent.inverted() @ mw @ Vector((coord[0], coord[1], coord[2])) ) minx = min(minx, parent_coord.x) miny = min(miny, parent_coord.y) minz = min(minz, parent_coord.z) maxx = max(maxx, parent_coord.x) maxy = max(maxy, parent_coord.y) maxz = max(maxz, parent_coord.z) elif ob.type in ["LIGHT", "CAMERA"]: # From these we only need center point for bounds coord = ob.location parent_coord = ( matrix_parent.inverted() @ mw @ Vector((coord[0], coord[1], coord[2])) ) minx = min(minx, parent_coord.x) miny = min(miny, parent_coord.y) minz = min(minz, parent_coord.z) maxx = max(maxx, parent_coord.x) maxy = max(maxy, parent_coord.y) maxz = max(maxz, parent_coord.z) if obcount == 0: minx, miny, minz, maxx, maxy, maxz = 0, 0, 0, 0, 0, 0 minx *= parent.scale.x maxx *= parent.scale.x miny *= parent.scale.y maxy *= parent.scale.y minz *= parent.scale.z maxz *= parent.scale.z return minx, miny, minz, maxx, maxy, maxz def get_bounds_worldspace(obs, use_modifiers=False): # progress('getting bounds of object(s)') s = bpy.context.scene maxx = maxy = maxz = -10000000 minx = miny = minz = 10000000 obcount = 0 # calculates the mesh obs. Good for non-mesh objects for ob in obs: # bb=ob.bound_box mw = ob.matrix_world if ob.type == "MESH" or ob.type == "CURVE": depsgraph = bpy.context.evaluated_depsgraph_get() ob_eval = ob.evaluated_get(depsgraph) mesh = ob_eval.to_mesh() obcount += 1 if mesh is not None: for c in mesh.vertices: coord = c.co world_coord = mw @ Vector((coord[0], coord[1], coord[2])) minx = min(minx, world_coord.x) miny = min(miny, world_coord.y) minz = min(minz, world_coord.z) maxx = max(maxx, world_coord.x) maxy = max(maxy, world_coord.y) maxz = max(maxz, world_coord.z) ob_eval.to_mesh_clear() if obcount == 0: minx, miny, minz, maxx, maxy, maxz = 0, 0, 0, 0, 0, 0 return minx, miny, minz, maxx, maxy, maxz def is_linked_asset(ob): return ob.get("asset_data") and ob.instance_collection != None def get_dimensions(obs): minx, miny, minz, maxx, maxy, maxz = get_bounds_snappable(obs) bbmin = Vector((minx, miny, minz)) bbmax = Vector((maxx, maxy, maxz)) dim = Vector((maxx - minx, maxy - miny, maxz - minz)) return dim, bbmin, bbmax def get_simple_headers() -> dict[str, str]: headers = { "accept": "application/json", "Platform-Version": platform.platform(), "addon-version": f"{global_vars.VERSION[0]}.{global_vars.VERSION[1]}.{global_vars.VERSION[2]}.{global_vars.VERSION[3]}", } return headers def get_headers(api_key: str = "") -> dict[str, str]: headers = get_simple_headers() if api_key != "": headers["Authorization"] = f"Bearer {api_key}" return headers def scale_2d(v, s, p): """scale a 2d vector with a pivot""" return (p[0] + s[0] * (v[0] - p[0]), p[1] + s[1] * (v[1] - p[1])) def scale_uvs(ob, scale=1.0, pivot=Vector((0.5, 0.5))): mesh = ob.data if len(mesh.uv_layers) > 0: uv = mesh.uv_layers[mesh.uv_layers.active_index] # Scale a UV map iterating over its coordinates to a given scale and with a pivot point for uvindex in range(len(uv.data)): uv.data[uvindex].uv = scale_2d(uv.data[uvindex].uv, scale, pivot) def automap( target_object=None, target_slot=None, tex_size=1, bg_exception=False, just_scale=False, ): """ Map uv cubic and switch off auto tex space and set it to 1,1,1. Only automap mesh models and if enabled in material import preferences. """ preferences = bpy.context.preferences.addons[__package__].preferences if not preferences.material_import_automap: return tob = bpy.data.objects[target_object] # Only automap mesh models if tob.type != "MESH" or len(tob.data.polygons) <= 0: return # check polycount for a rare case where no polys are in editmesh actob = bpy.context.active_object bpy.context.view_layer.objects.active = tob # auto tex space if tob.data.use_auto_texspace: tob.data.use_auto_texspace = False if not just_scale: tob.data.texspace_size = (1, 1, 1) if "automap" not in tob.data.uv_layers: bpy.ops.mesh.uv_texture_add() uvl = tob.data.uv_layers[-1] uvl.name = "automap" tob.data.uv_layers.active = tob.data.uv_layers["automap"] tob.data.uv_layers["automap"].active_render = True # TODO limit this to active material # tob.data.uv_textures['automap'].active = True scale = tob.scale.copy() if target_slot is not None: tob.active_material_index = target_slot bpy.ops.object.mode_set(mode="EDIT") try: bpy.ops.mesh.select_all(action="DESELECT") except Exception as e: reports.add_report( f"automap.1: {str(e)}", 3, type="ERROR", ) raise e # this exception is just for a 2.8 background thunmbnailer crash, can be removed when material slot select works... if bg_exception or len(tob.material_slots) == 0: try: bpy.ops.mesh.select_all(action="SELECT") except Exception as e: reports.add_report( f"automap.2: {str(e)}", 3, type="ERROR", ) raise e else: bpy.ops.object.material_slot_select() scale = (scale.x + scale.y + scale.z) / 3.0 if ( tex_size == 0 ): # prevent division by zero, it's possible to have 0 in tex size by unskilled uploaders tex_size = 1 if not just_scale: # compensate for the undocumented operator change in blender 3.2 if bpy.app.version >= (3, 2, 0): cube_size = (tex_size) / scale else: cube_size = ( scale * 2.0 / (tex_size) ) # it's * 2.0 because blender can't tell size of a unit cube :) bpy.ops.uv.cube_project(cube_size=cube_size, correct_aspect=False) bpy.ops.object.editmode_toggle() # this by now works only for thumbnail preview, but should be extended to work on arbitrary objects. # by now, it takes the basic uv map = 1 meter. also, it now doeasn't respect more materials on one object, # it just scales whole UV. if just_scale: scale_uvs(tob, scale=Vector((1 / tex_size, 1 / tex_size))) bpy.context.view_layer.objects.active = actob def name_update(props, context=None): """Update asset name function, gets run also before upload. Makes sure name doesn't change in case of reuploads, and only displayName gets written to server. Checks for name change, because it decides if whole asset has to be re-uploaded. Name is stored in the blend file and that's the reason. """ ui_props = bpy.context.window_manager.blenderkitUI # props = get_upload_props() if props.name_old != props.name: props.name_changed = True props.name_old = props.name nname = props.name.strip() nname = nname.replace("_", " ") if nname.isupper(): nname = nname.lower() if nname != "": nname = nname[0].upper() + nname[1:] props.name = ( nname # this recursively triggers the name_update() again, so we return ) return # here we need to fix the name for blender data = ' or " give problems in path evaluation down the road. fname = props.name fname = fname.replace("'", "") fname = fname.replace('"', "") if ui_props.asset_type == "HDR" or fname == "": bk_logger.info(f"Skiping the rename") return # don't rename HDR's or with empty name else: asset = get_active_asset() if asset.name != fname: # Here we actually rename assets datablocks asset.name = fname # change name of active object to upload Name # we need to set the name back for proper appending later if asset.name != fname and re.search(r"\.\d+$", asset.name) is not None: # - because assets end up with .001, .002, etc. names sometimes. # first, let's get the datablock that blocks us from renaming the asset, and rename it to something a bit else: # we need to ge the equivalent datablock , # then we can swap those names around. datablock = get_equivalent_datablock(ui_props.asset_type, fname) if datablock is not None: datablock.name = fname + "_temprename" replace_name = asset.name asset.name = fname datablock.name = replace_name def fmt_dimensions(p): """formats dimensions to correct string""" dims = [p["dimensionX"], p["dimensionY"], p["dimensionZ"]] maxl = max(dims) if maxl > 1: unit = "m" unitscale = 1 elif maxl > 0.01: unit = "cm" unitscale = 100 else: unit = "mm" unitscale = 1000 s = f"{fmt_length(dims[0]*unitscale)}×{fmt_length(dims[1]*unitscale)}×{fmt_length(dims[2]*unitscale)} {unit}" return s def fmt_length(prop): prop = str(round(prop, 2)) return prop def get_param(asset_data, parameter_name, default=None): if not asset_data.get("dictParameters"): # this can appear in older version files. return default return asset_data["dictParameters"].get(parameter_name, default) # for p in asset_data['parameters']: # if p.get('parameterType') == parameter_name: # return p['value'] # return default def params_to_dict(params): params_dict = {} for p in params: params_dict[p["parameterType"]] = p["value"] return params_dict def update_tags(self, context): props = self commasep = props.tags.split(",") ntags = [] for tag in commasep: if len(tag) > 19: short_tags = tag.split(" ") for short_tag in short_tags: if len(short_tag) > 19: short_tag = short_tag[:18] ntags.append(short_tag) else: ntags.append(tag) if len(ntags) == 1: ntags = ntags[0].split(" ") ns = "" for t in ntags: if t != "": ns += t + "," ns = ns[:-1] if props.tags != ns: props.tags = ns def user_logged_in() -> bool: """User is currently logged in successfully""" user_preferences = bpy.context.preferences.addons[__package__].preferences # type: ignore if user_preferences.api_key == "": # type: ignore return False return True def profile_is_validator() -> bool: """currently logged in profile is validator""" user_preferences = bpy.context.preferences.addons[__package__].preferences # type: ignore api_key = user_preferences.api_key # type: ignore profile = global_vars.BKIT_PROFILE if profile is None or api_key == "": return False return profile.canEditAllAssets def user_is_owner(asset_data: Optional[dict] = None) -> bool: """Checks if the current logged in user is owner of the asset""" user_preferences = bpy.context.preferences.addons[__package__].preferences # type: ignore api_key = user_preferences.api_key # type: ignore profile = global_vars.BKIT_PROFILE if asset_data is None: bk_logger.warning("user_is_owner called with asset_data=None") return False if profile is None or api_key == "": return False if int(asset_data["author"].get("id")) == profile.id: return True return False def asset_from_newer_blender_version(asset_data, blender_version=None): """Check if asset is from a newer blender version, to avoid incompatibility. Give info if difference is in major, minor or patch version.""" # addons don't have a blender version, so we return False if asset_data["assetType"] == "addon": return False, "" asset_ver = asset_data["sourceAppVersion"].split(".") if blender_version is None: blender_version = bpy.app.version while len(asset_ver) < 3: asset_ver.append("0") if blender_version[0] < int(asset_ver[0]): return True, "major" elif blender_version[0] > int(asset_ver[0]): return False, "" if blender_version[1] < int(asset_ver[1]): return True, "minor" elif blender_version[1] > int(asset_ver[1]): return False, "" if blender_version[2] < int(asset_ver[2]): return True, "patch" return False, "" def asset_version_as_tuple(asset_data) -> tuple[int, ...]: """Convert a version string to a tuple of integers. This way it can be compared to the blender version tuple.""" return tuple(map(int, asset_data["sourceAppVersion"].split("."))) def guard_from_crash(): """ Blender tends to crash when trying to run some functions with the addon going through unregistration process. This function is used in these functions (like draw callbacks) so these don't run during unregistration. """ if bpy.context.preferences.addons.get(__package__) is None: return False if bpy.context.preferences.addons[__package__].preferences is None: return False return True def get_largest_area(context=None, area_type="VIEW_3D"): """Get the largest area of the given type.""" maxsurf = 0 maxa = None maxw = None region = None if context is None: if bpy.context.window is not None: windows = [bpy.context.window] else: windows = bpy.data.window_managers.windows else: windows = context.window_manager.windows for w in windows: if bpy.context.area is not None and bpy.context.area.type == area_type: maxa = bpy.context.area maxw = bpy.context.window maxsurf = maxa.width * maxa.height region = maxa.regions[-1] else: areas = w.screen.areas for a in w.screen.areas: if a.type == area_type: asurf = a.width * a.height if asurf > maxsurf: maxa = a maxw = w maxsurf = asurf region = a.regions[-1] # for r in a.regions: # if r.type == 'WINDOW': # region = r if maxw is None or maxa is None: return None, None, None return maxw, maxa, region def check_context(context, area_type="VIEW_3D"): return ( hasattr(context, "window") and hasattr(context, "screen") and hasattr(context, "area") and hasattr(context, "region") ) def get_fake_context(context=None, area_type="VIEW_3D"): C_dict = ( {} ) # context.copy() #context.copy was a source of problems - incompatibility with addons that also define context C_dict.update(region="WINDOW") # if hasattr(context,'window') and hasattr(context,'screen') and hasattr(context,'area') and hasattr(context,'region'): # w = context.window # s = context.screen # a = context.area # r = context.region # if not None in (w, s, a, r) and a.type == area_type and r.type == 'WINDOW': # override = {'window': w, 'screen': s, 'area': a, 'region': r} # # C_dict.update(override) # print('returning almost original context') # return C_dict # new context w, a, r = get_largest_area(context=context, area_type=area_type) if w: # sometimes there is no area of the requested type. Let's face it, some people use Blender without 3d view. override = { "window": w, "screen": w.screen, "area": a, "space_data": a.spaces.active, "region": r, } C_dict.update(override) return C_dict def has_url(text): # first remove markdown * text = text.replace("*", "") # Anything that isn't a square closing bracket name_regex = "[^]]+" # http:// or https:// followed by anything but a closing paren url_regex = "http[s]?://[^)]+" markup_regex = rf"\[({name_regex})]\(\s*({url_regex})\s*\)" urls = re.findall(markup_regex, text) replacechars = "[]()" for url in urls: text = re.sub(markup_regex, "", text) for ch in replacechars: text.replace(ch, "") return urls, text def line_with_urls(row, text, urls, icon="NONE", use_urls=False): used_urls = [] if use_urls: for i, url in enumerate(urls): op = row.operator("wm.blenderkit_url", text=url[0]) op.url = url[1] op.tooltip = "Go online to read more" # text = text.replace(url, '') # used_urls.append(url) if len(urls) > 0: return row.label(text=text, icon=icon) def label_multiline( layout, text="", icon="NONE", width=-1, max_lines=10, split_last=0, use_urls=False ): """ draw a ui label, but try to split it in multiple lines. Parameters ---------- layout text icon width width to split by in character count max_lines maximum lines to draw split_last - split last row to enable a button after it on the right side. The parameter is a ratio where to split. use_urls - automatically parse urls to buttons Returns ------- rows of the text(to add extra elements) """ rows = [] if text.strip() == "": return [layout.row()] text = text.replace("\r\n", "\n") lines = text.split("\n") if width > 0: threshold = int(width / 5.5) else: threshold = 35 line_index = 0 for line in lines: urls = [] if use_urls: urls, line = has_url(line) line_index += 1 while len(line) > threshold: # find line split close to the end of line i = line.rfind(" ", 0, threshold) # split long words if i < 1: i = threshold l1 = line[:i] row = layout.row() line_with_urls(row, l1, urls, icon=icon, use_urls=use_urls) rows.append(row) icon = "NONE" line = line[i:].lstrip() line_index += 1 if line_index > max_lines: break if line_index > max_lines: break row = layout.row() if split_last > 0: row = row.split(factor=split_last) line_with_urls(row, line, urls, icon=icon, use_urls=use_urls) rows.append(row) icon = "NONE" return rows def is_upload_old(last_blend_upload: Optional[str]) -> int: """ Estimates if the asset is far too long in the 'uploaded' state. This returns the number of days the validation is over the limit. """ if not last_blend_upload: return 0 date_time_obj = datetime.datetime.strptime(last_blend_upload[:10], "%Y-%m-%d") today = date_time_obj.today() age = today - date_time_obj old = datetime.timedelta(days=5) if age > old: return age.days - old.days return 0 def handle_nonblocking_request_task(task: client_tasks.Task): if task.status == "finished": reports.add_report(task.message) if task.status == "error": reports.add_report(task.message, type="ERROR") def string2list(text: str) -> list: """Convert a comma separated string to a list of strings.""" items = text.split(",") lst = [] for item in items: item = item.strip() if item != "": lst.append(item) return lst def list2string(lst: list) -> str: """Convert a list of strings to a comma separated string.""" text = "" for item in lst: text += item + ", " return text[:-2] def check_globaldir_permissions(): """Check if the user has the required permissions to upload assets.""" global_dir = bpy.context.preferences.addons[__package__].preferences.global_dir if os.path.isfile(global_dir): reports.add_report( "Global dir is a file. Please remove it or change global dir path in preferences.", type="ERROR", ) return False if not os.path.isdir(global_dir): bk_logger.info(f"Global dir does not exist. Creating it at {global_dir}") try: os.mkdir(global_dir) except Exception as e: reports.add_report( f"Cannot create Global dir. Check global dir path in preferences. {e}", type="ERROR", ) return False exists = os.access(global_dir, os.F_OK) can_write = os.access(global_dir, os.W_OK) can_execute = os.access(global_dir, os.X_OK) if exists and can_write and can_execute: bk_logger.info("Global dir permissions are OK.") return True reports.add_report( f"Change path or give permissions to Global dir, wrong permissions now: exists={exists}, write={can_write}, execute={can_execute}.", type="ERROR", ) def shorten_text(text: str, max_len: int = -1) -> str: """Shorten text to max_len characters and end it with '…' (horizontal elipsis) if the text was shortened (max_len-1 characters will be used, last one will be '…'). If max_len is -1, then no shortening is done.""" if max_len == -1: return text if len(text) > max_len: text = text[: max_len - 1] + "…" return text def remove_url_protocol(text: str) -> str: """Remove http:// or https:// from the beginning of the text. Useful for cleaner presentation of URLs to users.""" text = text.lstrip("https://") text = text.lstrip("http://") return text def enforce_prerelease_update_check(): """Enforce prerelease update check, used for validators and staff accounts. All staff should be aware of available (pre)releases ASAP to help finding bugs. """ bk_logger.info("Triggering (pre)release update check for validators account") preferences = bpy.context.preferences.addons[__package__].preferences preferences.enable_prereleases = True bpy.ops.blenderkit.updater_check_now() def get_blender_version() -> str: """Get Blender version as string in format X.Y.Z.""" ver = bpy.app.version return f"{ver[0]}.{ver[1]}.{ver[2]}" def get_addon_version() -> str: """Get BlenderKit addon version as string in format X.Y.Z.""" ver = global_vars.VERSION return f"{ver[0]}.{ver[1]}.{ver[2]}" def get_project_name() -> str: filename = bpy.path.basename(bpy.data.filepath) if filename == "": filename = "Untitled.blend" return filename class BlenderkitException(Exception): """Base class for all BlenderKit exceptions.""" pass class BlenderkitDownloadException(BlenderkitException): """Exception raised when a download fails.""" pass class BlenderkitAppendException(BlenderkitException): """Exception raised when an append or link of the asset fails.""" pass