source/blender/blenkernel/BKE_grease_pencil_vertex_groups.hh

   1 /* SPDX-FileCopyrightText: 2023 Blender Authors
   2  *
   3  * SPDX-License-Identifier: GPL-2.0-or-later */
   4
   5 #pragma once
   6
   7 /** \file
   8  * \ingroup bke
   9  * \brief Utility functions for vertex groups in grease pencil objects
  10  */
  11
  12 #include "DNA_grease_pencil_types.h"
  13
  14 #include "BKE_attribute.hh"
  15
  16 namespace blender::bke::greasepencil {
  17
  18 /** Make sure drawings only contain vertex groups of the #GreasePencil. */
  19 void validate_drawing_vertex_groups(GreasePencil &grease_pencil);
  20
  21 /** Find or create a vertex group in a drawing. */
  22 int ensure_vertex_group(const StringRef name, ListBase &vertex_group_names);
  23
  24 /** Assign selected vertices to the vertex group. */
  25 void assign_to_vertex_group(Drawing &drawing, StringRef name, float weight);
  26
  27 void assign_to_vertex_group_from_mask(CurvesGeometry &curves,
  28                                       const IndexMask &mask,
  29                                       StringRef name,
  30                                       float weight);
  31
  32 /**
  33  * Remove selected vertices from the vertex group.
  34  * \return True if at least one vertex was removed from the group.
  35  */
  36 bool remove_from_vertex_group(Drawing &drawing, StringRef name, bool use_selection);
  37
  38 /** Remove vertices from all vertex groups. */
  39 void clear_vertex_groups(GreasePencil &grease_pencil);
  40
  41 /** Select or deselect vertices assigned to this group. */
  42 void select_from_group(Drawing &drawing,
  43                        const AttrDomain selection_domain,
  44                        StringRef name,
  45                        bool select);
  46
  47 }  // namespace blender::bke::greasepencil