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