clone and stencil layer access added, renamed mask to stencil layer internally
[blender.git] / source / blender / makesrna / intern / rna_key.c
index bf328388836c68282a9ec44a68c16202b47d7218..9e560a50af07e1a8c8875afd1f3ee2fa979e4d11 100644 (file)
 
 #ifdef RNA_RUNTIME
 
+#include <stddef.h>
+
+#include "DNA_object_types.h"
+#include "DNA_scene_types.h"
+
+#include "BKE_animsys.h"
+#include "BKE_depsgraph.h"
+#include "BKE_key.h"
+#include "BKE_main.h"
+
+#include "WM_api.h"
+#include "WM_types.h"
+
 static Key *rna_ShapeKey_find_key(ID *id)
 {
        switch(GS(id->name)) {
@@ -48,7 +61,43 @@ static Key *rna_ShapeKey_find_key(ID *id)
        }
 }
 
-static void *rna_ShapeKey_relative_key_get(PointerRNA *ptr)
+void rna_ShapeKey_name_set(PointerRNA *ptr, const char *value)
+{
+       KeyBlock *kb= ptr->data;
+       char oldname[32];
+       
+       /* make a copy of the old name first */
+       BLI_strncpy(oldname, kb->name, sizeof(oldname));
+       
+       /* copy the new name into the name slot */
+       BLI_strncpy(kb->name, value, sizeof(kb->name));
+       
+       /* make sure the name is truly unique */
+       if (ptr->id.data) {
+               Key *key= rna_ShapeKey_find_key(ptr->id.data);
+               BLI_uniquename(&key->block, kb, "Key", '.', offsetof(KeyBlock, name), 32);
+       }
+       
+       /* fix all the animation data which may link to this */
+       BKE_all_animdata_fix_paths_rename("keys", oldname, kb->name);
+}
+
+static void rna_ShapeKey_value_set(PointerRNA *ptr, float value)
+{
+       KeyBlock *data= (KeyBlock*)ptr->data;
+       CLAMP(value, data->slidermin, data->slidermax);
+       data->curval= value;
+}
+
+static void rna_ShapeKey_value_range(PointerRNA *ptr, float *min, float *max)
+{
+       KeyBlock *data= (KeyBlock*)ptr->data;
+
+       *min= data->slidermin;
+       *max= data->slidermax;
+}
+
+static PointerRNA rna_ShapeKey_relative_key_get(PointerRNA *ptr)
 {
        Key *key= rna_ShapeKey_find_key(ptr->id.data);
        KeyBlock *kb= (KeyBlock*)ptr->data, *kbrel;
@@ -57,21 +106,39 @@ static void *rna_ShapeKey_relative_key_get(PointerRNA *ptr)
        if(key && kb->relative < key->totkey)
                for(a=0, kbrel=key->block.first; kbrel; kbrel=kbrel->next, a++)
                        if(a == kb->relative)
-                               return kbrel;
+                               return rna_pointer_inherit_refine(ptr, &RNA_ShapeKey, kbrel);
+
+       return rna_pointer_inherit_refine(ptr, NULL, NULL);
+}
+
+static void rna_ShapeKey_relative_key_set(PointerRNA *ptr, PointerRNA value)
+{
+       Key *key= rna_ShapeKey_find_key(ptr->id.data);
+       KeyBlock *kb= (KeyBlock*)ptr->data, *kbrel;
+       int a;
 
-       return NULL;
+       if(key)
+               for(a=0, kbrel=key->block.first; kbrel; kbrel=kbrel->next, a++)
+                       if(kbrel == value.data)
+                               kb->relative= a;
 }
 
-static float rna_ShapeKeyPoint_co_get(PointerRNA *ptr, int index)
+static void rna_ShapeKeyPoint_co_get(PointerRNA *ptr, float *values)
 {
        float *vec= (float*)ptr->data;
-       return vec[index];
+
+       values[0]= vec[0];
+       values[1]= vec[1];
+       values[2]= vec[2];
 }
 
-static void rna_ShapeKeyPoint_co_set(PointerRNA *ptr, int index, float value)
+static void rna_ShapeKeyPoint_co_set(PointerRNA *ptr, const float *values)
 {
        float *vec= (float*)ptr->data;
-       vec[index]= value;
+
+       vec[0]= values[0];
+       vec[1]= values[1];
+       vec[2]= values[2];
 }
 
 static float rna_ShapeKeyCurvePoint_tilt_get(PointerRNA *ptr)
@@ -86,40 +153,58 @@ static void rna_ShapeKeyCurvePoint_tilt_set(PointerRNA *ptr, float value)
        vec[3]= value;
 }
 
-static float rna_ShapeKeyBezierPoint_co_get(PointerRNA *ptr, int index)
+static void rna_ShapeKeyBezierPoint_co_get(PointerRNA *ptr, float *values)
 {
        float *vec= (float*)ptr->data;
-       return vec[index+3];
+
+       values[0]= vec[0+3];
+       values[1]= vec[1+3];
+       values[2]= vec[2+3];
 }
 
-static void rna_ShapeKeyBezierPoint_co_set(PointerRNA *ptr, int index, float value)
+static void rna_ShapeKeyBezierPoint_co_set(PointerRNA *ptr, const float *values)
 {
        float *vec= (float*)ptr->data;
-       vec[index+3]= value;
+
+       vec[0+3]= values[0];
+       vec[1+3]= values[1];
+       vec[2+3]= values[2];
 }
 
-static float rna_ShapeKeyBezierPoint_handle_1_co_get(PointerRNA *ptr, int index)
+static void rna_ShapeKeyBezierPoint_handle_1_co_get(PointerRNA *ptr, float *values)
 {
        float *vec= (float*)ptr->data;
-       return vec[index];
+
+       values[0]= vec[0];
+       values[1]= vec[1];
+       values[2]= vec[2];
 }
 
-static void rna_ShapeKeyBezierPoint_handle_1_co_set(PointerRNA *ptr, int index, float value)
+static void rna_ShapeKeyBezierPoint_handle_1_co_set(PointerRNA *ptr, const float *values)
 {
        float *vec= (float*)ptr->data;
-       vec[index]= value;
+
+       vec[0]= values[0];
+       vec[1]= values[1];
+       vec[2]= values[2];
 }
 
-static float rna_ShapeKeyBezierPoint_handle_2_co_get(PointerRNA *ptr, int index)
+static void rna_ShapeKeyBezierPoint_handle_2_co_get(PointerRNA *ptr, float *values)
 {
        float *vec= (float*)ptr->data;
-       return vec[6+index];
+
+       values[0]= vec[6+0];
+       values[1]= vec[6+1];
+       values[2]= vec[6+2];
 }
 
-static void rna_ShapeKeyBezierPoint_handle_2_co_set(PointerRNA *ptr, int index, float value)
+static void rna_ShapeKeyBezierPoint_handle_2_co_set(PointerRNA *ptr, const float *values)
 {
        float *vec= (float*)ptr->data;
-       vec[6+index]= value;
+
+       vec[6+0]= values[0];
+       vec[6+1]= values[1];
+       vec[6+2]= values[2];
 }
 
 /*static float rna_ShapeKeyBezierPoint_tilt_get(PointerRNA *ptr)
@@ -152,7 +237,7 @@ static void rna_ShapeKey_data_begin(CollectionPropertyIterator *iter, PointerRNA
                }
        }
 
-       rna_iterator_array_begin(iter, (void*)kb->data, size, tot, NULL);
+       rna_iterator_array_begin(iter, (void*)kb->data, size, tot, 0, NULL);
 }
 
 static int rna_ShapeKey_data_length(PointerRNA *ptr)
@@ -174,9 +259,10 @@ static int rna_ShapeKey_data_length(PointerRNA *ptr)
        return tot;
 }
 
-static StructRNA *rna_ShapeKey_data_type(CollectionPropertyIterator *iter)
+static PointerRNA rna_ShapeKey_data_get(CollectionPropertyIterator *iter)
 {
        Key *key= rna_ShapeKey_find_key(iter->parent.id.data);
+       StructRNA *type;
        Curve *cu;
        Nurb *nu;
 
@@ -185,12 +271,32 @@ static StructRNA *rna_ShapeKey_data_type(CollectionPropertyIterator *iter)
                nu= cu->nurb.first;
 
                if(nu->bezt)
-                       return &RNA_ShapeKeyBezierPoint;
+                       type= &RNA_ShapeKeyBezierPoint;
                else
-                       return &RNA_ShapeKeyCurvePoint;
+                       type= &RNA_ShapeKeyCurvePoint;
        }
        else
-               return &RNA_ShapeKeyPoint;
+               type= &RNA_ShapeKeyPoint;
+       
+       return rna_pointer_inherit_refine(&iter->parent, type, rna_iterator_array_get(iter));
+}
+
+static char *rna_ShapeKey_path(PointerRNA *ptr)
+{
+       return BLI_sprintfN("keys[\"%s\"]", ((KeyBlock*)ptr->data)->name);
+}
+
+static void rna_Key_update_data(Main *bmain, Scene *scene, PointerRNA *ptr)
+{
+       Key *key= ptr->id.data;
+       Object *ob;
+
+       for(ob=bmain->object.first; ob; ob= ob->id.next) {
+               if(ob_get_key(ob) == key) {
+                       DAG_id_flush_update(&ob->id, OB_RECALC_DATA);
+                       WM_main_add_notifier(NC_OBJECT|ND_MODIFIER, ob);
+               }
+       }
 }
 
 #else
@@ -201,47 +307,54 @@ static void rna_def_keydata(BlenderRNA *brna)
        PropertyRNA *prop;
 
        srna= RNA_def_struct(brna, "ShapeKeyPoint", NULL);
-       RNA_def_struct_ui_text(srna, "Shape Key Point", "DOC_BROKEN");
+       RNA_def_struct_ui_text(srna, "Shape Key Point", "Point in a shape key.");
 
-       prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
+       prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
        RNA_def_property_array(prop, 3);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyPoint_co_get", "rna_ShapeKeyPoint_co_set", NULL);
        RNA_def_property_ui_text(prop, "Location", "");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        srna= RNA_def_struct(brna, "ShapeKeyCurvePoint", NULL);
-       RNA_def_struct_ui_text(srna, "Shape Key Curve Point", "DOC_BROKEN");
+       RNA_def_struct_ui_text(srna, "Shape Key Curve Point", "Point in a shape key for curves.");
 
-       prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
+       prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
        RNA_def_property_array(prop, 3);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyPoint_co_get", "rna_ShapeKeyPoint_co_set", NULL);
        RNA_def_property_ui_text(prop, "Location", "");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        prop= RNA_def_property(srna, "tilt", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyCurvePoint_tilt_get", "rna_ShapeKeyCurvePoint_tilt_set", NULL);
        RNA_def_property_ui_text(prop, "Tilt", "");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        srna= RNA_def_struct(brna, "ShapeKeyBezierPoint", NULL);
-       RNA_def_struct_ui_text(srna, "Shape Key Bezier Point", "DOC_BROKEN");
+       RNA_def_struct_ui_text(srna, "Shape Key Bezier Point", "Point in a shape key for bezier curves.");
 
-       prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
+       prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_TRANSLATION);
        RNA_def_property_array(prop, 3);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_co_get", "rna_ShapeKeyBezierPoint_co_set", NULL);
        RNA_def_property_ui_text(prop, "Location", "");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
-       prop= RNA_def_property(srna, "handle_1_co", PROP_FLOAT, PROP_VECTOR);
+       prop= RNA_def_property(srna, "handle_1_co", PROP_FLOAT, PROP_TRANSLATION);
        RNA_def_property_array(prop, 3);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_handle_1_co_get", "rna_ShapeKeyBezierPoint_handle_1_co_set", NULL);
        RNA_def_property_ui_text(prop, "Handle 1 Location", "");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
-       prop= RNA_def_property(srna, "handle_2_co", PROP_FLOAT, PROP_VECTOR);
+       prop= RNA_def_property(srna, "handle_2_co", PROP_FLOAT, PROP_TRANSLATION);
        RNA_def_property_array(prop, 3);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_handle_2_co_get", "rna_ShapeKeyBezierPoint_handle_2_co_set", NULL);
        RNA_def_property_ui_text(prop, "Handle 2 Location", "");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        /* appears to be unused currently
        prop= RNA_def_property(srna, "tilt", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyBezierPoint_tilt_get", "rna_ShapeKeyBezierPoint_tilt_set", NULL);
-       RNA_def_property_ui_text(prop, "Tilt", "");*/
+       RNA_def_property_ui_text(prop, "Tilt", "");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data"); */
 }
 
 static void rna_def_keyblock(BlenderRNA *brna)
@@ -250,50 +363,60 @@ static void rna_def_keyblock(BlenderRNA *brna)
        PropertyRNA *prop;
 
        static EnumPropertyItem prop_keyblock_type_items[] = {
-               {KEY_LINEAR, "KEY_LINEAR", "Linear", ""},
-               {KEY_CARDINAL, "KEY_CARDINAL", "Cardinal", ""},
-               {KEY_BSPLINE, "KEY_BSPLINE", "BSpline", ""},
-               {0, NULL, NULL, NULL}};
+               {KEY_LINEAR, "KEY_LINEAR", 0, "Linear", ""},
+               {KEY_CARDINAL, "KEY_CARDINAL", 0, "Cardinal", ""},
+               {KEY_BSPLINE, "KEY_BSPLINE", 0, "BSpline", ""},
+               {0, NULL, 0, NULL, NULL}};
 
        srna= RNA_def_struct(brna, "ShapeKey", NULL);
-       RNA_def_struct_ui_text(srna, "Shape Key", "DOC_BROKEN");
+       RNA_def_struct_ui_text(srna, "Shape Key", "Shape key in a shape keys datablock.");
        RNA_def_struct_sdna(srna, "KeyBlock");
+       RNA_def_struct_path_func(srna, "rna_ShapeKey_path");
+       RNA_def_struct_ui_icon(srna, ICON_SHAPEKEY_DATA);
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
        RNA_def_property_ui_text(prop, "Name", "");
+       RNA_def_property_string_funcs(prop, NULL, NULL, "rna_ShapeKey_name_set");
        RNA_def_struct_name_property(srna, prop);
 
        /* keys need to be sorted to edit this */
-       prop= RNA_def_property(srna, "frame", PROP_FLOAT, PROP_NONE);
-       RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+       prop= RNA_def_property(srna, "frame", PROP_FLOAT, PROP_TIME);
+       RNA_def_property_clear_flag(prop, PROP_EDITABLE);
        RNA_def_property_float_sdna(prop, NULL, "pos");
        RNA_def_property_ui_text(prop, "Frame", "Frame for absolute keys.");
-
-       /* the current value isn't easily editable this way, it's linked to an IPO.
-        * these seem to be mostly the values that are being written to, not edited */
-       prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
-       RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
+       
+       /* for now, this is editable directly, as users can set this even if they're not animating them (to test results) */
+       prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_FACTOR);
        RNA_def_property_float_sdna(prop, NULL, "curval");
+       RNA_def_property_float_funcs(prop, NULL, "rna_ShapeKey_value_set", "rna_ShapeKey_value_range");
+       RNA_def_property_ui_range(prop, -10.0f, 10.0f, 10, 3);
        RNA_def_property_ui_text(prop, "Value", "Value of shape key at the current frame.");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        prop= RNA_def_property(srna, "interpolation", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "type");
        RNA_def_property_enum_items(prop, prop_keyblock_type_items);
        RNA_def_property_ui_text(prop, "Interpolation", "Interpolation type.");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        prop= RNA_def_property(srna, "vertex_group", PROP_STRING, PROP_NONE);
        RNA_def_property_string_sdna(prop, NULL, "vgroup");
        RNA_def_property_ui_text(prop, "Vertex Group", "Vertex weight group, to blend with basis shape.");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        prop= RNA_def_property(srna, "relative_key", PROP_POINTER, PROP_NONE);
-       RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
        RNA_def_property_struct_type(prop, "ShapeKey");
+       RNA_def_property_flag(prop, PROP_EDITABLE);
+       RNA_def_property_pointer_funcs(prop, "rna_ShapeKey_relative_key_get", "rna_ShapeKey_relative_key_set", NULL);
        RNA_def_property_ui_text(prop, "Relative Key", "Shape used as a relative key.");
-       RNA_def_property_pointer_funcs(prop, "rna_ShapeKey_relative_key_get", NULL, NULL);
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        prop= RNA_def_property(srna, "mute", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYBLOCK_MUTE);
        RNA_def_property_ui_text(prop, "Mute", "Mute this shape key.");
+       RNA_def_property_ui_icon(prop, ICON_MUTE_IPO_OFF, 1);
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        prop= RNA_def_property(srna, "slider_min", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "slidermin");
@@ -303,12 +426,14 @@ static void rna_def_keyblock(BlenderRNA *brna)
        prop= RNA_def_property(srna, "slider_max", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "slidermax");
        RNA_def_property_range(prop, -10.0f, 10.0f);
+       RNA_def_property_float_default(prop, 1.0f);
        RNA_def_property_ui_text(prop, "Slider Max", "Maximum for slider.");
 
        prop= RNA_def_property(srna, "data", PROP_COLLECTION, PROP_NONE);
        RNA_def_property_collection_sdna(prop, NULL, "data", "totelem");
+       RNA_def_property_struct_type(prop, "UnknownType");
        RNA_def_property_ui_text(prop, "Data", "");
-       RNA_def_property_collection_funcs(prop, "rna_ShapeKey_data_begin", 0, 0, 0, "rna_ShapeKey_data_type", "rna_ShapeKey_data_length", 0, 0);
+       RNA_def_property_collection_funcs(prop, "rna_ShapeKey_data_begin", 0, 0, "rna_ShapeKey_data_get", "rna_ShapeKey_data_length", 0, 0);
 }
 
 static void rna_def_key(BlenderRNA *brna)
@@ -317,32 +442,37 @@ static void rna_def_key(BlenderRNA *brna)
        PropertyRNA *prop;
 
        srna= RNA_def_struct(brna, "Key", "ID");
-       RNA_def_struct_ui_text(srna, "Key", "DOC_BROKEN");
+       RNA_def_struct_ui_text(srna, "Key", "Shape keys datablock containing different shapes of geometric datablocks.");
+       RNA_def_struct_ui_icon(srna, ICON_SHAPEKEY_DATA);
 
        prop= RNA_def_property(srna, "reference_key", PROP_POINTER, PROP_NONE);
-       RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+       RNA_def_property_flag(prop, PROP_NEVER_NULL);
+       RNA_def_property_clear_flag(prop, PROP_EDITABLE);
        RNA_def_property_pointer_sdna(prop, NULL, "refkey");
        RNA_def_property_ui_text(prop, "Reference Key", "");
 
-       prop= RNA_def_property(srna, "shape_keys", PROP_COLLECTION, PROP_NONE);
+       prop= RNA_def_property(srna, "keys", PROP_COLLECTION, PROP_NONE);
        RNA_def_property_collection_sdna(prop, NULL, "block", NULL);
        RNA_def_property_struct_type(prop, "ShapeKey");
-       RNA_def_property_ui_text(prop, "Shape Keys", "");
+       RNA_def_property_ui_text(prop, "Keys", "Shape keys.");
 
-       rna_def_ipo_common(srna);
+       rna_def_animdata_common(srna);
 
        prop= RNA_def_property(srna, "user", PROP_POINTER, PROP_NONE);
+       RNA_def_property_flag(prop, PROP_NEVER_NULL);
        RNA_def_property_pointer_sdna(prop, NULL, "from");
        RNA_def_property_ui_text(prop, "User", "Datablock using these shape keys.");
 
        prop= RNA_def_property(srna, "relative", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "type", KEY_RELATIVE);
        RNA_def_property_ui_text(prop, "Relative", "Makes shape keys relative.");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 
        prop= RNA_def_property(srna, "slurph", PROP_INT, PROP_UNSIGNED);
        RNA_def_property_int_sdna(prop, NULL, "slurph");
        RNA_def_property_range(prop, -500, 500);
        RNA_def_property_ui_text(prop, "Slurph", "Creates a delay in amount of frames in applying keypositions, first vertex goes first.");
+       RNA_def_property_update(prop, 0, "rna_Key_update_data");
 }
 
 void RNA_def_key(BlenderRNA *brna)