Merge with 2.5 -r 21756:22173.
[blender-staging.git] / source / blender / makesrna / intern / rna_object_api.c
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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #include <time.h>
33
34 #include "RNA_define.h"
35 #include "RNA_types.h"
36
37 #include "DNA_object_types.h"
38
39 #include "BLO_sys_types.h" /* needed for intptr_t used in ED_mesh.h */
40
41 #include "ED_mesh.h"
42
43 #ifdef RNA_RUNTIME
44
45 #include "BKE_main.h"
46 #include "BKE_global.h"
47 #include "BKE_context.h"
48 #include "BKE_report.h"
49 #include "BKE_object.h"
50 #include "BKE_mesh.h"
51 #include "BKE_DerivedMesh.h"
52
53 #include "BKE_customdata.h"
54 #include "BKE_anim.h"
55 #include "BKE_depsgraph.h"
56 #include "BKE_displist.h"
57 #include "BKE_font.h"
58 #include "BKE_mball.h"
59
60 #include "BLI_arithb.h"
61
62 #include "DNA_mesh_types.h"
63 #include "DNA_scene_types.h"
64 #include "DNA_meshdata_types.h"
65 #include "DNA_curve_types.h"
66
67 #include "MEM_guardedalloc.h"
68
69 /* copied from Mesh_getFromObject and adapted to RNA interface */
70 /* settings: 0 - preview, 1 - render */
71 static Mesh *rna_Object_create_mesh(Object *ob, bContext *C, ReportList *reports, int apply_modifiers, int settings)
72 {
73         Mesh *tmpmesh;
74         Curve *tmpcu = NULL;
75         Object *tmpobj = NULL;
76         int render = settings, i;
77         int cage = !apply_modifiers;
78         Scene *sce = CTX_data_scene(C);
79
80         /* perform the mesh extraction based on type */
81         switch (ob->type) {
82         case OB_FONT:
83         case OB_CURVE:
84         case OB_SURF:
85
86                 /* copies object and modifiers (but not the data) */
87                 tmpobj= copy_object(ob);
88                 tmpcu = (Curve *)tmpobj->data;
89                 tmpcu->id.us--;
90
91                 /* if getting the original caged mesh, delete object modifiers */
92                 if( cage )
93                         object_free_modifiers(tmpobj);
94
95                 /* copies the data */
96                 tmpobj->data = copy_curve( (Curve *) ob->data );
97
98 #if 0
99                 /* copy_curve() sets disp.first null, so currently not need */
100                 {
101                         Curve *cu;
102                         cu = (Curve *)tmpobj->data;
103                         if( cu->disp.first )
104                                 MEM_freeN( cu->disp.first );
105                         cu->disp.first = NULL;
106                 }
107         
108 #endif
109
110                 /* get updated display list, and convert to a mesh */
111                 makeDispListCurveTypes( sce, tmpobj, 0 );
112                 nurbs_to_mesh( tmpobj );
113                 
114                 /* nurbs_to_mesh changes the type to a mesh, check it worked */
115                 if (tmpobj->type != OB_MESH) {
116                         free_libblock_us( &G.main->object, tmpobj );
117                         BKE_report(reports, RPT_ERROR, "cant convert curve to mesh. Does the curve have any segments?");
118                         return NULL;
119                 }
120                 tmpmesh = tmpobj->data;
121                 free_libblock_us( &G.main->object, tmpobj );
122                 break;
123
124         case OB_MBALL:
125                 /* metaballs don't have modifiers, so just convert to mesh */
126                 ob = find_basis_mball( sce, ob );
127                 tmpmesh = add_mesh("Mesh");
128                 mball_to_mesh( &ob->disp, tmpmesh );
129                 break;
130
131         case OB_MESH:
132                 /* copies object and modifiers (but not the data) */
133                 if (cage) {
134                         /* copies the data */
135                         tmpmesh = copy_mesh( ob->data );
136                 /* if not getting the original caged mesh, get final derived mesh */
137                 } else {
138                         /* Make a dummy mesh, saves copying */
139                         DerivedMesh *dm;
140                         /* CustomDataMask mask = CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL; */
141                         CustomDataMask mask = CD_MASK_MESH; /* this seems more suitable, exporter,
142                                                                                                    for example, needs CD_MASK_MDEFORMVERT */
143                         
144                         /* Write the display mesh into the dummy mesh */
145                         if (render)
146                                 dm = mesh_create_derived_render( sce, ob, mask );
147                         else
148                                 dm = mesh_create_derived_view( sce, ob, mask );
149                         
150                         tmpmesh = add_mesh( "Mesh" );
151                         DM_to_mesh( dm, tmpmesh );
152                         dm->release( dm );
153                 }
154                 
155                 break;
156         default:
157                 BKE_report(reports, RPT_ERROR, "Object does not have geometry data");
158                 return NULL;
159         }
160
161         /* Copy materials to new mesh */
162         switch (ob->type) {
163         case OB_SURF:
164                 tmpmesh->totcol = tmpcu->totcol;                
165                 
166                 /* free old material list (if it exists) and adjust user counts */
167                 if( tmpcu->mat ) {
168                         for( i = tmpcu->totcol; i-- > 0; ) {
169                                 /* are we an object material or data based? */
170                                 if (ob->colbits & 1<<i) 
171                                         tmpmesh->mat[i] = ob->mat[i];
172                                 else 
173                                         tmpmesh->mat[i] = tmpcu->mat[i];
174
175                                 if (tmpmesh->mat[i]) 
176                                         tmpmesh->mat[i]->id.us++;
177                         }
178                 }
179                 break;
180
181 #if 0
182         /* Crashes when assigning the new material, not sure why */
183         case OB_MBALL:
184                 tmpmb = (MetaBall *)ob->data;
185                 tmpmesh->totcol = tmpmb->totcol;
186                 
187                 /* free old material list (if it exists) and adjust user counts */
188                 if( tmpmb->mat ) {
189                         for( i = tmpmb->totcol; i-- > 0; ) {
190                                 tmpmesh->mat[i] = tmpmb->mat[i]; /* CRASH HERE ??? */
191                                 if (tmpmesh->mat[i]) {
192                                         tmpmb->mat[i]->id.us++;
193                                 }
194                         }
195                 }
196                 break;
197 #endif
198
199         case OB_MESH:
200                 if (!cage) {
201                         Mesh *origmesh= ob->data;
202                         tmpmesh->flag= origmesh->flag;
203                         tmpmesh->mat = MEM_dupallocN(origmesh->mat);
204                         tmpmesh->totcol = origmesh->totcol;
205                         tmpmesh->smoothresh= origmesh->smoothresh;
206                         if( origmesh->mat ) {
207                                 for( i = origmesh->totcol; i-- > 0; ) {
208                                         /* are we an object material or data based? */
209                                         if (ob->colbits & 1<<i)
210                                                 tmpmesh->mat[i] = ob->mat[i];
211                                         else
212                                                 tmpmesh->mat[i] = origmesh->mat[i];
213                                         if (tmpmesh->mat[i])
214                                                 tmpmesh->mat[i]->id.us++;
215                                 }
216                         }
217                 }
218                 break;
219         } /* end copy materials */
220
221         /* we don't assign it to anything */
222         tmpmesh->id.us--;
223         
224         /* make sure materials get updated in objects */
225         test_object_materials( ( ID * ) tmpmesh );
226
227         return tmpmesh;
228 }
229
230 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
231 static void rna_Object_create_duplilist(Object *ob, bContext *C, ReportList *reports)
232 {
233         if (!(ob->transflag & OB_DUPLI)) {
234                 BKE_report(reports, RPT_ERROR, "Object does not have duplis.");
235                 return;
236         }
237
238         /* free duplilist if a user forgets to */
239         if (ob->duplilist) {
240                 BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed.");
241
242                 free_object_duplilist(ob->duplilist);
243                 ob->duplilist= NULL;
244         }
245
246         ob->duplilist= object_duplilist(CTX_data_scene(C), ob);
247
248         /* ob->duplilist should now be freed with Object.free_duplilist */
249 }
250
251 static void rna_Object_free_duplilist(Object *ob, ReportList *reports)
252 {
253         if (ob->duplilist) {
254                 free_object_duplilist(ob->duplilist);
255                 ob->duplilist= NULL;
256         }
257 }
258
259 static void rna_Object_convert_to_triface(Object *ob, bContext *C, ReportList *reports, Scene *sce)
260 {
261         Mesh *me;
262         int ob_editing = CTX_data_edit_object(C) == ob;
263
264         if (ob->type != OB_MESH) {
265                 BKE_report(reports, RPT_ERROR, "Object should be of type MESH.");
266                 return;
267         }
268
269         me= (Mesh*)ob->data;
270
271         if (!ob_editing)
272                 make_editMesh(sce, ob);
273
274         /* select all */
275         EM_set_flag_all(me->edit_mesh, SELECT);
276
277         convert_to_triface(me->edit_mesh, 0);
278
279         load_editMesh(sce, ob);
280
281         if (!ob_editing)
282                 free_editMesh(me->edit_mesh);
283
284         DAG_object_flush_update(sce, ob, OB_RECALC_DATA);
285 }
286
287 static bDeformGroup *rna_Object_add_vertex_group(Object *ob, char *group_name)
288 {
289         return add_defgroup_name(ob, group_name);
290 }
291
292 static void rna_Object_add_vertex_to_group(Object *ob, int vertex_index, bDeformGroup *def, float weight, int assignmode)
293 {
294         /* creates dverts if needed */
295         add_vert_to_defgroup(ob, def, vertex_index, weight, assignmode);
296 }
297
298 /* copied from old API Object.makeDisplayList (Object.c) */
299 static void rna_Object_make_display_list(Object *ob, bContext *C)
300 {
301         Scene *sce= CTX_data_scene(C);
302
303         if (ob->type == OB_FONT) {
304                 Curve *cu = ob->data;
305                 freedisplist(&cu->disp);
306                 BKE_text_to_curve(sce, ob, CU_LEFT);
307         }
308
309         DAG_object_flush_update(sce, ob, OB_RECALC_DATA);
310 }
311
312 /*
313 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
314 {
315         if (ob->type != OB_MESH) {
316                 BKE_report(reports, RPT_ERROR, "Object should be of MESH type.");
317                 return;
318         }
319
320         Mesh *me = (Mesh*)ob->data;
321         int group_index = get_defgroup_num(ob, group);
322         if (group_index == -1) {
323                 BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh.");
324                 return;
325         }
326
327         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
328                 BKE_report(reports, RPT_ERROR, "Bad assignment mode." );
329                 return;
330         }
331
332         // makes a set of dVerts corresponding to the mVerts
333         if (!me->dvert) 
334                 create_dverts(&me->id);
335
336         // loop list adding verts to group 
337         for (i= 0; i < totindex; i++) {
338                 if(i < 0 || i >= me->totvert) {
339                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list.");
340                         return;
341                 }
342
343                 add_vert_defnr(ob, group_index, i, weight, assignmode);
344         }
345 }
346 */
347
348 #else
349
350 void RNA_api_object(StructRNA *srna)
351 {
352         FunctionRNA *func;
353         PropertyRNA *parm;
354
355         static EnumPropertyItem mesh_type_items[] = {
356                 {0, "PREVIEW", 0, "Preview", "Apply modifier preview settings."},
357                 {1, "RENDER", 0, "Render", "Apply modifier render settings."},
358                 {0, NULL, 0, NULL, NULL}
359         };
360
361         static EnumPropertyItem assign_mode_items[] = {
362                 {WEIGHT_REPLACE, "REPLACE", 0, "Replace", "Replace."}, /* TODO: more meaningful descriptions */
363                 {WEIGHT_ADD, "ADD", 0, "Add", "Add."},
364                 {WEIGHT_SUBTRACT, "SUBTRACT", 0, "Subtract", "Subtract."},
365                 {0, NULL, 0, NULL, NULL}
366         };
367
368         /* mesh */
369         func= RNA_def_function(srna, "create_mesh", "rna_Object_create_mesh");
370         RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied.");
371         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
372         parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers.");
373         RNA_def_property_flag(parm, PROP_REQUIRED);
374         parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply.");
375         RNA_def_property_flag(parm, PROP_REQUIRED);
376         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export.");
377         RNA_def_function_return(func, parm);
378
379         func= RNA_def_function(srna, "convert_to_triface", "rna_Object_convert_to_triface");
380         RNA_def_function_ui_description(func, "Convert all mesh faces to triangles.");
381         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
382         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene where the object belongs.");
383         RNA_def_property_flag(parm, PROP_REQUIRED);
384
385         /* duplis */
386         func= RNA_def_function(srna, "create_dupli_list", "rna_Object_create_duplilist");
387         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to be freed manually with free_dupli_list.");
388         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
389
390         func= RNA_def_function(srna, "free_dupli_list", "rna_Object_free_duplilist");
391         RNA_def_function_ui_description(func, "Free the list of dupli objects.");
392         RNA_def_function_flag(func, FUNC_USE_REPORTS);
393
394         /* vertex groups */
395         func= RNA_def_function(srna, "add_vertex_group", "rna_Object_add_vertex_group");
396         RNA_def_function_ui_description(func, "Add vertex group to object.");
397         parm= RNA_def_string(func, "name", "Group", 0, "", "Vertex group name."); /* optional */
398         parm= RNA_def_pointer(func, "group", "VertexGroup", "", "New vertex group.");
399         RNA_def_function_return(func, parm);
400
401         func= RNA_def_function(srna, "add_vertex_to_group", "rna_Object_add_vertex_to_group");
402         RNA_def_function_ui_description(func, "Add vertex to a vertex group.");
403         parm= RNA_def_int(func, "vertex_index", 0, 0, 0, "", "Vertex index.", 0, 0);
404         RNA_def_property_flag(parm, PROP_REQUIRED);
405         parm= RNA_def_pointer(func, "group", "VertexGroup", "", "Vertex group to add vertex to.");
406         RNA_def_property_flag(parm, PROP_REQUIRED);
407         parm= RNA_def_float(func, "weight", 0, 0.0f, 1.0f, "", "Vertex weight.", 0.0f, 1.0f);
408         RNA_def_property_flag(parm, PROP_REQUIRED);
409         parm= RNA_def_enum(func, "type", assign_mode_items, 0, "", "Vertex assign mode.");
410         RNA_def_property_flag(parm, PROP_REQUIRED);
411
412         /* DAG */
413         func= RNA_def_function(srna, "make_display_list", "rna_Object_make_display_list");
414         RNA_def_function_ui_description(func, "Update object's display data."); /* XXX describe better */
415         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
416 }
417
418 #endif
419