synched with trunk at revision 32129
[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
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 #include "DNA_view3d_types.h"
69
70 #include "MEM_guardedalloc.h"
71
72 /* copied from Mesh_getFromObject and adapted to RNA interface */
73 /* settings: 0 - preview, 1 - render */
74 static Mesh *rna_Object_create_mesh(Object *ob, ReportList *reports, Scene *sce, int apply_modifiers, int settings)
75 {
76         Mesh *tmpmesh;
77         Curve *tmpcu = NULL;
78         Object *tmpobj = NULL;
79         int render = settings, i;
80         int cage = !apply_modifiers;
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( &(G.main->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, ReportList *reports, Scene *sce)
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(sce, 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 /* copied from old API Object.makeDisplayList (Object.c)
265  * use _ suffix because this exists for internal rna */
266 static void rna_Object_update(Object *ob, Scene *sce, int object, int data, int time)
267 {
268         int flag= 0;
269
270         if (ob->type == OB_FONT) {
271                 Curve *cu = ob->data;
272                 freedisplist(&cu->disp);
273                 BKE_text_to_curve(sce, ob, CU_LEFT);
274         }
275
276         if(object) flag |= OB_RECALC_OB;
277         if(data) flag |= OB_RECALC_DATA;
278         if(time) flag |= OB_RECALC_TIME;
279
280         DAG_id_flush_update(&ob->id, flag);
281 }
282
283 static Object *rna_Object_find_armature(Object *ob)
284 {
285         Object *ob_arm = NULL;
286
287         if (ob->type != OB_MESH) return NULL;
288
289         if (ob->parent && ob->partype == PARSKEL && ob->parent->type == OB_ARMATURE) {
290                 ob_arm = ob->parent;
291         }
292         else {
293                 ModifierData *mod = (ModifierData*)ob->modifiers.first;
294                 while (mod) {
295                         if (mod->type == eModifierType_Armature) {
296                                 ob_arm = ((ArmatureModifierData*)mod)->object;
297                         }
298
299                         mod = mod->next;
300                 }
301         }
302
303         return ob_arm;
304 }
305
306 static PointerRNA rna_Object_add_shape_key(Object *ob, bContext *C, ReportList *reports, char *name, int from_mix)
307 {
308         Scene *scene= CTX_data_scene(C);
309         KeyBlock *kb= NULL;
310
311         if((kb=object_insert_shape_key(scene, ob, name, from_mix))) {
312                 PointerRNA keyptr;
313
314                 RNA_pointer_create((ID *)ob->data, &RNA_ShapeKey, kb, &keyptr);
315                 WM_event_add_notifier(C, NC_OBJECT|ND_DRAW, ob);
316                 
317                 return keyptr;
318         }
319         else {
320                 BKE_reportf(reports, RPT_ERROR, "Object \"%s\"does not support shapes.", ob->id.name+2);
321                 return PointerRNA_NULL;
322         }
323 }
324
325 int rna_Object_is_visible(Object *ob, Scene *sce)
326 {
327         return !(ob->restrictflag & OB_RESTRICT_VIEW) && ob->lay & sce->lay;
328 }
329
330 /*
331 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
332 {
333         if (ob->type != OB_MESH) {
334                 BKE_report(reports, RPT_ERROR, "Object should be of MESH type.");
335                 return;
336         }
337
338         Mesh *me = (Mesh*)ob->data;
339         int group_index = defgroup_find_index(ob, group);
340         if (group_index == -1) {
341                 BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh.");
342                 return;
343         }
344
345         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
346                 BKE_report(reports, RPT_ERROR, "Bad assignment mode." );
347                 return;
348         }
349
350         // makes a set of dVerts corresponding to the mVerts
351         if (!me->dvert) 
352                 create_dverts(&me->id);
353
354         // loop list adding verts to group 
355         for (i= 0; i < totindex; i++) {
356                 if(i < 0 || i >= me->totvert) {
357                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list.");
358                         return;
359                 }
360
361                 add_vert_defnr(ob, group_index, i, weight, assignmode);
362         }
363 }
364 */
365
366 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)
367 {
368         BVHTreeFromMesh treeData;
369         
370         if(ob->derivedFinal==NULL) {
371                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting.", ob->id.name+2);
372                 return;
373         }
374
375         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
376         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
377
378         if(treeData.tree==NULL) {
379                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting.", ob->id.name+2);
380                 return;
381         }
382         else {
383                 BVHTreeRayHit hit;
384                 float ray_nor[3], dist;
385                 sub_v3_v3v3(ray_nor, ray_end, ray_start);
386
387                 dist= hit.dist = normalize_v3(ray_nor);
388                 hit.index = -1;
389                 
390                 if(BLI_bvhtree_ray_cast(treeData.tree, ray_start, ray_nor, 0.0f, &hit, treeData.raycast_callback, &treeData) != -1) {
391                         if(hit.dist<=dist) {
392                                 copy_v3_v3(r_location, hit.co);
393                                 copy_v3_v3(r_normal, hit.no);
394                                 *index= hit.index;
395                                 return;
396                         }
397                 }
398         }
399
400         zero_v3(r_location);
401         zero_v3(r_normal);
402         *index= -1;
403 }
404
405 /* ObjectBase */
406
407 void rna_ObjectBase_layers_from_view(Base *base, View3D *v3d)
408 {
409         base->lay= base->object->lay= v3d->lay;
410 }
411
412 #else
413
414 void RNA_api_object(StructRNA *srna)
415 {
416         FunctionRNA *func;
417         PropertyRNA *parm;
418
419         static EnumPropertyItem mesh_type_items[] = {
420                 {0, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
421                 {1, "RENDER", 0, "Render", "Apply modifier render settings"},
422                 {0, NULL, 0, NULL, NULL}
423         };
424
425         /* mesh */
426         func= RNA_def_function(srna, "create_mesh", "rna_Object_create_mesh");
427         RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied.");
428         RNA_def_function_flag(func, FUNC_USE_REPORTS);
429         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers.");
430         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
431         parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers.");
432         RNA_def_property_flag(parm, PROP_REQUIRED);
433         parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply.");
434         RNA_def_property_flag(parm, PROP_REQUIRED);
435         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export.");
436         RNA_def_function_return(func, parm);
437
438         /* duplis */
439         func= RNA_def_function(srna, "create_dupli_list", "rna_Object_create_duplilist");
440         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to be freed manually with free_dupli_list.");
441         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis.");
442         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
443         RNA_def_function_flag(func, FUNC_USE_REPORTS);
444
445         func= RNA_def_function(srna, "free_dupli_list", "rna_Object_free_duplilist");
446         RNA_def_function_ui_description(func, "Free the list of dupli objects.");
447         RNA_def_function_flag(func, FUNC_USE_REPORTS);
448
449         /* Armature */
450         func= RNA_def_function(srna, "find_armature", "rna_Object_find_armature");
451         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier.");
452         parm= RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL.");
453         RNA_def_function_return(func, parm);
454
455         /* Shape key */
456         func= RNA_def_function(srna, "add_shape_key", "rna_Object_add_shape_key");
457         RNA_def_function_ui_description(func, "Add shape key to an object.");
458         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
459         parm= RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock."); /* optional */
460         parm= RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes.");
461         parm= RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock.");
462         RNA_def_property_flag(parm, PROP_RNAPTR);
463         RNA_def_function_return(func, parm);
464
465         /* Ray Cast */
466         func= RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
467         RNA_def_function_ui_description(func, "Cast a ray onto in object space.");
468         RNA_def_function_flag(func, FUNC_USE_REPORTS);
469         
470         /* ray start and end */
471         parm= RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
472         RNA_def_property_flag(parm, PROP_REQUIRED);
473         parm= RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
474         RNA_def_property_flag(parm, PROP_REQUIRED);
475
476         /* return location and normal */
477         parm= RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location", "The hit location of this ray cast", -1e4, 1e4);
478         RNA_def_property_flag(parm, PROP_THICK_WRAP);
479         RNA_def_function_output(func, parm);
480         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);
481         RNA_def_property_flag(parm, PROP_THICK_WRAP);
482         RNA_def_function_output(func, parm);
483         
484         parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found.", 0, 0);
485         RNA_def_function_output(func, parm);
486
487         
488         /* DAG */
489         func= RNA_def_function(srna, "update", "rna_Object_update");
490         RNA_def_function_ui_description(func, "Tag the object to update its display data.");
491         parm= RNA_def_pointer(func, "scene", "Scene", "", "");
492         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
493         RNA_def_boolean(func, "object", 1, "", "Tag the object for updating");
494         RNA_def_boolean(func, "data", 1, "", "Tag the objects display data for updating");
495         RNA_def_boolean(func, "time", 1, "", "Tag the object time related data for updating");
496
497         /* View */
498         func= RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
499         RNA_def_function_ui_description(func, "Determine if object is visible in a given scene.");
500         parm= RNA_def_pointer(func, "scene", "Scene", "", "");
501         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
502         parm= RNA_def_boolean(func, "is_visible", 0, "", "Object visibility.");
503         RNA_def_function_return(func, parm);
504 }
505
506
507 void RNA_api_object_base(StructRNA *srna)
508 {
509         FunctionRNA *func;
510         PropertyRNA *parm;
511
512         func= RNA_def_function(srna, "layers_from_view", "rna_ObjectBase_layers_from_view");
513         RNA_def_function_ui_description(func, "Sets the object layers from a 3D View (use when adding an object in local view).");
514         parm= RNA_def_pointer(func, "view", "SpaceView3D", "", "");
515         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
516 }
517
518 #endif
519