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