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