Blender V5.3
BKE_deform.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
7#include "DNA_listBase.h"
9
11#include "BLI_offset_indices.hh"
12#include "BLI_span.hh"
13#include "BLI_string_ref.hh"
14#include "BLI_vector_set.hh"
16
17namespace blender {
18
23
24struct BlendDataReader;
25struct BlendWriter;
26struct ID;
27struct MDeformVert;
28struct MDeformWeight;
29struct Object;
30struct bDeformGroup;
31
32bool BKE_id_supports_vertex_groups(const ID *id);
34const ListBaseT<bDeformGroup> *BKE_object_defgroup_list(const Object *ob);
35ListBaseT<bDeformGroup> *BKE_object_defgroup_list_mutable(Object *ob);
36
45void BKE_object_defgroup_active_index_set(Object *ob, int new_index);
46
52const ListBaseT<bDeformGroup> *BKE_id_defgroup_list_get(const ID *id);
53ListBaseT<bDeformGroup> *BKE_id_defgroup_list_get_mutable(ID *id);
54int BKE_defgroup_name_index(const ListBaseT<bDeformGroup> *defbase, StringRef name);
55int BKE_id_defgroup_name_index(const ID *id, StringRef name);
56bool BKE_defgroup_listbase_name_find(ListBaseT<bDeformGroup> *defbase,
57 StringRef name,
58 int *r_index,
59 bDeformGroup **r_group);
60bool BKE_id_defgroup_name_find(ID *id, StringRef name, int *r_index, bDeformGroup **r_group);
61
63void BKE_defgroup_copy_list(ListBaseT<bDeformGroup> *outbase,
64 const ListBaseT<bDeformGroup> *inbase);
81int *BKE_object_defgroup_flip_map(const Object *ob, bool use_default, int *r_flip_map_num);
82
87 bool use_default,
88 int *r_flip_map_num);
93 bool use_default,
94 int defgroup,
95 int *r_flip_map_num);
96int BKE_object_defgroup_flip_index(const Object *ob, int index, bool use_default);
99void BKE_object_defgroup_set_name(bDeformGroup *dg, Object *ob, const char *new_name);
100
101MDeformWeight *BKE_defvert_find_index(const MDeformVert *dv, int defgroup);
113void BKE_defvert_add_index_notest(MDeformVert *dv, int defgroup, float weight);
120void BKE_defvert_clear(MDeformVert *dvert);
125int BKE_defvert_find_shared(const MDeformVert *dvert_a, const MDeformVert *dvert_b);
129bool BKE_defvert_is_weight_zero(const MDeformVert *dvert, int defgroup_tot);
130
131void BKE_defvert_array_free_elems(MDeformVert *dvert, int totvert);
132void BKE_defvert_array_free(MDeformVert *dvert, int totvert);
133void BKE_defvert_array_copy(MDeformVert *dst, const MDeformVert *src, int totvert);
134
135float BKE_defvert_find_weight(const MDeformVert *dvert, int defgroup);
144 int index,
145 int defgroup,
146 bool invert);
147
152 int defbase_num,
153 const bool *defbase_sel);
154
164 int defbase_num,
165 const bool *defbase_sel,
166 int defbase_sel_num,
167 bool is_normalized);
168
169/* This much unlocked weight is considered equivalent to none. */
170#define VERTEX_WEIGHT_LOCK_EPSILON 1e-6f
171
178 float locked_weight,
179 float unlocked_weight);
185float BKE_defvert_lock_relative_weight(float weight,
186 const MDeformVert *dv,
187 int defbase_num,
188 const bool *defbase_locked,
189 const bool *defbase_unlocked);
190
191void BKE_defvert_copy(MDeformVert *dvert_dst, const MDeformVert *dvert_src);
197void BKE_defvert_copy_subset(MDeformVert *dvert_dst,
198 const MDeformVert *dvert_src,
199 const bool *vgroup_subset,
200 int vgroup_num);
206void BKE_defvert_mirror_subset(MDeformVert *dvert_dst,
207 const MDeformVert *dvert_src,
208 const bool *vgroup_subset,
209 int vgroup_num,
210 const int *flip_map,
211 int flip_map_num);
217void BKE_defvert_copy_index(MDeformVert *dvert_dst,
218 int defgroup_dst,
219 const MDeformVert *dvert_src,
220 int defgroup_src);
225void BKE_defvert_sync(MDeformVert *dvert_dst, const MDeformVert *dvert_src, bool use_ensure);
229void BKE_defvert_sync_mapped(MDeformVert *dvert_dst,
230 const MDeformVert *dvert_src,
231 const int *flip_map,
232 int flip_map_num,
233 bool use_ensure);
237void BKE_defvert_remap(MDeformVert *dvert, const int *map, int map_len);
238void BKE_defvert_flip(MDeformVert *dvert, const int *flip_map, int flip_map_num);
239void BKE_defvert_flip_merged(MDeformVert *dvert, const int *flip_map, int flip_map_num);
240
249void BKE_defvert_normalize(MDeformVert &dvert);
250
259void BKE_defvert_normalize_subset(MDeformVert &dvert, Span<bool> subset_flags);
260
267void BKE_defvert_normalize_lock_map(MDeformVert &dvert,
268 Span<bool> subset_flags,
269 Span<bool> lock_flags);
270
300void BKE_defvert_normalize_ex(MDeformVert &dvert,
301 Span<bool> subset_flags,
302 Span<bool> lock_flags,
303 Span<bool> soft_lock_flags);
304
305/* Utilities to 'extract' a given vgroup into a simple float array,
306 * for verts, but also edges/faces/loops. */
307
309 const MDeformVert *dvert, int defgroup, int verts_num, bool invert_vgroup, float *r_weights);
310
315void BKE_defvert_extract_vgroup_to_edgeweights(const MDeformVert *dvert,
316 int defgroup,
317 int verts_num,
318 Span<int2> edges,
319 bool invert_vgroup,
320 float *r_weights);
321void BKE_defvert_extract_vgroup_to_loopweights(const MDeformVert *dvert,
322 int defgroup,
323 int verts_num,
324 Span<int> corner_verts,
325 bool invert_vgroup,
326 float *r_weights);
327
328void BKE_defvert_extract_vgroup_to_faceweights(const MDeformVert *dvert,
329 int defgroup,
330 int verts_num,
331 const Span<int> corner_verts,
332 OffsetIndices<int> faces,
333 bool invert_vgroup,
334 float *r_weights);
335
336void BKE_defvert_weight_to_rgb(float r_rgb[3], float weight);
337
338void BKE_defvert_blend_write(BlendWriter *writer, int count, const MDeformVert *dvlist);
339void BKE_defvert_blend_read(BlendDataReader *reader, int count, MDeformVert *mdverts);
340void BKE_defbase_blend_write(BlendWriter *writer, const ListBaseT<bDeformGroup> *defbase);
341
342namespace bke {
343
344VArray<float> varray_for_deform_verts(Span<MDeformVert> dverts, int defgroup_index);
345VMutableArray<float> varray_for_mutable_deform_verts(MutableSpan<MDeformVert> dverts,
346 int defgroup_index);
347void remove_defgroup_index(MutableSpan<MDeformVert> dverts, int defgroup_index);
348
349void gather_deform_verts(Span<MDeformVert> src, Span<int> indices, MutableSpan<MDeformVert> dst);
351 Span<int> indices,
352 const IndexMask &dst_mask,
353 MutableSpan<MDeformVert> dst);
355 const IndexMask &indices,
356 MutableSpan<MDeformVert> dst);
357
359 int operator()(const MDeformWeight &value) const
360 {
361 return value.def_nr;
362 }
363};
365
367 const Span<int> indices,
368 const Span<float> weights,
369 MDeformWeightSet &dw_buffer);
370
371} // namespace bke
372} // namespace blender
These structs are the foundation for all linked lists in the library system.
float2x2 invert(float2x2 mat)
void remove_defgroup_index(MutableSpan< MDeformVert > dverts, int defgroup_index)
Definition deform.cc:1758
void gather_deform_verts(Span< MDeformVert > src, Span< int > indices, MutableSpan< MDeformVert > dst)
Definition deform.cc:1774
MDeformVert mix_deform_verts(const Span< MDeformVert > src, const Span< int > indices, const Span< float > weights, MDeformWeightSet &dw_buffer)
Definition deform.cc:1809
VMutableArray< float > varray_for_mutable_deform_verts(MutableSpan< MDeformVert > dverts, int defgroup_index)
Definition deform.cc:1752
CustomIDVectorSet< MDeformWeight, WeightIndexGetter, 64 > MDeformWeightSet
VArray< float > varray_for_deform_verts(Span< MDeformVert > dverts, int defgroup_index)
Definition deform.cc:1748
BMesh Iterators.
void BKE_object_defgroup_unique_name(bDeformGroup *dg, Object *ob)
Definition deform.cc:758
void BKE_defvert_array_free(MDeformVert *dvert, int totvert)
Definition deform.cc:1079
bool BKE_defvert_is_weight_zero(const MDeformVert *dvert, int defgroup_tot)
Definition deform.cc:941
ListBaseT< bDeformGroup > * BKE_object_defgroup_list_mutable(Object *ob)
Definition deform.cc:602
void BKE_defbase_blend_write(BlendWriter *writer, const ListBaseT< bDeformGroup > *defbase)
Definition deform.cc:1597
bool BKE_defgroup_listbase_name_find(ListBaseT< bDeformGroup > *defbase, StringRef name, int *r_index, bDeformGroup **r_group)
Definition deform.cc:562
const ListBaseT< bDeformGroup > * BKE_object_defgroup_list(const Object *ob)
Definition deform.cc:591
void BKE_defvert_array_copy(MDeformVert *dst, const MDeformVert *src, int totvert)
Definition deform.cc:1043
int BKE_object_defgroup_count(const Object *ob)
Definition deform.cc:608
void BKE_defvert_remap(MDeformVert *dvert, const int *map, int map_len)
Definition deform.cc:223
bDeformGroup * BKE_object_defgroup_find_name(const Object *ob, StringRef name)
Definition deform.cc:530
void BKE_defvert_flip_merged(MDeformVert *dvert, const int *flip_map, int flip_map_num)
Definition deform.cc:432
void BKE_defvert_blend_read(BlendDataReader *reader, int count, MDeformVert *mdverts)
Definition deform.cc:1621
void BKE_defvert_blend_write(BlendWriter *writer, int count, const MDeformVert *dvlist)
Definition deform.cc:1604
const ListBaseT< bDeformGroup > * BKE_id_defgroup_list_get(const ID *id)
Definition deform.cc:472
void BKE_defvert_array_free_elems(MDeformVert *dvert, int totvert)
Definition deform.cc:1061
void BKE_defvert_extract_vgroup_to_faceweights(const MDeformVert *dvert, int defgroup, int verts_num, const Span< int > corner_verts, OffsetIndices< int > faces, bool invert_vgroup, float *r_weights)
Definition deform.cc:1165
void BKE_object_defgroup_active_index_set(Object *ob, int new_index)
Definition deform.cc:618
void BKE_defvert_extract_vgroup_to_vertweights(const MDeformVert *dvert, int defgroup, int verts_num, bool invert_vgroup, float *r_weights)
Definition deform.cc:1094
void BKE_defvert_clear(MDeformVert *dvert)
Definition deform.cc:918
int * BKE_object_defgroup_flip_map(const Object *ob, bool use_default, int *r_flip_map_num)
Definition deform.cc:673
int BKE_defgroup_name_index(const ListBaseT< bDeformGroup > *defbase, StringRef name)
Definition deform.cc:544
int BKE_id_defgroup_name_index(const ID *id, StringRef name)
Definition deform.cc:557
float BKE_defvert_find_weight(const MDeformVert *dvert, int defgroup)
Definition deform.cc:779
bool BKE_object_supports_vertex_groups(const Object *ob)
Definition deform.cc:465
void BKE_defvert_copy_subset(MDeformVert *dvert_dst, const MDeformVert *dvert_src, const bool *vgroup_subset, int vgroup_num)
Definition deform.cc:102
int * BKE_object_defgroup_flip_map_single(const Object *ob, bool use_default, int defgroup, int *r_flip_map_num)
Definition deform.cc:685
float BKE_defvert_lock_relative_weight(float weight, const MDeformVert *dv, int defbase_num, const bool *defbase_locked, const bool *defbase_unlocked)
Definition deform.cc:1022
float BKE_defvert_calc_lock_relative_weight(float weight, float locked_weight, float unlocked_weight)
Definition deform.cc:994
void BKE_defvert_normalize_ex(MDeformVert &dvert, Span< bool > subset_flags, Span< bool > lock_flags, Span< bool > soft_lock_flags)
Definition deform.cc:252
void BKE_defvert_extract_vgroup_to_edgeweights(const MDeformVert *dvert, int defgroup, int verts_num, Span< int2 > edges, bool invert_vgroup, float *r_weights)
Definition deform.cc:1113
VectorSet< T, InlineBufferCapacity, DefaultProbingStrategy, CustomIDHash< T, GetIDFn >, CustomIDEqual< T, GetIDFn > > CustomIDVectorSet
void BKE_defvert_copy_index(MDeformVert *dvert_dst, int defgroup_dst, const MDeformVert *dvert_src, int defgroup_src)
Definition deform.cc:153
bDeformGroup * BKE_defgroup_duplicate(const bDeformGroup *ingroup)
Definition deform.cc:85
void BKE_defvert_extract_vgroup_to_loopweights(const MDeformVert *dvert, int defgroup, int verts_num, Span< int > corner_verts, bool invert_vgroup, float *r_weights)
Definition deform.cc:1140
void BKE_defvert_sync_mapped(MDeformVert *dvert_dst, const MDeformVert *dvert_src, const int *flip_map, int flip_map_num, bool use_ensure)
Definition deform.cc:197
void BKE_defvert_mirror_subset(MDeformVert *dvert_dst, const MDeformVert *dvert_src, const bool *vgroup_subset, int vgroup_num, const int *flip_map, int flip_map_num)
Definition deform.cc:115
MDeformWeight * BKE_defvert_ensure_index(MDeformVert *dv, int defgroup)
Definition deform.cc:830
int BKE_object_defgroup_name_index(const Object *ob, StringRef name)
Definition deform.cc:597
bool BKE_id_supports_vertex_groups(const ID *id)
Definition deform.cc:457
float BKE_defvert_array_find_weight_safe(const MDeformVert *dvert, int index, int defgroup, bool invert)
Definition deform.cc:785
void BKE_defvert_normalize(MDeformVert &dvert)
Definition deform.cc:240
int BKE_object_defgroup_flip_index(const Object *ob, int index, bool use_default)
Definition deform.cc:720
void BKE_object_defgroup_set_name(bDeformGroup *dg, Object *ob, const char *new_name)
Definition deform.cc:767
void BKE_defvert_normalize_subset(MDeformVert &dvert, Span< bool > subset_flags)
Definition deform.cc:235
void BKE_defvert_flip(MDeformVert *dvert, const int *flip_map, int flip_map_num)
Definition deform.cc:418
void BKE_defvert_sync(MDeformVert *dvert_dst, const MDeformVert *dvert_src, bool use_ensure)
Definition deform.cc:177
bDeformGroup * BKE_object_defgroup_new(Object *ob, StringRef name)
Definition deform.cc:51
float BKE_defvert_total_selected_weight(const MDeformVert *dv, int defbase_num, const bool *defbase_sel)
Definition deform.cc:955
void BKE_defvert_add_index_notest(MDeformVert *dv, int defgroup, float weight)
Definition deform.cc:861
void BKE_defvert_copy(MDeformVert *dvert_dst, const MDeformVert *dvert_src)
Definition deform.cc:130
void BKE_defgroup_copy_list(ListBaseT< bDeformGroup > *outbase, const ListBaseT< bDeformGroup > *inbase)
Definition deform.cc:75
int BKE_defvert_find_shared(const MDeformVert *dvert_a, const MDeformVert *dvert_b)
Definition deform.cc:925
ListBaseT< bDeformGroup > * BKE_id_defgroup_list_get_mutable(ID *id)
Definition deform.cc:524
void BKE_defvert_weight_to_rgb(float r_rgb[3], float weight)
Definition deform.cc:1558
void BKE_defvert_remove_group(MDeformVert *dvert, MDeformWeight *dw)
Definition deform.cc:885
bool BKE_id_defgroup_name_find(ID *id, StringRef name, int *r_index, bDeformGroup **r_group)
Definition deform.cc:585
MDeformWeight * BKE_defvert_find_index(const MDeformVert *dv, int defgroup)
Definition deform.cc:811
int * BKE_object_defgroup_flip_map_unlocked(const Object *ob, bool use_default, int *r_flip_map_num)
Definition deform.cc:678
float BKE_defvert_multipaint_collective_weight(const MDeformVert *dv, int defbase_num, const bool *defbase_sel, int defbase_sel_num, bool is_normalized)
Definition deform.cc:977
void BKE_defvert_normalize_lock_map(MDeformVert &dvert, Span< bool > subset_flags, Span< bool > lock_flags)
Definition deform.cc:245
int BKE_object_defgroup_active_index_get(const Object *ob)
Definition deform.cc:613
int operator()(const MDeformWeight &value) const