Spelling Cleanup
[blender.git] / source / blender / modifiers / intern / MOD_weightvg_util.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2011 by Bastien Montagne.
19  * All rights reserved.
20  *
21  * Contributor(s): None yet.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  */
26
27 /** \file blender/modifiers/intern/MOD_weightvg_util.h
28  *  \ingroup modifiers
29  */
30
31
32 #ifndef __MOD_WEIGHTVG_UTIL_H__
33 #define __MOD_WEIGHTVG_UTIL_H__
34
35 /* so modifier types match their defines */
36 #include "MOD_modifiertypes.h"
37
38 struct CurveMapping;
39 struct DerivedMesh;
40 struct Object;
41 struct Tex;
42
43 /*
44  * XXX I'd like to make modified weights visible in WeightPaint mode,
45  *     but couldn't figure a way to do this...
46  *     Maybe this will need changes in mesh_calc_modifiers (DerivedMesh.c)?
47  *     Or the WeightPaint mode code itself?
48  */
49
50 /**************************************
51  * Util functions.                    *
52  **************************************/
53
54 /* We cannot divide by zero (what a surprise...).
55  * So if -MOD_WEIGHTVGROUP_DIVMODE_ZEROFLOOR < weightf < MOD_WEIGHTVGROUP_DIVMODE_ZEROFLOOR,
56  * we clamp weightf to this value (or its negative version).
57  * Also used to avoid null power factor.
58  */
59 #define MOD_WVG_ZEROFLOOR               1.0e-32f
60
61 /* Maps new_w weights in place, using either one of the predefined functions, or a custom curve.
62  * Return values are in new_w.
63  * If indices is not NULL, it must be a table of same length as org_w and new_w, mapping to the real
64  * vertex index (in case the weight tables do not cover the whole vertices...).
65  * cmap might be NULL, in which case curve mapping mode will return unmodified data.
66  */
67 void weightvg_do_map(int num, float *new_w, short mode, struct CurveMapping *cmap);
68
69 /* Applies new_w weights to org_w ones, using either a texture, vgroup or constant value as factor.
70  * Return values are in org_w.
71  * If indices is not NULL, it must be a table of same length as org_w and new_w, mapping to the real
72  * vertex index (in case the weight tables do not cover the whole vertices...).
73  * XXX The standard “factor” value is assumed in [0.0, 1.0] range. Else, weird results might appear.
74  */
75 void weightvg_do_mask(int num, const int *indices, float *org_w, const float *new_w, Object *ob,
76                       DerivedMesh *dm, float fact, const char defgrp_name[MAX_VGROUP_NAME], Tex *texture,
77                       int tex_use_channel, int tex_mapping, Object *tex_map_object,
78                       const char *tex_uvlayer_name);
79
80 /* Applies weights to given vgroup (defgroup), and optionnaly add/remove vertices from the group.
81  * If indices is not NULL, it must be a table of same length as weights, mapping to the real
82  * vertex index (in case the weight table does not cover the whole vertices...).
83  */
84 void weightvg_update_vg(MDeformVert *dvert, int defgrp_idx, MDeformWeight **dws, int num,
85                         const int *indices, const float *weights, int do_add,
86                         float add_thresh, int do_rem, float rem_thresh);
87
88 #endif /* __MOD_WEIGHTVG_UTIL_H__ */