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