Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / source / blender / makesrna / intern / rna_object_api.c
index 34e3caad61865f95ec48dcb51dad35617a1dbff0..c4508c718e5d0caa7a6656bc1253a22b5bca322d 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * $Id$
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/makesrna/intern/rna_object_api.c
+ *  \ingroup RNA
+ */
+
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 #include "RNA_define.h"
 
 #include "DNA_object_types.h"
+#include "DNA_modifier_types.h"
 
 // #include "BLO_sys_types.h" /* needed for intptr_t used in ED_mesh.h */
 
 // #include "ED_mesh.h"
 
+
 #ifdef RNA_RUNTIME
+#include "BLI_math.h"
 
 #include "BKE_main.h"
 #include "BKE_global.h"
@@ -58,8 +64,6 @@
 #include "BKE_mball.h"
 #include "BKE_modifier.h"
 
-#include "BLI_math.h"
-
 #include "DNA_mesh_types.h"
 #include "DNA_scene_types.h"
 #include "DNA_meshdata_types.h"
 
 /* copied from Mesh_getFromObject and adapted to RNA interface */
 /* settings: 0 - preview, 1 - render */
-static Mesh *rna_Object_create_mesh(Object *ob, ReportList *reports, Scene *sce, int apply_modifiers, int settings)
+Mesh *rna_Object_to_mesh(Object *ob, ReportList *reports, Scene *sce, int apply_modifiers, int settings)
 {
        Mesh *tmpmesh;
        Curve *tmpcu = NULL;
        Object *tmpobj = NULL;
-       int render = settings, i;
+       int render = settings == eModifierMode_Render, i;
        int cage = !apply_modifiers;
 
        /* perform the mesh extraction based on type */
-        switch (ob->type) {
-        case OB_FONT:
-        case OB_CURVE:
-        case OB_SURF:
+       switch (ob->type) {
+       case OB_FONT:
+       case OB_CURVE:
+       case OB_SURF:
 
                /* copies object and modifiers (but not the data) */
                tmpobj= copy_object(ob);
@@ -124,7 +128,7 @@ static Mesh *rna_Object_create_mesh(Object *ob, ReportList *reports, Scene *sce,
                free_libblock_us( &G.main->object, tmpobj );
                break;
 
-        case OB_MBALL:
+       case OB_MBALL:
                /* metaballs don't have modifiers, so just convert to mesh */
                ob = find_basis_mball( sce, ob );
                /* todo, re-generatre for render-res */
@@ -132,9 +136,9 @@ static Mesh *rna_Object_create_mesh(Object *ob, ReportList *reports, Scene *sce,
 
                tmpmesh = add_mesh("Mesh");
                mball_to_mesh( &ob->disp, tmpmesh );
-                break;
+               break;
 
-        case OB_MESH:
+       case OB_MESH:
                /* copies object and modifiers (but not the data) */
                if (cage) {
                        /* copies the data */
@@ -159,14 +163,16 @@ static Mesh *rna_Object_create_mesh(Object *ob, ReportList *reports, Scene *sce,
                }
                
                break;
-        default:
+       default:
                BKE_report(reports, RPT_ERROR, "Object does not have geometry data");
-                return NULL;
-         }
+               return NULL;
+       }
 
        /* Copy materials to new mesh */
        switch (ob->type) {
        case OB_SURF:
+       case OB_FONT:
+       case OB_CURVE:
                tmpmesh->totcol = tmpcu->totcol;                
                
                /* free old material list (if it exists) and adjust user counts */
@@ -233,28 +239,74 @@ static Mesh *rna_Object_create_mesh(Object *ob, ReportList *reports, Scene *sce,
        return tmpmesh;
 }
 
+/* mostly a copy from convertblender.c */
+static void dupli_render_particle_set(Scene *scene, Object *ob, int level, int enable)
+{
+       /* ugly function, but we need to set particle systems to their render
+        * settings before calling object_duplilist, to get render level duplis */
+       Group *group;
+       GroupObject *go;
+       ParticleSystem *psys;
+       DerivedMesh *dm;
+       float mat[4][4];
+
+       unit_m4(mat);
+
+       if(level >= MAX_DUPLI_RECUR)
+               return;
+       
+       if(ob->transflag & OB_DUPLIPARTS) {
+               for(psys=ob->particlesystem.first; psys; psys=psys->next) {
+                       if(ELEM(psys->part->ren_as, PART_DRAW_OB, PART_DRAW_GR)) {
+                               if(enable)
+                                       psys_render_set(ob, psys, mat, mat, 1, 1, 0.f);
+                               else
+                                       psys_render_restore(ob, psys);
+                       }
+               }
+
+               if(level == 0 && enable) {
+                       /* this is to make sure we get render level duplis in groups:
+                       * the derivedmesh must be created before init_render_mesh,
+                       * since object_duplilist does dupliparticles before that */
+                       dm = mesh_create_derived_render(scene, ob, CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL);
+                       dm->release(dm);
+
+                       for(psys=ob->particlesystem.first; psys; psys=psys->next)
+                               psys_get_modifier(ob, psys)->flag &= ~eParticleSystemFlag_psys_updated;
+               }
+       }
+
+       if(ob->dup_group==NULL) return;
+       group= ob->dup_group;
+
+       for(go= group->gobject.first; go; go= go->next)
+               dupli_render_particle_set(scene, go->ob, level+1, enable);
+}
 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
-static void rna_Object_create_duplilist(Object *ob, ReportList *reports, Scene *sce)
+void rna_Object_create_duplilist(Object *ob, ReportList *reports, Scene *sce)
 {
        if (!(ob->transflag & OB_DUPLI)) {
-               BKE_report(reports, RPT_ERROR, "Object does not have duplis.");
+               BKE_report(reports, RPT_ERROR, "Object does not have duplis");
                return;
        }
 
        /* free duplilist if a user forgets to */
        if (ob->duplilist) {
-               BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed.");
+               BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed");
 
                free_object_duplilist(ob->duplilist);
                ob->duplilist= NULL;
        }
-
+       if(G.rendering)
+               dupli_render_particle_set(sce, ob, 0, 1);
        ob->duplilist= object_duplilist(sce, ob);
-
+       if(G.rendering)
+               dupli_render_particle_set(sce, ob, 0, 0);
        /* ob->duplilist should now be freed with Object.free_duplilist */
 }
 
-static void rna_Object_free_duplilist(Object *ob, ReportList *reports)
+void rna_Object_free_duplilist(Object *ob)
 {
        if (ob->duplilist) {
                free_object_duplilist(ob->duplilist);
@@ -262,26 +314,7 @@ static void rna_Object_free_duplilist(Object *ob, ReportList *reports)
        }
 }
 
-/* copied from old API Object.makeDisplayList (Object.c)
- * use _ suffix because this exists for internal rna */
-static void rna_Object_update(Object *ob, Scene *sce, int object, int data, int time)
-{
-       int flag= 0;
-
-       if (ob->type == OB_FONT) {
-               Curve *cu = ob->data;
-               freedisplist(&cu->disp);
-               BKE_text_to_curve(sce, ob, CU_LEFT);
-       }
-
-       if(object) flag |= OB_RECALC_OB;
-       if(data) flag |= OB_RECALC_DATA;
-       if(time) flag |= OB_RECALC_TIME;
-
-       DAG_id_flush_update(&ob->id, flag);
-}
-
-static PointerRNA rna_Object_add_shape_key(Object *ob, bContext *C, ReportList *reports, const char *name, int from_mix)
+static PointerRNA rna_Object_shape_key_add(Object *ob, bContext *C, ReportList *reports, const char *name, int from_mix)
 {
        Scene *scene= CTX_data_scene(C);
        KeyBlock *kb= NULL;
@@ -295,33 +328,33 @@ static PointerRNA rna_Object_add_shape_key(Object *ob, bContext *C, ReportList *
                return keyptr;
        }
        else {
-               BKE_reportf(reports, RPT_ERROR, "Object \"%s\"does not support shapes.", ob->id.name+2);
+               BKE_reportf(reports, RPT_ERROR, "Object \"%s\"does not support shapes", ob->id.name+2);
                return PointerRNA_NULL;
        }
 }
 
 int rna_Object_is_visible(Object *ob, Scene *sce)
 {
-       return !(ob->restrictflag & OB_RESTRICT_VIEW) && ob->lay & sce->lay;
+       return !(ob->restrictflag & OB_RESTRICT_VIEW) && (ob->lay & sce->lay);
 }
 
 /*
 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
 {
        if (ob->type != OB_MESH) {
-               BKE_report(reports, RPT_ERROR, "Object should be of MESH type.");
+               BKE_report(reports, RPT_ERROR, "Object should be of MESH type");
                return;
        }
 
        Mesh *me = (Mesh*)ob->data;
        int group_index = defgroup_find_index(ob, group);
        if (group_index == -1) {
-               BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh.");
+               BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh");
                return;
        }
 
        if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
-               BKE_report(reports, RPT_ERROR, "Bad assignment mode." );
+               BKE_report(reports, RPT_ERROR, "Bad assignment mode" );
                return;
        }
 
@@ -332,7 +365,7 @@ static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int
        // loop list adding verts to group 
        for (i= 0; i < totindex; i++) {
                if(i < 0 || i >= me->totvert) {
-                       BKE_report(reports, RPT_ERROR, "Bad vertex index in list.");
+                       BKE_report(reports, RPT_ERROR, "Bad vertex index in list");
                        return;
                }
 
@@ -343,10 +376,10 @@ static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int
 
 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)
 {
-       BVHTreeFromMesh treeData= {0};
+       BVHTreeFromMesh treeData= {NULL};
        
        if(ob->derivedFinal==NULL) {
-               BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting.", ob->id.name+2);
+               BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting", ob->id.name+2);
                return;
        }
 
@@ -354,7 +387,7 @@ void rna_Object_ray_cast(Object *ob, ReportList *reports, float ray_start[3], fl
        bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
 
        if(treeData.tree==NULL) {
-               BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting.", ob->id.name+2);
+               BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting", ob->id.name+2);
                return;
        }
        else {
@@ -380,6 +413,41 @@ void rna_Object_ray_cast(Object *ob, ReportList *reports, float ray_start[3], fl
        *index= -1;
 }
 
+void rna_Object_closest_point_on_mesh(Object *ob, ReportList *reports, float point_co[3], float max_dist, float n_location[3], float n_normal[3], int *index)
+{
+       BVHTreeFromMesh treeData= {NULL};
+       
+       if(ob->derivedFinal==NULL) {
+               BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for finding nearest point", ob->id.name+2);
+               return;
+       }
+
+       /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
+       bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
+
+       if(treeData.tree==NULL) {
+               BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for finding nearest point", ob->id.name+2);
+               return;
+       }
+       else {
+               BVHTreeNearest nearest;
+
+               nearest.index = -1;
+               nearest.dist = max_dist * max_dist;
+
+               if(BLI_bvhtree_find_nearest(treeData.tree, point_co, &nearest, treeData.nearest_callback, &treeData) != -1) {
+                       copy_v3_v3(n_location, nearest.co);
+                       copy_v3_v3(n_normal, nearest.no);
+                       *index= nearest.index;
+                       return;
+               }
+       }
+
+       zero_v3(n_location);
+       zero_v3(n_normal);
+       *index= -1;
+}
+
 /* ObjectBase */
 
 void rna_ObjectBase_layers_from_view(Base *base, View3D *v3d)
@@ -387,6 +455,11 @@ void rna_ObjectBase_layers_from_view(Base *base, View3D *v3d)
        base->lay= base->object->lay= v3d->lay;
 }
 
+int rna_Object_is_modified(Object *ob, Scene *scene, int settings)
+{
+       return object_is_modified(scene, ob) & settings;
+}
+
 #else
 
 void RNA_api_object(StructRNA *srna)
@@ -395,54 +468,55 @@ void RNA_api_object(StructRNA *srna)
        PropertyRNA *parm;
 
        static EnumPropertyItem mesh_type_items[] = {
-               {0, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
-               {1, "RENDER", 0, "Render", "Apply modifier render settings"},
+               {eModifierMode_Realtime, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
+               {eModifierMode_Render, "RENDER", 0, "Render", "Apply modifier render settings"},
                {0, NULL, 0, NULL, NULL}
        };
 
        /* mesh */
-       func= RNA_def_function(srna, "create_mesh", "rna_Object_create_mesh");
-       RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied.");
+       func= RNA_def_function(srna, "to_mesh", "rna_Object_to_mesh");
+       RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied");
        RNA_def_function_flag(func, FUNC_USE_REPORTS);
-       parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers.");
+       parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers");
        RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
-       parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers.");
+       parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers");
        RNA_def_property_flag(parm, PROP_REQUIRED);
-       parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply.");
+       parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
        RNA_def_property_flag(parm, PROP_REQUIRED);
-       parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export.");
+       parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export");
        RNA_def_function_return(func, parm);
 
        /* duplis */
-       func= RNA_def_function(srna, "create_dupli_list", "rna_Object_create_duplilist");
-       RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to be freed manually with free_dupli_list.");
-       parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis.");
+       func= RNA_def_function(srna, "dupli_list_create", "rna_Object_create_duplilist");
+       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");
+       parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis");
        RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
        RNA_def_function_flag(func, FUNC_USE_REPORTS);
 
-       func= RNA_def_function(srna, "free_dupli_list", "rna_Object_free_duplilist");
-       RNA_def_function_ui_description(func, "Free the list of dupli objects.");
-       RNA_def_function_flag(func, FUNC_USE_REPORTS);
+       func= RNA_def_function(srna, "dupli_list_clear", "rna_Object_free_duplilist");
+       RNA_def_function_ui_description(func, "Free the list of dupli objects");
 
        /* Armature */
        func= RNA_def_function(srna, "find_armature", "modifiers_isDeformedByArmature");
-       RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier.");
-       parm= RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL.");
+       RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier");
+       parm= RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL");
        RNA_def_function_return(func, parm);
 
        /* Shape key */
-       func= RNA_def_function(srna, "add_shape_key", "rna_Object_add_shape_key");
-       RNA_def_function_ui_description(func, "Add shape key to an object.");
+       func= RNA_def_function(srna, "shape_key_add", "rna_Object_shape_key_add");
+       RNA_def_function_ui_description(func, "Add shape key to an object");
        RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
-       parm= RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock."); /* optional */
-       parm= RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes.");
-       parm= RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock.");
+       RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock"); /* optional */
+       RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes");
+       parm= RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock");
        RNA_def_property_flag(parm, PROP_RNAPTR);
        RNA_def_function_return(func, parm);
 
        /* Ray Cast */
        func= RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
-       RNA_def_function_ui_description(func, "Cast a ray onto in object space.");
+       RNA_def_function_ui_description(func, "Cast a ray onto in object space");
        RNA_def_function_flag(func, FUNC_USE_REPORTS);
        
        /* ray start and end */
@@ -459,25 +533,47 @@ void RNA_api_object(StructRNA *srna)
        RNA_def_property_flag(parm, PROP_THICK_WRAP);
        RNA_def_function_output(func, parm);
        
-       parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found.", 0, 0);
+       parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found", 0, 0);
        RNA_def_function_output(func, parm);
 
-       
-       /* DAG */
-       func= RNA_def_function(srna, "update", "rna_Object_update");
-       RNA_def_function_ui_description(func, "Tag the object to update its display data.");
-       parm= RNA_def_pointer(func, "scene", "Scene", "", "");
-       RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
-       RNA_def_boolean(func, "object", 1, "", "Tag the object for updating");
-       RNA_def_boolean(func, "data", 1, "", "Tag the objects display data for updating");
-       RNA_def_boolean(func, "time", 1, "", "Tag the object time related data for updating");
+       /* Nearest Point */
+       func= RNA_def_function(srna, "closest_point_on_mesh", "rna_Object_closest_point_on_mesh");
+       RNA_def_function_ui_description(func, "Find the nearest point on the object");
+       RNA_def_function_flag(func, FUNC_USE_REPORTS);
+
+       /* location of point for test and max distance */
+       parm= RNA_def_float_vector(func, "point", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
+       RNA_def_property_flag(parm, PROP_REQUIRED);
+       /* default is sqrt(FLT_MAX) */
+       RNA_def_float(func, "max_dist", 1.844674352395373e+19, 0.0, FLT_MAX, "", "", 0.0, FLT_MAX);
+
+       /* return location and normal */
+       parm= RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location", "The location on the object closest to the point", -1e4, 1e4);
+       RNA_def_property_flag(parm, PROP_THICK_WRAP);
+       RNA_def_function_output(func, parm);
+       parm= RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal", "The face normal at the closest point", -1e4, 1e4);
+       RNA_def_property_flag(parm, PROP_THICK_WRAP);
+       RNA_def_function_output(func, parm);
+
+       parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no closest point is found", 0, 0);
+       RNA_def_function_output(func, parm);
 
        /* View */
        func= RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
-       RNA_def_function_ui_description(func, "Determine if object is visible in a given scene.");
+       RNA_def_function_ui_description(func, "Determine if object is visible in a given scene");
        parm= RNA_def_pointer(func, "scene", "Scene", "", "");
        RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
-       parm= RNA_def_boolean(func, "is_visible", 0, "", "Object visibility.");
+       parm= RNA_def_boolean(func, "result", 0, "", "Object visibility");
+       RNA_def_function_return(func, parm);
+
+       /* utility function for checking if the object is modified */
+       func= RNA_def_function(srna, "is_modified", "rna_Object_is_modified");
+       RNA_def_function_ui_description(func, "Determine if this object is modified from the base mesh data");
+       parm= RNA_def_pointer(func, "scene", "Scene", "", "");
+       RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
+       parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
+       RNA_def_property_flag(parm, PROP_REQUIRED);
+       parm= RNA_def_boolean(func, "result", 0, "", "Object visibility");
        RNA_def_function_return(func, parm);
 }
 
@@ -488,7 +584,7 @@ void RNA_api_object_base(StructRNA *srna)
        PropertyRNA *parm;
 
        func= RNA_def_function(srna, "layers_from_view", "rna_ObjectBase_layers_from_view");
-       RNA_def_function_ui_description(func, "Sets the object layers from a 3D View (use when adding an object in local view).");
+       RNA_def_function_ui_description(func, "Sets the object layers from a 3D View (use when adding an object in local view)");
        parm= RNA_def_pointer(func, "view", "SpaceView3D", "", "");
        RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
 }