interface_template_shape_key_tree.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2025 Blender Foundation
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#include <fmt/format.h>
 
#include "BKE_context.hh"
#include "BKE_key.hh"
#include "BKE_object.hh"
 
#include "BLI_listbase.h"
#include "BLT_translation.hh"
 
#include "UI_interface_layout.hh"
#include "UI_tree_view.hh"
 
#include "RNA_access.hh"
#include "RNA_prototypes.hh"
 
#include "DEG_depsgraph.hh"
 
#include "DNA_key_types.h"
 
#include "WM_api.hh"
#include "WM_types.hh"
 
#include "ED_undo.hh"
 
namespace blender::ed::object::shapekey {
 
class ShapeKeyTreeView : public ui::AbstractTreeView {
 protected:
  Object &object_;
 
 public:
  ShapeKeyTreeView(Object &ob) : object_(ob)
  {
    is_flat_ = true;
  };
 
  void build_tree() override;
};
 
struct ShapeKey {
  Object *object;
  Key *key;
  KeyBlock *kb;
  int index;
};
 
class ShapeKeyDragController : public ui::AbstractViewItemDragController {
 private:
  ShapeKey drag_key_;
 
 public:
  ShapeKeyDragController(ShapeKeyTreeView &view, ShapeKey drag_key)
      : AbstractViewItemDragController(view), drag_key_(drag_key)
  {
  }
 
  std::optional<eWM_DragDataType> get_drag_type() const override
  {
    return WM_DRAG_SHAPE_KEY;
  }
 
  void *create_drag_data() const override
  {
    int selected_count = [&]() -> int {
      int count = 0;
      LISTBASE_FOREACH (KeyBlock *, kb, &drag_key_.key->block) {
        count += (kb->flag & KEYBLOCK_SEL) != 0;
      }
      return count;
    }();
 
    KeyBlock **selected_keys_ = MEM_calloc_arrayN<KeyBlock *>(selected_count,
                                                              "Selected Key Blocks");
 
    selected_count = 0;
    int index = 0;
    LISTBASE_FOREACH_INDEX (KeyBlock *, kb, &drag_key_.key->block, index) {
      if (index == 0) {
        /* Prevent basis shape key from dragging. */
        continue;
      }
 
      if (kb->flag & KEYBLOCK_SEL) {
        selected_keys_[selected_count] = kb;
        selected_count++;
      }
    }
    return selected_keys_;
  }
};
 
class ShapeKeyDropTarget : public ui::TreeViewItemDropTarget {
 private:
  KeyBlock &drop_kb_;
  int drop_index_;
 
 public:
  ShapeKeyDropTarget(ui::AbstractTreeViewItem &item,
                     ui::DropBehavior behavior,
                     KeyBlock &drop_kb,
                     int index)
      : TreeViewItemDropTarget(item, behavior), drop_kb_(drop_kb), drop_index_(index)
  {
  }
 
  bool can_drop(const wmDrag &drag, const char ** /*r_disabled_hint*/) const override
  {
    if (drag.type != WM_DRAG_SHAPE_KEY) {
      return false;
    }
 
    const KeyBlock **drag_shapekey = static_cast<const KeyBlock **>(drag.poin);
    if (!drag_shapekey || !drag_shapekey[0]) {
      return false;
    }
 
    return true;
  }
 
  std::string drop_tooltip(const ui::DragInfo &drag_info) const override
  {
    const StringRef drag_name = TIP_("Selected Keys");
    const StringRef drop_name = drop_kb_.name;
 
    switch (drag_info.drop_location) {
      case ui::DropLocation::Into:
        BLI_assert_unreachable();
        break;
      case ui::DropLocation::Before:
        if (drop_index_ == 0) {
          return TIP_("Cannot move above basis shape key");
        }
        return fmt::format(fmt::runtime(TIP_("Move {} above {}")), drag_name, drop_name);
      case ui::DropLocation::After:
        return fmt::format(fmt::runtime(TIP_("Move {} below {}")), drag_name, drop_name);
      default:
        BLI_assert_unreachable();
        break;
    }
 
    return "";
  }
 
  bool on_drop(bContext *C, const ui::DragInfo &drag_info) const override
  {
    Object *ob = CTX_data_active_object(C);
    Key *key = BKE_key_from_object(ob);
    const KeyBlock **drag_shapekey = static_cast<const KeyBlock **>(drag_info.drag_data.poin);
 
    for (int8_t i = 0; drag_shapekey[i] != nullptr; i++) {
      const int drag_index = BLI_findindex(&key->block, drag_shapekey[i]);
      int drop_index = BLI_findindex(&key->block, &drop_kb_);
 
      if (drag_index == -1) {
        continue;
      }
 
      switch (drag_info.drop_location) {
        case ui::DropLocation::Into:
          BLI_assert_unreachable();
          break;
        case ui::DropLocation::Before:
          if (drop_index == 0) {
            return false;
          }
          drop_index -= int(drag_index < drop_index);
          break;
        case ui::DropLocation::After:
          drop_index += int(drag_index > drop_index) + i;
          break;
      }
 
      BKE_keyblock_move(ob, drag_index, drop_index);
    }
 
    DEG_id_tag_update(static_cast<ID *>(ob->data), ID_RECALC_GEOMETRY);
    WM_event_add_notifier(C, NC_OBJECT | ND_DRAW, ob);
    ED_undo_push(C, "Drop Active Shape Key");
 
    return true;
  }
};
 
class ShapeKeyItem : public ui::AbstractTreeViewItem {
 private:
  ShapeKey shape_key_;
 
 public:
  ShapeKeyItem(Object *object, Key *key, KeyBlock *kb, int index)
  {
    label_ = kb->name;
    shape_key_.object = object;
    shape_key_.key = key;
    shape_key_.kb = kb;
    shape_key_.index = index;
  };
 
  void build_row(uiLayout &row) override
  {
    uiItemL_ex(&row, this->label_, ICON_SHAPEKEY_DATA, false, false);
    uiLayout *sub = &row.row(true);
    sub->use_property_decorate_set(false);
    PointerRNA shapekey_ptr = RNA_pointer_create_discrete(
        &shape_key_.key->id, &RNA_ShapeKey, shape_key_.kb);
 
    if (shape_key_.index > 0) {
      sub->prop(&shapekey_ptr, "value", UI_ITEM_R_ICON_ONLY, std::nullopt, ICON_NONE);
    }
 
    sub->prop(&shapekey_ptr, "mute", UI_ITEM_R_ICON_ONLY, std::nullopt, ICON_NONE);
    sub->prop(&shapekey_ptr, "lock_shape", UI_ITEM_R_ICON_ONLY, std::nullopt, ICON_NONE);
    if (shape_key_.kb->flag & KEYBLOCK_MUTE) {
      row.active_set(false);
    }
  }
 
  std::optional<bool> should_be_active() const override
  {
    return shape_key_.object->shapenr == shape_key_.index + 1;
  }
 
  void on_activate(bContext &C) override
  {
    PointerRNA object_ptr = RNA_pointer_create_discrete(
        &shape_key_.object->id, &RNA_Object, shape_key_.object);
    PropertyRNA *prop = RNA_struct_find_property(&object_ptr, "active_shape_key_index");
    RNA_property_int_set(&object_ptr, prop, shape_key_.index);
    RNA_property_update(&C, &object_ptr, prop);
 
    ED_undo_push(&C, "Set Active Shape Key");
  }
 
  std::optional<bool> should_be_selected() const override
  {
    return shape_key_.kb->flag & KEYBLOCK_SEL;
  }
 
  void set_selected(const bool select) override
  {
    AbstractViewItem::set_selected(select);
    SET_FLAG_FROM_TEST(shape_key_.kb->flag, select, KEYBLOCK_SEL);
  }
 
  bool supports_renaming() const override
  {
    return true;
  }
 
  bool rename(const bContext &C, StringRefNull new_name) override
  {
    PointerRNA shapekey_ptr = RNA_pointer_create_discrete(
        &shape_key_.key->id, &RNA_ShapeKey, shape_key_.kb);
    RNA_string_set(&shapekey_ptr, "name", new_name.c_str());
    ED_undo_push(const_cast<bContext *>(&C), "Rename shape key");
    return true;
  }
 
  StringRef get_rename_string() const override
  {
    return label_;
  }
 
  void delete_item(bContext *C) override
  {
    Main *bmain = CTX_data_main(C);
    BKE_object_shapekey_remove(bmain, shape_key_.object, shape_key_.kb);
    DEG_id_tag_update(&shape_key_.object->id, ID_RECALC_GEOMETRY);
    WM_event_add_notifier(C, NC_OBJECT | ND_DRAW, nullptr);
    ED_undo_grouped_push(C, "Delete Shape Key");
  }
 
  void build_context_menu(bContext &C, uiLayout &layout) const override
  {
    MenuType *mt = WM_menutype_find("MESH_MT_shape_key_tree_context_menu", true);
    if (!mt) {
      return;
    }
    UI_menutype_draw(&C, mt, &layout);
  }
 
  std::unique_ptr<ui::AbstractViewItemDragController> create_drag_controller() const override
  {
    return std::make_unique<ShapeKeyDragController>(
        static_cast<ShapeKeyTreeView &>(get_tree_view()), shape_key_);
  }
 
  std::unique_ptr<ui::TreeViewItemDropTarget> create_drop_target() override
  {
    return std::make_unique<ShapeKeyDropTarget>(
        *this, ui::DropBehavior::Reorder, *shape_key_.kb, shape_key_.index);
  }
};
 
void ShapeKeyTreeView::build_tree()
{
  Key *key = BKE_key_from_object(&object_);
  if (key == nullptr) {
    return;
  }
  int index = 1;
  LISTBASE_FOREACH_INDEX (KeyBlock *, kb, &key->block, index) {
    this->add_tree_item<ShapeKeyItem>(&object_, key, kb, index);
  }
}
 
void template_tree(uiLayout *layout, bContext *C)
{
  Object *ob = CTX_data_active_object(C);
  if (ob == nullptr) {
    return;
  }
 
  uiBlock *block = layout->block();
 
  ui::AbstractTreeView *tree_view = UI_block_add_view(
      *block,
      "Shape Key Tree View",
      std::make_unique<ed::object::shapekey::ShapeKeyTreeView>(*ob));
  tree_view->set_context_menu_title("Shape Key");
  tree_view->set_default_rows(4);
  tree_view->allow_multiselect_items();
 
  ui::TreeViewBuilder::build_tree_view(*C, *tree_view, *layout);
}
}  // namespace blender::ed::object::shapekey