Code cleanup: comments and typos
[blender.git] / source / blender / modifiers / intern / MOD_wireframe.c
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 * ***** END GPL LICENSE BLOCK *****
19 *
20 */
21
22 /** \file blender/modifiers/intern/MOD_wireframe.c
23  *  \ingroup modifiers
24  */
25
26 #include "MEM_guardedalloc.h"
27
28 #include "DNA_object_types.h"
29 #include "DNA_meshdata_types.h"
30
31 #include "BLI_math.h"
32 #include "BLI_utildefines.h"
33 #include "BLI_string.h"
34
35 #include "BKE_cdderivedmesh.h"
36 #include "BKE_deform.h"
37
38 #include "MOD_modifiertypes.h"
39 #include "MOD_util.h"
40
41 #include "bmesh.h"
42 #include "tools/bmesh_wireframe.h"
43
44 static void initData(ModifierData *md)
45 {
46         WireframeModifierData *wmd = (WireframeModifierData *)md;
47         wmd->offset = 0.02f;
48         wmd->flag = MOD_WIREFRAME_REPLACE | MOD_WIREFRAME_OFS_EVEN;
49         wmd->crease_weight = 1.0f;
50 }
51
52 static void copyData(ModifierData *md, ModifierData *target)
53 {
54 #if 0
55         WireframeModifierData *wmd = (WireframeModifierData *)md;
56         WireframeModifierData *twmd = (WireframeModifierData *)target;
57 #endif
58         modifier_copyData_generic(md, target);
59 }
60
61 static bool isDisabled(ModifierData *UNUSED(md), int UNUSED(useRenderParams))
62 {
63         return 0;
64 }
65
66 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
67 {
68         WireframeModifierData *wmd = (WireframeModifierData *)md;
69         CustomDataMask dataMask = 0;
70
71         /* ask for vertexgroups if we need them */
72         if (wmd->defgrp_name[0]) dataMask |= CD_MASK_MDEFORMVERT;
73
74         return dataMask;
75
76 }
77
78 static DerivedMesh *WireframeModifier_do( WireframeModifierData *wmd, Object *ob, DerivedMesh *dm)
79 {
80         DerivedMesh *result;
81         BMesh *bm;
82
83         const int defgrp_index = defgroup_name_index(ob, wmd->defgrp_name);
84
85         bm = DM_to_bmesh(dm, true);
86
87         BM_mesh_wireframe(
88                bm,
89                wmd->offset, wmd->offset_fac, wmd->offset_fac_vg,
90                (wmd->flag & MOD_WIREFRAME_REPLACE) != 0,
91                (wmd->flag & MOD_WIREFRAME_BOUNDARY) != 0,
92                (wmd->flag & MOD_WIREFRAME_OFS_EVEN) != 0,
93                (wmd->flag & MOD_WIREFRAME_OFS_RELATIVE) != 0,
94                (wmd->flag & MOD_WIREFRAME_CREASE) != 0,
95                wmd->crease_weight,
96                defgrp_index,
97                (wmd->flag & MOD_WIREFRAME_INVERT_VGROUP) != 0,
98                wmd->mat_ofs,
99                MAX2(ob->totcol - 1, 0),
100                false);
101
102         result = CDDM_from_bmesh(bm, true);
103         BM_mesh_free(bm);
104
105         result->dirty |= DM_DIRTY_NORMALS;
106
107         return result;
108
109 }
110
111 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *dm, ModifierApplyFlag UNUSED(flag))
112 {
113         return WireframeModifier_do((WireframeModifierData *)md, ob, dm);
114 }
115
116
117 ModifierTypeInfo modifierType_Wireframe = {
118         /* name */              "Wireframe",
119         /* structName */        "WireframeModifierData",
120         /* structSize */        sizeof(WireframeModifierData),
121         /* type */              eModifierTypeType_Constructive,
122         /* flags */             eModifierTypeFlag_AcceptsMesh |
123                                 eModifierTypeFlag_SupportsEditmode,
124
125         /* copyData */          copyData,
126         /* deformVerts */       NULL,
127         /* deformMatrices */    NULL,
128         /* deformVertsEM */     NULL,
129         /* deformMatricesEM */  NULL,
130         /* applyModifier */     applyModifier,
131         /* applyModifierEM */   NULL,
132         /* initData */          initData,
133         /* requiredDataMask */  requiredDataMask,
134         /* freeData */          NULL,
135         /* isDisabled */        isDisabled,
136         /* updateDepgraph */    NULL,
137         /* dependsOnTime */     NULL,
138         /* dependsOnNormals */  NULL,
139         /* foreachObjectLink */ NULL,
140         /* foreachIDLink */     NULL,
141         /* foreachTexLink */    NULL,
142 };