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