DCONFIG_Utils.py

# ------------------------------------------------------------
# Copyright(c) 2018-2020 Jesse Yurkovich
# Licensed under the MIT License <http://opensource.org/licenses/MIT>.
# See the LICENSE file in the repo root for full license information.
# ------------------------------------------------------------

import math
import bpy
import bmesh
from mathutils import (Vector)

DebugTraceEnabled = True


#
# Object utilities
#

def full_name(obj):
    return "{}({})".format(obj.name, obj.data.name)


def full_names(obj_list):
    name_list = []
    for obj in obj_list:
        name_list.append(full_name(obj))
    return name_list


def rename(obj, new_name):
    obj.name = new_name
    obj.data.name = new_name


def active_object_available(context, obj_types):
    active_object = context.active_object
    return active_object is not None and active_object.type in obj_types


def active_mesh_selected(context):
    active_object = context.active_object
    return active_object is not None and active_object.type == 'MESH' and (context.mode == 'EDIT_MESH' or active_object.select_get())


def get_objects(obj_list, obj_types):
    return [obj for obj in obj_list if obj.type in obj_types]


def get_sorted_meshes(obj_list, active_object):
    return sorted(get_objects(obj_list, {'MESH'}), key=lambda x: 0 if x == active_object else 1)


def make_active_object(context, obj):
    context.view_layer.objects.active = obj
    context.view_layer.objects.active.select_set(True)


def setup_op(layout, operator, icon=None, text='', **kwargs):
    if icon is not None:
        op = layout.operator(operator, icon=icon, text=text)
    else:
        op = layout.operator(operator, text=text)

    for prop, value in kwargs.items():
        setattr(op, prop, value)

#
# Mesh utilities
#


def add_new_bmesh(context, name, bm, align):
    if context.mode == 'OBJECT':
        bpy.ops.object.select_all(action='DESELECT')

        me = bpy.data.meshes.new(name)
        bm.to_mesh(me)
        bm.free()

        obj = bpy.data.objects.new(name, me)
        if align == 'CURSOR':
            obj.matrix_world = context.scene.cursor.matrix.copy()
        elif align == 'VIEW':
            mat = context.space_data.region_3d.view_matrix.transposed().to_4x4()
            mat.translation = context.scene.cursor.location
            obj.matrix_world = mat
        else:
            obj.matrix_world.translation = context.scene.cursor.location

        context.collection.objects.link(obj)
        make_active_object(context, obj)
    else:
        bpy.ops.mesh.select_all(action='DESELECT')

        if align == 'CURSOR':
            bmesh.ops.transform(bm, verts=bm.verts, matrix=context.scene.cursor.matrix)
        elif align == 'VIEW':
            mat = context.space_data.region_3d.view_matrix.transposed().to_4x4()
            mat.translation = context.scene.cursor.location
            bmesh.ops.transform(bm, verts=bm.verts, matrix=mat)
        else:
            new_location = context.active_object.matrix_world.inverted() @ context.scene.cursor.location
            bmesh.ops.translate(bm, verts=bm.verts, vec=new_location)

        bm_orig = bmesh.from_edit_mesh(context.active_object.data)

        new_verts = [bm_orig.verts.new(v.co) for v in bm.verts]
        for f in bm.faces:
            new_f = bm_orig.faces.new(new_verts[v.index] for v in f.verts)
            new_f.material_index = f.material_index

        bm_orig.normal_update()
        bm.free()

        bmesh.update_edit_mesh(context.active_object.data)

#
# Math utilities
#


def calculate_bbox(verts, matrix=None):
    mapped_verts = verts
    if matrix is not None:
        mapped_verts = map(lambda v, M=matrix: M @ v, verts)

    bbox_min = Vector(next(mapped_verts))
    bbox_max = bbox_min.copy()

    for v in mapped_verts:
        if v.x < bbox_min.x:
            bbox_min.x = v.x
        if v.y < bbox_min.y:
            bbox_min.y = v.y
        if v.z < bbox_min.z:
            bbox_min.z = v.z

        if v.x > bbox_max.x:
            bbox_max.x = v.x
        if v.y > bbox_max.y:
            bbox_max.y = v.y
        if v.z > bbox_max.z:
            bbox_max.z = v.z

    # Return bounding box verts
    return bbox_min, bbox_max


def get_view_orientation_from_quaternion(view_quat):
    def r(x):
        return round(x, 2)

    orientation_dict = {(0.0, 0.0, 0.0): 'TOP',
                        (r(math.pi), 0.0, 0.0): 'BOTTOM',
                        (r(math.pi / 2), 0.0, 0.0): 'FRONT',
                        (r(math.pi / 2), 0.0, r(math.pi)): 'BACK',
                        (r(math.pi / 2), 0.0, r(-math.pi / 2)): 'LEFT',
                        (r(math.pi / 2), 0.0, r(math.pi / 2)): 'RIGHT'}

    view_rot = view_quat.to_euler()
    return orientation_dict.get(tuple(map(r, view_rot)), None)

#
# Collection utilities
#


def find_collection(context, obj):
    collections = obj.users_collection
    if collections:
        return collections[0]
    return context.scene.collection


def make_collection(parent_collection, collection_name, hide_render=False):
    new_collection = bpy.data.collections.new(collection_name)
    new_collection.hide_render = hide_render
    parent_collection.children.link(new_collection)
    return new_collection


def get_helpers_collection(context):
    if context.scene.get("dc_helpers") is None:
        bpy.types.Scene.dc_helpers = bpy.props.PointerProperty(type=bpy.types.Collection)

        collection = make_collection(context.scene.collection, "dc_helpers", True)
        context.scene["dc_helpers"] = collection
    else:
        collection = context.scene["dc_helpers"]

    return collection


def get_boolean_collection(context, force_create):
    collection = None
    if context.scene.get("dc_booleans") is None:
        bpy.types.Scene.dc_booleans = bpy.props.PointerProperty(type=bpy.types.Collection)

        if force_create:
            collection = make_collection(context.scene.collection, "dc_booleans", True)
            context.scene["dc_booleans"] = collection
    else:
        collection = context.scene["dc_booleans"]

    return collection

#
# Trace utilities
#


def trace(level, message, *args):
    if DebugTraceEnabled:
        indent = "" if level == 0 else "  " * int(level)
        print(indent + message.format(*args))


def trace_enter(op):
    trace(0, "")
    trace(0, "ENTER " + type(op).__name__)


def trace_exit(op, result='FINISHED'):
    trace(0, "EXIT  " + type(op).__name__ + " : " + result)
    trace(0, "")
    return {result}


def user_canceled(op):
    return trace_exit(op, 'CANCELLED')


def warn_canceled(op, message, *args):
    op.report(type={'WARNING'}, message=message.format(*args))
    return trace_exit(op, 'CANCELLED')