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