BKE_deform.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_math_vector_types.hh"
#include "BLI_offset_indices.hh"
#include "BLI_span.hh"
#include "BLI_string_ref.hh"
#include "BLI_virtual_array_fwd.hh"

 
struct BlendDataReader;
struct BlendWriter;
struct ID;
struct ListBase;
struct MDeformVert;
struct MDeformWeight;
struct Object;
struct bDeformGroup;
 
bool BKE_id_supports_vertex_groups(const ID *id);
bool BKE_object_supports_vertex_groups(const Object *ob);
const ListBase *BKE_object_defgroup_list(const Object *ob);
ListBase *BKE_object_defgroup_list_mutable(Object *ob);
 
int BKE_object_defgroup_count(const Object *ob);
int BKE_object_defgroup_active_index_get(const Object *ob);
void BKE_object_defgroup_active_index_set(Object *ob, int new_index);

const ListBase *BKE_id_defgroup_list_get(const ID *id);
ListBase *BKE_id_defgroup_list_get_mutable(ID *id);
int BKE_defgroup_name_index(const ListBase *defbase, blender::StringRef name);
int BKE_id_defgroup_name_index(const ID *id, blender::StringRef name);
bool BKE_defgroup_listbase_name_find(const ListBase *defbase,
                                     blender::StringRef name,
                                     int *r_index,
                                     bDeformGroup **r_group);
bool BKE_id_defgroup_name_find(const ID *id,
                               blender::StringRef name,
                               int *r_index,
                               bDeformGroup **r_group);
 
bDeformGroup *BKE_object_defgroup_new(Object *ob, blender::StringRef name);
void BKE_defgroup_copy_list(ListBase *outbase, const ListBase *inbase);
bDeformGroup *BKE_defgroup_duplicate(const bDeformGroup *ingroup);
bDeformGroup *BKE_object_defgroup_find_name(const Object *ob, blender::StringRef name);
int *BKE_object_defgroup_flip_map(const Object *ob, bool use_default, int *r_flip_map_num);

int *BKE_object_defgroup_flip_map_unlocked(const Object *ob,
                                           bool use_default,
                                           int *r_flip_map_num);
int *BKE_object_defgroup_flip_map_single(const Object *ob,
                                         bool use_default,
                                         int defgroup,
                                         int *r_flip_map_num);
int BKE_object_defgroup_flip_index(const Object *ob, int index, bool use_default);
int BKE_object_defgroup_name_index(const Object *ob, blender::StringRef name);
void BKE_object_defgroup_unique_name(bDeformGroup *dg, Object *ob);
void BKE_object_defgroup_set_name(bDeformGroup *dg, Object *ob, const char *new_name);
 
MDeformWeight *BKE_defvert_find_index(const MDeformVert *dv, int defgroup);
MDeformWeight *BKE_defvert_ensure_index(MDeformVert *dv, int defgroup);
void BKE_defvert_add_index_notest(MDeformVert *dv, int defgroup, float weight);
void BKE_defvert_remove_group(MDeformVert *dvert, MDeformWeight *dw);
void BKE_defvert_clear(MDeformVert *dvert);
int BKE_defvert_find_shared(const MDeformVert *dvert_a, const MDeformVert *dvert_b);
bool BKE_defvert_is_weight_zero(const MDeformVert *dvert, int defgroup_tot);
 
void BKE_defvert_array_free_elems(MDeformVert *dvert, int totvert);
void BKE_defvert_array_free(MDeformVert *dvert, int totvert);
void BKE_defvert_array_copy(MDeformVert *dst, const MDeformVert *src, int totvert);
 
float BKE_defvert_find_weight(const MDeformVert *dvert, int defgroup);
float BKE_defvert_array_find_weight_safe(const MDeformVert *dvert,
                                         int index,
                                         int defgroup,
                                         bool invert);

float BKE_defvert_total_selected_weight(const MDeformVert *dv,
                                        int defbase_num,
                                        const bool *defbase_sel);

float BKE_defvert_multipaint_collective_weight(const MDeformVert *dv,
                                               int defbase_num,
                                               const bool *defbase_sel,
                                               int defbase_sel_num,
                                               bool is_normalized);
 
/* This much unlocked weight is considered equivalent to none. */
#define VERTEX_WEIGHT_LOCK_EPSILON 1e-6f

float BKE_defvert_calc_lock_relative_weight(float weight,
                                            float locked_weight,
                                            float unlocked_weight);
float BKE_defvert_lock_relative_weight(float weight,
                                       const MDeformVert *dv,
                                       int defbase_num,
                                       const bool *defbase_locked,
                                       const bool *defbase_unlocked);
 
void BKE_defvert_copy(MDeformVert *dvert_dst, const MDeformVert *dvert_src);
void BKE_defvert_copy_subset(MDeformVert *dvert_dst,
                             const MDeformVert *dvert_src,
                             const bool *vgroup_subset,
                             int vgroup_num);
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);
void BKE_defvert_copy_index(MDeformVert *dvert_dst,
                            int defgroup_dst,
                            const MDeformVert *dvert_src,
                            int defgroup_src);
void BKE_defvert_sync(MDeformVert *dvert_dst, const MDeformVert *dvert_src, bool use_ensure);
void BKE_defvert_sync_mapped(MDeformVert *dvert_dst,
                             const MDeformVert *dvert_src,
                             const int *flip_map,
                             int flip_map_num,
                             bool use_ensure);
void BKE_defvert_remap(MDeformVert *dvert, const int *map, int map_len);
void BKE_defvert_flip(MDeformVert *dvert, const int *flip_map, int flip_map_num);
void BKE_defvert_flip_merged(MDeformVert *dvert, const int *flip_map, int flip_map_num);

void BKE_defvert_normalize(MDeformVert &dvert);

void BKE_defvert_normalize_subset(MDeformVert &dvert, blender::Span<bool> subset_flags);

void BKE_defvert_normalize_lock_map(MDeformVert &dvert,
                                    blender::Span<bool> subset_flags,
                                    blender::Span<bool> lock_flags);

void BKE_defvert_normalize_ex(MDeformVert &dvert,
                              blender::Span<bool> vgroup_subset,
                              blender::Span<bool> lock_flags,
                              blender::Span<bool> soft_lock_flags);
 
/* Utilities to 'extract' a given vgroup into a simple float array,
 * for verts, but also edges/faces/loops. */
 
void BKE_defvert_extract_vgroup_to_vertweights(
    const MDeformVert *dvert, int defgroup, int verts_num, bool invert_vgroup, float *r_weights);

void BKE_defvert_extract_vgroup_to_edgeweights(const MDeformVert *dvert,
                                               int defgroup,
                                               int verts_num,
                                               blender::Span<blender::int2> edges,
                                               bool invert_vgroup,
                                               float *r_weights);
void BKE_defvert_extract_vgroup_to_loopweights(const MDeformVert *dvert,
                                               int defgroup,
                                               int verts_num,
                                               blender::Span<int> corner_verts,
                                               bool invert_vgroup,
                                               float *r_weights);
 
void BKE_defvert_extract_vgroup_to_faceweights(const MDeformVert *dvert,
                                               int defgroup,
                                               int verts_num,
                                               const blender::Span<int> corner_verts,
                                               blender::OffsetIndices<int> faces,
                                               bool invert_vgroup,
                                               float *r_weights);
 
void BKE_defvert_weight_to_rgb(float r_rgb[3], float weight);
 
void BKE_defvert_blend_write(BlendWriter *writer, int count, const MDeformVert *dvlist);
void BKE_defvert_blend_read(BlendDataReader *reader, int count, MDeformVert *mdverts);
void BKE_defbase_blend_write(BlendWriter *writer, const ListBase *defbase);
 
namespace blender::bke {
 
VArray<float> varray_for_deform_verts(Span<MDeformVert> dverts, int defgroup_index);
VMutableArray<float> varray_for_mutable_deform_verts(MutableSpan<MDeformVert> dverts,
                                                     int defgroup_index);
void remove_defgroup_index(MutableSpan<MDeformVert> dverts, int defgroup_index);
 
void gather_deform_verts(Span<MDeformVert> src, Span<int> indices, MutableSpan<MDeformVert> dst);
void gather_deform_verts(Span<MDeformVert> src,
                         const IndexMask &indices,
                         MutableSpan<MDeformVert> dst);
 
}  // namespace blender::bke