Dependency graph: changed DAG_id_flush_update to DAG_id_tag_update. Now it
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
36 #include "DNA_object_types.h"
37
38 // #include "BLO_sys_types.h" /* needed for intptr_t used in ED_mesh.h */
39
40 // #include "ED_mesh.h"
41
42 #ifdef RNA_RUNTIME
43
44 #include "BKE_main.h"
45 #include "BKE_global.h"
46 #include "BKE_context.h"
47 #include "BKE_report.h"
48 #include "BKE_object.h"
49 #include "BKE_mesh.h"
50 #include "BKE_DerivedMesh.h"
51 #include "BKE_bvhutils.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 #include "BKE_modifier.h"
60
61 #include "BLI_math.h"
62
63 #include "DNA_mesh_types.h"
64 #include "DNA_scene_types.h"
65 #include "DNA_meshdata_types.h"
66 #include "DNA_curve_types.h"
67 #include "DNA_modifier_types.h"
68 #include "DNA_constraint_types.h"
69 #include "DNA_view3d_types.h"
70
71 #include "MEM_guardedalloc.h"
72
73 /* copied from Mesh_getFromObject and adapted to RNA interface */
74 /* settings: 0 - preview, 1 - render */
75 static Mesh *rna_Object_create_mesh(Object *ob, ReportList *reports, Scene *sce, int apply_modifiers, int settings)
76 {
77         Mesh *tmpmesh;
78         Curve *tmpcu = NULL;
79         Object *tmpobj = NULL;
80         int render = settings, i;
81         int cage = !apply_modifiers;
82
83         /* perform the mesh extraction based on type */
84          switch (ob->type) {
85          case OB_FONT:
86          case OB_CURVE:
87          case OB_SURF:
88
89                 /* copies object and modifiers (but not the data) */
90                 tmpobj= copy_object(ob);
91                 tmpcu = (Curve *)tmpobj->data;
92                 tmpcu->id.us--;
93
94                 /* if getting the original caged mesh, delete object modifiers */
95                 if( cage )
96                         object_free_modifiers(tmpobj);
97
98                 /* copies the data */
99                 tmpobj->data = copy_curve( (Curve *) ob->data );
100
101 #if 0
102                 /* copy_curve() sets disp.first null, so currently not need */
103                 {
104                         Curve *cu;
105                         cu = (Curve *)tmpobj->data;
106                         if( cu->disp.first )
107                                 MEM_freeN( cu->disp.first );
108                         cu->disp.first = NULL;
109                 }
110         
111 #endif
112
113                 /* get updated display list, and convert to a mesh */
114                 makeDispListCurveTypes( sce, tmpobj, 0 );
115                 nurbs_to_mesh( tmpobj );
116                 
117                 /* nurbs_to_mesh changes the type to a mesh, check it worked */
118                 if (tmpobj->type != OB_MESH) {
119                         free_libblock_us( &(G.main->object), tmpobj );
120                         BKE_report(reports, RPT_ERROR, "cant convert curve to mesh. Does the curve have any segments?");
121                         return NULL;
122                 }
123                 tmpmesh = tmpobj->data;
124                 free_libblock_us( &G.main->object, tmpobj );
125                 break;
126
127          case OB_MBALL:
128                 /* metaballs don't have modifiers, so just convert to mesh */
129                 ob = find_basis_mball( sce, ob );
130                 /* todo, re-generatre for render-res */
131                 /* metaball_polygonize(scene, ob) */
132
133                 tmpmesh = add_mesh("Mesh");
134                 mball_to_mesh( &ob->disp, tmpmesh );
135                  break;
136
137          case OB_MESH:
138                 /* copies object and modifiers (but not the data) */
139                 if (cage) {
140                         /* copies the data */
141                         tmpmesh = copy_mesh( ob->data );
142                 /* if not getting the original caged mesh, get final derived mesh */
143                 } else {
144                         /* Make a dummy mesh, saves copying */
145                         DerivedMesh *dm;
146                         /* CustomDataMask mask = CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL; */
147                         CustomDataMask mask = CD_MASK_MESH; /* this seems more suitable, exporter,
148                                                                                                    for example, needs CD_MASK_MDEFORMVERT */
149                         
150                         /* Write the display mesh into the dummy mesh */
151                         if (render)
152                                 dm = mesh_create_derived_render( sce, ob, mask );
153                         else
154                                 dm = mesh_create_derived_view( sce, ob, mask );
155                         
156                         tmpmesh = add_mesh( "Mesh" );
157                         DM_to_mesh( dm, tmpmesh );
158                         dm->release( dm );
159                 }
160                 
161                 break;
162          default:
163                 BKE_report(reports, RPT_ERROR, "Object does not have geometry data");
164                  return NULL;
165           }
166
167         /* Copy materials to new mesh */
168         switch (ob->type) {
169         case OB_SURF:
170                 tmpmesh->totcol = tmpcu->totcol;                
171                 
172                 /* free old material list (if it exists) and adjust user counts */
173                 if( tmpcu->mat ) {
174                         for( i = tmpcu->totcol; i-- > 0; ) {
175                                 /* are we an object material or data based? */
176                                 if (ob->colbits & 1<<i) 
177                                         tmpmesh->mat[i] = ob->mat[i];
178                                 else 
179                                         tmpmesh->mat[i] = tmpcu->mat[i];
180
181                                 if (tmpmesh->mat[i]) 
182                                         tmpmesh->mat[i]->id.us++;
183                         }
184                 }
185                 break;
186
187 #if 0
188         /* Crashes when assigning the new material, not sure why */
189         case OB_MBALL:
190                 tmpmb = (MetaBall *)ob->data;
191                 tmpmesh->totcol = tmpmb->totcol;
192                 
193                 /* free old material list (if it exists) and adjust user counts */
194                 if( tmpmb->mat ) {
195                         for( i = tmpmb->totcol; i-- > 0; ) {
196                                 tmpmesh->mat[i] = tmpmb->mat[i]; /* CRASH HERE ??? */
197                                 if (tmpmesh->mat[i]) {
198                                         tmpmb->mat[i]->id.us++;
199                                 }
200                         }
201                 }
202                 break;
203 #endif
204
205         case OB_MESH:
206                 if (!cage) {
207                         Mesh *origmesh= ob->data;
208                         tmpmesh->flag= origmesh->flag;
209                         tmpmesh->mat = MEM_dupallocN(origmesh->mat);
210                         tmpmesh->totcol = origmesh->totcol;
211                         tmpmesh->smoothresh= origmesh->smoothresh;
212                         if( origmesh->mat ) {
213                                 for( i = origmesh->totcol; i-- > 0; ) {
214                                         /* are we an object material or data based? */
215                                         if (ob->colbits & 1<<i)
216                                                 tmpmesh->mat[i] = ob->mat[i];
217                                         else
218                                                 tmpmesh->mat[i] = origmesh->mat[i];
219                                         if (tmpmesh->mat[i])
220                                                 tmpmesh->mat[i]->id.us++;
221                                 }
222                         }
223                 }
224                 break;
225         } /* end copy materials */
226
227         /* we don't assign it to anything */
228         tmpmesh->id.us--;
229         
230         /* make sure materials get updated in objects */
231         test_object_materials( ( ID * ) tmpmesh );
232
233         return tmpmesh;
234 }
235
236 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
237 static void rna_Object_create_duplilist(Object *ob, ReportList *reports, Scene *sce)
238 {
239         if (!(ob->transflag & OB_DUPLI)) {
240                 BKE_report(reports, RPT_ERROR, "Object does not have duplis.");
241                 return;
242         }
243
244         /* free duplilist if a user forgets to */
245         if (ob->duplilist) {
246                 BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed.");
247
248                 free_object_duplilist(ob->duplilist);
249                 ob->duplilist= NULL;
250         }
251
252         ob->duplilist= object_duplilist(sce, ob);
253
254         /* ob->duplilist should now be freed with Object.free_duplilist */
255 }
256
257 static void rna_Object_free_duplilist(Object *ob, ReportList *reports)
258 {
259         if (ob->duplilist) {
260                 free_object_duplilist(ob->duplilist);
261                 ob->duplilist= NULL;
262         }
263 }
264
265 /* copied from old API Object.makeDisplayList (Object.c)
266  * use _ suffix because this exists for internal rna */
267 static void rna_Object_update(Object *ob, Scene *sce, int object, int data, int time)
268 {
269         int flag= 0;
270
271         if (ob->type == OB_FONT) {
272                 Curve *cu = ob->data;
273                 freedisplist(&cu->disp);
274                 BKE_text_to_curve(sce, ob, CU_LEFT);
275         }
276
277         if(object) flag |= OB_RECALC_OB;
278         if(data) flag |= OB_RECALC_DATA;
279         if(time) flag |= OB_RECALC_TIME;
280
281         DAG_id_tag_update(&ob->id, flag);
282 }
283
284 static PointerRNA rna_Object_add_shape_key(Object *ob, bContext *C, ReportList *reports, const char *name, int from_mix)
285 {
286         Scene *scene= CTX_data_scene(C);
287         KeyBlock *kb= NULL;
288
289         if((kb=object_insert_shape_key(scene, ob, name, from_mix))) {
290                 PointerRNA keyptr;
291
292                 RNA_pointer_create((ID *)ob->data, &RNA_ShapeKey, kb, &keyptr);
293                 WM_event_add_notifier(C, NC_OBJECT|ND_DRAW, ob);
294                 
295                 return keyptr;
296         }
297         else {
298                 BKE_reportf(reports, RPT_ERROR, "Object \"%s\"does not support shapes.", ob->id.name+2);
299                 return PointerRNA_NULL;
300         }
301 }
302
303 int rna_Object_is_visible(Object *ob, Scene *sce)
304 {
305         return !(ob->restrictflag & OB_RESTRICT_VIEW) && ob->lay & sce->lay;
306 }
307
308 /*
309 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
310 {
311         if (ob->type != OB_MESH) {
312                 BKE_report(reports, RPT_ERROR, "Object should be of MESH type.");
313                 return;
314         }
315
316         Mesh *me = (Mesh*)ob->data;
317         int group_index = defgroup_find_index(ob, group);
318         if (group_index == -1) {
319                 BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh.");
320                 return;
321         }
322
323         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
324                 BKE_report(reports, RPT_ERROR, "Bad assignment mode." );
325                 return;
326         }
327
328         // makes a set of dVerts corresponding to the mVerts
329         if (!me->dvert) 
330                 create_dverts(&me->id);
331
332         // loop list adding verts to group 
333         for (i= 0; i < totindex; i++) {
334                 if(i < 0 || i >= me->totvert) {
335                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list.");
336                         return;
337                 }
338
339                 add_vert_defnr(ob, group_index, i, weight, assignmode);
340         }
341 }
342 */
343
344 void rna_Object_ray_cast(Object *ob, ReportList *reports, float ray_start[3], float ray_end[3], float r_location[3], float r_normal[3], int *index)
345 {
346         BVHTreeFromMesh treeData= {0};
347         
348         if(ob->derivedFinal==NULL) {
349                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting.", ob->id.name+2);
350                 return;
351         }
352
353         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
354         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
355
356         if(treeData.tree==NULL) {
357                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting.", ob->id.name+2);
358                 return;
359         }
360         else {
361                 BVHTreeRayHit hit;
362                 float ray_nor[3], dist;
363                 sub_v3_v3v3(ray_nor, ray_end, ray_start);
364
365                 dist= hit.dist = normalize_v3(ray_nor);
366                 hit.index = -1;
367                 
368                 if(BLI_bvhtree_ray_cast(treeData.tree, ray_start, ray_nor, 0.0f, &hit, treeData.raycast_callback, &treeData) != -1) {
369                         if(hit.dist<=dist) {
370                                 copy_v3_v3(r_location, hit.co);
371                                 copy_v3_v3(r_normal, hit.no);
372                                 *index= hit.index;
373                                 return;
374                         }
375                 }
376         }
377
378         zero_v3(r_location);
379         zero_v3(r_normal);
380         *index= -1;
381 }
382
383 /* ObjectBase */
384
385 void rna_ObjectBase_layers_from_view(Base *base, View3D *v3d)
386 {
387         base->lay= base->object->lay= v3d->lay;
388 }
389
390 #else
391
392 void RNA_api_object(StructRNA *srna)
393 {
394         FunctionRNA *func;
395         PropertyRNA *parm;
396
397         static EnumPropertyItem mesh_type_items[] = {
398                 {0, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
399                 {1, "RENDER", 0, "Render", "Apply modifier render settings"},
400                 {0, NULL, 0, NULL, NULL}
401         };
402
403         /* mesh */
404         func= RNA_def_function(srna, "create_mesh", "rna_Object_create_mesh");
405         RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied.");
406         RNA_def_function_flag(func, FUNC_USE_REPORTS);
407         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers.");
408         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
409         parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers.");
410         RNA_def_property_flag(parm, PROP_REQUIRED);
411         parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply.");
412         RNA_def_property_flag(parm, PROP_REQUIRED);
413         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export.");
414         RNA_def_function_return(func, parm);
415
416         /* duplis */
417         func= RNA_def_function(srna, "create_dupli_list", "rna_Object_create_duplilist");
418         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to be freed manually with free_dupli_list.");
419         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis.");
420         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
421         RNA_def_function_flag(func, FUNC_USE_REPORTS);
422
423         func= RNA_def_function(srna, "free_dupli_list", "rna_Object_free_duplilist");
424         RNA_def_function_ui_description(func, "Free the list of dupli objects.");
425         RNA_def_function_flag(func, FUNC_USE_REPORTS);
426
427         /* Armature */
428         func= RNA_def_function(srna, "find_armature", "modifiers_isDeformedByArmature");
429         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier.");
430         parm= RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL.");
431         RNA_def_function_return(func, parm);
432
433         /* Shape key */
434         func= RNA_def_function(srna, "add_shape_key", "rna_Object_add_shape_key");
435         RNA_def_function_ui_description(func, "Add shape key to an object.");
436         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
437         parm= RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock."); /* optional */
438         parm= RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes.");
439         parm= RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock.");
440         RNA_def_property_flag(parm, PROP_RNAPTR);
441         RNA_def_function_return(func, parm);
442
443         /* Ray Cast */
444         func= RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
445         RNA_def_function_ui_description(func, "Cast a ray onto in object space.");
446         RNA_def_function_flag(func, FUNC_USE_REPORTS);
447         
448         /* ray start and end */
449         parm= RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
450         RNA_def_property_flag(parm, PROP_REQUIRED);
451         parm= RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
452         RNA_def_property_flag(parm, PROP_REQUIRED);
453
454         /* return location and normal */
455         parm= RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location", "The hit location of this ray cast", -1e4, 1e4);
456         RNA_def_property_flag(parm, PROP_THICK_WRAP);
457         RNA_def_function_output(func, parm);
458         parm= RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal", "The face normal at the ray cast hit location", -1e4, 1e4);
459         RNA_def_property_flag(parm, PROP_THICK_WRAP);
460         RNA_def_function_output(func, parm);
461         
462         parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found.", 0, 0);
463         RNA_def_function_output(func, parm);
464
465         
466         /* DAG */
467         func= RNA_def_function(srna, "update", "rna_Object_update");
468         RNA_def_function_ui_description(func, "Tag the object to update its display data.");
469         parm= RNA_def_pointer(func, "scene", "Scene", "", "");
470         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
471         RNA_def_boolean(func, "object", 1, "", "Tag the object for updating");
472         RNA_def_boolean(func, "data", 1, "", "Tag the objects display data for updating");
473         RNA_def_boolean(func, "time", 1, "", "Tag the object time related data for updating");
474
475         /* View */
476         func= RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
477         RNA_def_function_ui_description(func, "Determine if object is visible in a given scene.");
478         parm= RNA_def_pointer(func, "scene", "Scene", "", "");
479         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
480         parm= RNA_def_boolean(func, "is_visible", 0, "", "Object visibility.");
481         RNA_def_function_return(func, parm);
482 }
483
484
485 void RNA_api_object_base(StructRNA *srna)
486 {
487         FunctionRNA *func;
488         PropertyRNA *parm;
489
490         func= RNA_def_function(srna, "layers_from_view", "rna_ObjectBase_layers_from_view");
491         RNA_def_function_ui_description(func, "Sets the object layers from a 3D View (use when adding an object in local view).");
492         parm= RNA_def_pointer(func, "view", "SpaceView3D", "", "");
493         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
494 }
495
496 #endif
497