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