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