- fix python error for poselib UI when none is active.
[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         case OB_FONT:
171         case OB_CURVE:
172                 tmpmesh->totcol = tmpcu->totcol;                
173                 
174                 /* free old material list (if it exists) and adjust user counts */
175                 if( tmpcu->mat ) {
176                         for( i = tmpcu->totcol; i-- > 0; ) {
177                                 /* are we an object material or data based? */
178                                 if (ob->colbits & 1<<i) 
179                                         tmpmesh->mat[i] = ob->mat[i];
180                                 else 
181                                         tmpmesh->mat[i] = tmpcu->mat[i];
182
183                                 if (tmpmesh->mat[i]) 
184                                         tmpmesh->mat[i]->id.us++;
185                         }
186                 }
187                 break;
188
189 #if 0
190         /* Crashes when assigning the new material, not sure why */
191         case OB_MBALL:
192                 tmpmb = (MetaBall *)ob->data;
193                 tmpmesh->totcol = tmpmb->totcol;
194                 
195                 /* free old material list (if it exists) and adjust user counts */
196                 if( tmpmb->mat ) {
197                         for( i = tmpmb->totcol; i-- > 0; ) {
198                                 tmpmesh->mat[i] = tmpmb->mat[i]; /* CRASH HERE ??? */
199                                 if (tmpmesh->mat[i]) {
200                                         tmpmb->mat[i]->id.us++;
201                                 }
202                         }
203                 }
204                 break;
205 #endif
206
207         case OB_MESH:
208                 if (!cage) {
209                         Mesh *origmesh= ob->data;
210                         tmpmesh->flag= origmesh->flag;
211                         tmpmesh->mat = MEM_dupallocN(origmesh->mat);
212                         tmpmesh->totcol = origmesh->totcol;
213                         tmpmesh->smoothresh= origmesh->smoothresh;
214                         if( origmesh->mat ) {
215                                 for( i = origmesh->totcol; i-- > 0; ) {
216                                         /* are we an object material or data based? */
217                                         if (ob->colbits & 1<<i)
218                                                 tmpmesh->mat[i] = ob->mat[i];
219                                         else
220                                                 tmpmesh->mat[i] = origmesh->mat[i];
221                                         if (tmpmesh->mat[i])
222                                                 tmpmesh->mat[i]->id.us++;
223                                 }
224                         }
225                 }
226                 break;
227         } /* end copy materials */
228
229         /* we don't assign it to anything */
230         tmpmesh->id.us--;
231         
232         /* make sure materials get updated in objects */
233         test_object_materials( ( ID * ) tmpmesh );
234
235         return tmpmesh;
236 }
237
238 /* mostly a copy from convertblender.c */
239 static void dupli_render_particle_set(Scene *scene, Object *ob, int level, int enable)
240 {
241         /* ugly function, but we need to set particle systems to their render
242          * settings before calling object_duplilist, to get render level duplis */
243         Group *group;
244         GroupObject *go;
245         ParticleSystem *psys;
246         DerivedMesh *dm;
247         float mat[4][4];
248
249         unit_m4(mat);
250
251         if(level >= MAX_DUPLI_RECUR)
252                 return;
253         
254         if(ob->transflag & OB_DUPLIPARTS) {
255                 for(psys=ob->particlesystem.first; psys; psys=psys->next) {
256                         if(ELEM(psys->part->ren_as, PART_DRAW_OB, PART_DRAW_GR)) {
257                                 if(enable)
258                                         psys_render_set(ob, psys, mat, mat, 1, 1, 0.f);
259                                 else
260                                         psys_render_restore(ob, psys);
261                         }
262                 }
263
264                 if(level == 0 && enable) {
265                         /* this is to make sure we get render level duplis in groups:
266                         * the derivedmesh must be created before init_render_mesh,
267                         * since object_duplilist does dupliparticles before that */
268                         dm = mesh_create_derived_render(scene, ob, CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL);
269                         dm->release(dm);
270
271                         for(psys=ob->particlesystem.first; psys; psys=psys->next)
272                                 psys_get_modifier(ob, psys)->flag &= ~eParticleSystemFlag_psys_updated;
273                 }
274         }
275
276         if(ob->dup_group==NULL) return;
277         group= ob->dup_group;
278
279         for(go= group->gobject.first; go; go= go->next)
280                 dupli_render_particle_set(scene, go->ob, level+1, enable);
281 }
282 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
283 static void rna_Object_create_duplilist(Object *ob, ReportList *reports, Scene *sce)
284 {
285         if (!(ob->transflag & OB_DUPLI)) {
286                 BKE_report(reports, RPT_ERROR, "Object does not have duplis.");
287                 return;
288         }
289
290         /* free duplilist if a user forgets to */
291         if (ob->duplilist) {
292                 BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed.");
293
294                 free_object_duplilist(ob->duplilist);
295                 ob->duplilist= NULL;
296         }
297         if(G.rendering)
298                 dupli_render_particle_set(sce, ob, 0, 1);
299         ob->duplilist= object_duplilist(sce, ob);
300         if(G.rendering)
301                 dupli_render_particle_set(sce, ob, 0, 0);
302         /* ob->duplilist should now be freed with Object.free_duplilist */
303 }
304
305 static void rna_Object_free_duplilist(Object *ob)
306 {
307         if (ob->duplilist) {
308                 free_object_duplilist(ob->duplilist);
309                 ob->duplilist= NULL;
310         }
311 }
312
313 static PointerRNA rna_Object_shape_key_add(Object *ob, bContext *C, ReportList *reports, const char *name, int from_mix)
314 {
315         Scene *scene= CTX_data_scene(C);
316         KeyBlock *kb= NULL;
317
318         if((kb=object_insert_shape_key(scene, ob, name, from_mix))) {
319                 PointerRNA keyptr;
320
321                 RNA_pointer_create((ID *)ob->data, &RNA_ShapeKey, kb, &keyptr);
322                 WM_event_add_notifier(C, NC_OBJECT|ND_DRAW, ob);
323                 
324                 return keyptr;
325         }
326         else {
327                 BKE_reportf(reports, RPT_ERROR, "Object \"%s\"does not support shapes.", ob->id.name+2);
328                 return PointerRNA_NULL;
329         }
330 }
331
332 int rna_Object_is_visible(Object *ob, Scene *sce)
333 {
334         return !(ob->restrictflag & OB_RESTRICT_VIEW) && (ob->lay & sce->lay);
335 }
336
337 /*
338 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
339 {
340         if (ob->type != OB_MESH) {
341                 BKE_report(reports, RPT_ERROR, "Object should be of MESH type.");
342                 return;
343         }
344
345         Mesh *me = (Mesh*)ob->data;
346         int group_index = defgroup_find_index(ob, group);
347         if (group_index == -1) {
348                 BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh.");
349                 return;
350         }
351
352         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
353                 BKE_report(reports, RPT_ERROR, "Bad assignment mode." );
354                 return;
355         }
356
357         // makes a set of dVerts corresponding to the mVerts
358         if (!me->dvert) 
359                 create_dverts(&me->id);
360
361         // loop list adding verts to group 
362         for (i= 0; i < totindex; i++) {
363                 if(i < 0 || i >= me->totvert) {
364                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list.");
365                         return;
366                 }
367
368                 add_vert_defnr(ob, group_index, i, weight, assignmode);
369         }
370 }
371 */
372
373 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)
374 {
375         BVHTreeFromMesh treeData= {0};
376         
377         if(ob->derivedFinal==NULL) {
378                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting.", ob->id.name+2);
379                 return;
380         }
381
382         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
383         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
384
385         if(treeData.tree==NULL) {
386                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting.", ob->id.name+2);
387                 return;
388         }
389         else {
390                 BVHTreeRayHit hit;
391                 float ray_nor[3], dist;
392                 sub_v3_v3v3(ray_nor, ray_end, ray_start);
393
394                 dist= hit.dist = normalize_v3(ray_nor);
395                 hit.index = -1;
396                 
397                 if(BLI_bvhtree_ray_cast(treeData.tree, ray_start, ray_nor, 0.0f, &hit, treeData.raycast_callback, &treeData) != -1) {
398                         if(hit.dist<=dist) {
399                                 copy_v3_v3(r_location, hit.co);
400                                 copy_v3_v3(r_normal, hit.no);
401                                 *index= hit.index;
402                                 return;
403                         }
404                 }
405         }
406
407         zero_v3(r_location);
408         zero_v3(r_normal);
409         *index= -1;
410 }
411
412 /* ObjectBase */
413
414 void rna_ObjectBase_layers_from_view(Base *base, View3D *v3d)
415 {
416         base->lay= base->object->lay= v3d->lay;
417 }
418
419 #else
420
421 void RNA_api_object(StructRNA *srna)
422 {
423         FunctionRNA *func;
424         PropertyRNA *parm;
425
426         static EnumPropertyItem mesh_type_items[] = {
427                 {0, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
428                 {1, "RENDER", 0, "Render", "Apply modifier render settings"},
429                 {0, NULL, 0, NULL, NULL}
430         };
431
432         /* mesh */
433         func= RNA_def_function(srna, "create_mesh", "rna_Object_create_mesh");
434         RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied.");
435         RNA_def_function_flag(func, FUNC_USE_REPORTS);
436         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers.");
437         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
438         parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers.");
439         RNA_def_property_flag(parm, PROP_REQUIRED);
440         parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply.");
441         RNA_def_property_flag(parm, PROP_REQUIRED);
442         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export.");
443         RNA_def_function_return(func, parm);
444
445         /* duplis */
446         func= RNA_def_function(srna, "create_dupli_list", "rna_Object_create_duplilist");
447         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to be freed manually with free_dupli_list to restore the objects real matrix and layers.");
448         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis.");
449         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
450         RNA_def_function_flag(func, FUNC_USE_REPORTS);
451
452         func= RNA_def_function(srna, "free_dupli_list", "rna_Object_free_duplilist");
453         RNA_def_function_ui_description(func, "Free the list of dupli objects.");
454
455         /* Armature */
456         func= RNA_def_function(srna, "find_armature", "modifiers_isDeformedByArmature");
457         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier.");
458         parm= RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL.");
459         RNA_def_function_return(func, parm);
460
461         /* Shape key */
462         func= RNA_def_function(srna, "shape_key_add", "rna_Object_shape_key_add");
463         RNA_def_function_ui_description(func, "Add shape key to an object.");
464         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
465         RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock."); /* optional */
466         RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes.");
467         parm= RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock.");
468         RNA_def_property_flag(parm, PROP_RNAPTR);
469         RNA_def_function_return(func, parm);
470
471         /* Ray Cast */
472         func= RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
473         RNA_def_function_ui_description(func, "Cast a ray onto in object space.");
474         RNA_def_function_flag(func, FUNC_USE_REPORTS);
475         
476         /* ray start and end */
477         parm= RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
478         RNA_def_property_flag(parm, PROP_REQUIRED);
479         parm= RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
480         RNA_def_property_flag(parm, PROP_REQUIRED);
481
482         /* return location and normal */
483         parm= RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location", "The hit location of this ray cast", -1e4, 1e4);
484         RNA_def_property_flag(parm, PROP_THICK_WRAP);
485         RNA_def_function_output(func, parm);
486         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);
487         RNA_def_property_flag(parm, PROP_THICK_WRAP);
488         RNA_def_function_output(func, parm);
489         
490         parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found.", 0, 0);
491         RNA_def_function_output(func, parm);
492
493         /* View */
494         func= RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
495         RNA_def_function_ui_description(func, "Determine if object is visible in a given scene.");
496         parm= RNA_def_pointer(func, "scene", "Scene", "", "");
497         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
498         parm= RNA_def_boolean(func, "is_visible", 0, "", "Object visibility.");
499         RNA_def_function_return(func, parm);
500 }
501
502
503 void RNA_api_object_base(StructRNA *srna)
504 {
505         FunctionRNA *func;
506         PropertyRNA *parm;
507
508         func= RNA_def_function(srna, "layers_from_view", "rna_ObjectBase_layers_from_view");
509         RNA_def_function_ui_description(func, "Sets the object layers from a 3D View (use when adding an object in local view).");
510         parm= RNA_def_pointer(func, "view", "SpaceView3D", "", "");
511         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
512 }
513
514 #endif
515