Blender V5.0
blender::ui::bonecollections::BoneCollectionDropTarget Class Reference

Inherits blender::ui::TreeViewItemDropTarget.

Public Member Functions

 BoneCollectionDropTarget (AbstractTreeViewItem &item, DropBehavior behavior, const ArmatureBoneCollection &drop_bonecoll)
bool can_drop (const wmDrag &drag, const char **r_disabled_hint) const override
std::string drop_tooltip (const DragInfo &drag_info) const override
bool on_drop (bContext *C, const DragInfo &drag_info) const override
Public Member Functions inherited from blender::ui::TreeViewItemDropTarget
 TreeViewItemDropTarget (AbstractTreeViewItem &view_item, DropBehavior behavior=DropBehavior::Insert)
std::optional< DropLocationchoose_drop_location (const ARegion &region, const wmEvent &event) const override
template<class ViewType>
ViewType & get_view () const
Public Member Functions inherited from blender::ui::DropTargetInterface
 DropTargetInterface ()=default
virtual ~DropTargetInterface ()=default

Additional Inherited Members

Protected Attributes inherited from blender::ui::TreeViewItemDropTarget
AbstractTreeViewItemview_item_
const DropBehavior behavior_

Detailed Description

Definition at line 89 of file interface_template_bone_collection_tree.cc.

Constructor & Destructor Documentation

◆ BoneCollectionDropTarget()

blender::ui::bonecollections::BoneCollectionDropTarget::BoneCollectionDropTarget ( AbstractTreeViewItem & item,
DropBehavior behavior,
const ArmatureBoneCollection & drop_bonecoll )
inline

Member Function Documentation

◆ can_drop()

bool blender::ui::bonecollections::BoneCollectionDropTarget::can_drop ( const wmDrag & drag,
const char ** r_disabled_hint ) const
inlineoverridevirtual

Check if the data dragged with drag can be dropped on the element this drop target is for.

Parameters
r_disabled_hintReturn a static string to display to the user, explaining why dropping isn't possible on this UI element. Shouldn't be done too aggressively, e.g. don't set this if the drag-type can't be dropped here; only if it can but there's another reason it can't be dropped. Can assume this is a non-null pointer.

Implements blender::ui::DropTargetInterface.

Definition at line 101 of file interface_template_bone_collection_tree.cc.

References blender::ui::bonecollections::ArmatureBoneCollection::armature, blender::animrig::armature_bonecoll_is_descendant_of(), blender::ui::bonecollections::ArmatureBoneCollection::bcoll_index, wmDrag::poin, wmDrag::type, and WM_DRAG_BONE_COLLECTION.

◆ drop_tooltip()

std::string blender::ui::bonecollections::BoneCollectionDropTarget::drop_tooltip ( const DragInfo & drag) const
inlineoverridevirtual

Custom text to display when dragging over the element using this drop target. Should explain what happens when dropping the data onto this UI element. Will only be used if #DropTargetInterface::can_drop() returns true, so the implementing override doesn't have to check that again. The returned value must be a translated string.

Implements blender::ui::DropTargetInterface.

Definition at line 132 of file interface_template_bone_collection_tree.cc.

References blender::ui::After, blender::ui::bonecollections::ArmatureBoneCollection::bcoll(), blender::ui::Before, blender::ui::DragInfo::drag_data, blender::ui::DragInfo::drop_location, blender::ui::Into, BoneCollection::name, wmDrag::poin, and TIP_.

◆ on_drop()


The documentation for this class was generated from the following file: