RNA: correct tips
[blender.git] / source / blender / makesrna / intern / rna_object.c
index c13d2f9b0621c9d530b38fd52221c9d3512dd57d..8255c220592a7184bc8e7f16481125d8ae6bd947 100644 (file)
@@ -46,7 +46,6 @@
 #include "BKE_paint.h"
 #include "BKE_editmesh.h"
 #include "BKE_group.h" /* needed for BKE_group_object_exists() */
-#include "BKE_object.h" /* Needed for BKE_object_matrix_local_get() */
 #include "BKE_object_deform.h"
 
 #include "RNA_access.h"
@@ -88,8 +87,6 @@ EnumPropertyItem object_empty_drawtype_items[] = {
 
 static EnumPropertyItem parent_type_items[] = {
        {PAROBJECT, "OBJECT", 0, "Object", "The object is parented to an object"},
-       {PARCURVE, "CURVE", 0, "Curve", "The object is parented to a curve"},
-       {PARKEY, "KEY", 0, "Key", ""},
        {PARSKEL, "ARMATURE", 0, "Armature", ""},
        {PARSKEL, "LATTICE", 0, "Lattice", "The object is parented to a lattice"}, /* PARSKEL reuse will give issues */
        {PARVERT1, "VERTEX", 0, "Vertex", "The object is parented to a vertex"},
@@ -110,13 +107,13 @@ static EnumPropertyItem dupli_items[] = {
 #endif
 
 static EnumPropertyItem collision_bounds_items[] = {
-       {OB_BOUND_BOX, "BOX", 0, "Box", ""},
-       {OB_BOUND_SPHERE, "SPHERE", 0, "Sphere", ""},
-       {OB_BOUND_CYLINDER, "CYLINDER", 0, "Cylinder", ""},
-       {OB_BOUND_CONE, "CONE", 0, "Cone", ""},
-       {OB_BOUND_CONVEX_HULL, "CONVEX_HULL", 0, "Convex Hull", ""},
-       {OB_BOUND_TRIANGLE_MESH, "TRIANGLE_MESH", 0, "Triangle Mesh", ""},
-       {OB_BOUND_CAPSULE, "CAPSULE", 0, "Capsule", ""},
+       {OB_BOUND_BOX, "BOX", ICON_MESH_CUBE, "Box", ""},
+       {OB_BOUND_SPHERE, "SPHERE", ICON_MESH_UVSPHERE, "Sphere", ""},
+       {OB_BOUND_CYLINDER, "CYLINDER", ICON_MESH_CYLINDER, "Cylinder", ""},
+       {OB_BOUND_CONE, "CONE", ICON_MESH_CONE, "Cone", ""},
+       {OB_BOUND_CONVEX_HULL, "CONVEX_HULL", ICON_MESH_ICOSPHERE, "Convex Hull", ""},
+       {OB_BOUND_TRIANGLE_MESH, "TRIANGLE_MESH", ICON_MESH_MONKEY, "Triangle Mesh", ""},
+       {OB_BOUND_CAPSULE, "CAPSULE", ICON_MESH_CAPSULE, "Capsule", ""},
        /*{OB_DYN_MESH, "DYNAMIC_MESH", 0, "Dynamic Mesh", ""}, */
        {0, NULL, 0, NULL, NULL}
 };
@@ -202,7 +199,6 @@ EnumPropertyItem object_axis_unsigned_items[] = {
 #include "BKE_scene.h"
 #include "BKE_deform.h"
 
-#include "ED_mesh.h"
 #include "ED_object.h"
 #include "ED_particle.h"
 #include "ED_curve.h"
@@ -469,16 +465,13 @@ static EnumPropertyItem *rna_Object_parent_type_itemf(bContext *UNUSED(C), Point
        if (ob->parent) {
                Object *par = ob->parent;
                
-               if (par->type == OB_CURVE) {
-                       RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARCURVE);
-               }
-               else if (par->type == OB_LATTICE) {
+               if (par->type == OB_LATTICE) {
                        /* special hack: prevents this overriding others */
-                       RNA_enum_items_add_value(&item, &totitem, &parent_type_items[4], PARSKEL);
+                       RNA_enum_items_add_value(&item, &totitem, &parent_type_items[2], PARSKEL);
                }
                else if (par->type == OB_ARMATURE) {
                        /* special hack: prevents this being overrided */
-                       RNA_enum_items_add_value(&item, &totitem, &parent_type_items[3], PARSKEL);
+                       RNA_enum_items_add_value(&item, &totitem, &parent_type_items[1], PARSKEL);
                        RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARBONE);
                }
 
@@ -717,7 +710,7 @@ static void rna_Object_active_material_set(PointerRNA *ptr, PointerRNA value)
        Object *ob = (Object *)ptr->id.data;
 
        DAG_id_tag_update(value.data, 0);
-       assign_material(ob, value.data, ob->actcol, BKE_MAT_ASSIGN_USERPREF);
+       assign_material(ob, value.data, ob->actcol, BKE_MAT_ASSIGN_EXISTING);
 }
 
 static int rna_Object_active_material_editable(PointerRNA *ptr)
@@ -889,7 +882,7 @@ static void rna_MaterialSlot_material_set(PointerRNA *ptr, PointerRNA value)
        Object *ob = (Object *)ptr->id.data;
        int index = (Material **)ptr->data - ob->mat;
 
-       assign_material(ob, value.data, index + 1, BKE_MAT_ASSIGN_USERPREF);
+       assign_material(ob, value.data, index + 1, BKE_MAT_ASSIGN_EXISTING);
 }
 
 static int rna_MaterialSlot_link_get(PointerRNA *ptr)
@@ -949,6 +942,7 @@ static void rna_MaterialSlot_update(Main *bmain, Scene *scene, PointerRNA *ptr)
 
        WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, ptr->id.data);
        WM_main_add_notifier(NC_MATERIAL | ND_SHADING_LINKS, NULL);
+       DAG_relations_tag_update(bmain);
 }
 
 static char *rna_MaterialSlot_path(PointerRNA *ptr)
@@ -1009,7 +1003,7 @@ static int rna_GameObjectSettings_physics_type_get(PointerRNA *ptr)
 static void rna_GameObjectSettings_physics_type_set(PointerRNA *ptr, int value)
 {
        Object *ob = (Object *)ptr->id.data;
-       const int was_navmesh = (ob->gameflag & OB_NAVMESH);
+       const int gameflag_prev = ob->gameflag;
        ob->body_type = value;
 
        switch (ob->body_type) {
@@ -1067,7 +1061,7 @@ static void rna_GameObjectSettings_physics_type_set(PointerRNA *ptr, int value)
                        break;
        }
 
-       if (was_navmesh != (ob->gameflag & OB_NAVMESH)) {
+       if ((gameflag_prev & OB_NAVMESH) != (ob->gameflag & OB_NAVMESH)) {
                if (ob->type == OB_MESH) {
                        /* this is needed to refresh the derived meshes draw func */
                        DAG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
@@ -1140,7 +1134,7 @@ static void rna_GameObjectSettings_state_get(PointerRNA *ptr, int *values)
 
        memset(values, 0, sizeof(int) * OB_MAX_STATES);
        for (i = 0; i < OB_MAX_STATES; i++) {
-               values[i] = (ob->state & (1 << i)) | all_states;
+               values[i] = (ob->state & (1 << i)) ? 1 : 0 | all_states;
        }
 }
 
@@ -1387,7 +1381,7 @@ static void rna_Object_boundbox_get(PointerRNA *ptr, float *values)
                memcpy(values, bb->vec, sizeof(bb->vec));
        }
        else {
-               fill_vn_fl(values, sizeof(bb->vec) / sizeof(float), 0.0f);
+               copy_vn_fl(values, sizeof(bb->vec) / sizeof(float), 0.0f);
        }
 
 }
@@ -1686,6 +1680,7 @@ static void rna_def_object_game_settings(BlenderRNA *brna)
        prop = RNA_def_property(srna, "physics_type", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "body_type");
        RNA_def_property_enum_items(prop, body_type_items);
+       RNA_def_property_enum_default(prop, OB_BODY_TYPE_STATIC);
        RNA_def_property_enum_funcs(prop, "rna_GameObjectSettings_physics_type_get",
                                    "rna_GameObjectSettings_physics_type_set", NULL);
        RNA_def_property_ui_text(prop, "Physics Type", "Select the type of physical representation");
@@ -1705,12 +1700,14 @@ static void rna_def_object_game_settings(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "mass", PROP_FLOAT, PROP_NONE);
        RNA_def_property_range(prop, 0.01, 10000.0);
+       RNA_def_property_float_default(prop, 1.0f);
        RNA_def_property_ui_text(prop, "Mass", "Mass of the object");
 
        prop = RNA_def_property(srna, "radius", PROP_FLOAT, PROP_NONE | PROP_UNIT_LENGTH);
        RNA_def_property_float_sdna(prop, NULL, "inertia");
        RNA_def_property_range(prop, 0.01f, FLT_MAX);
        RNA_def_property_ui_range(prop, 0.01f, 10.0f, 1, 3);
+       RNA_def_property_float_default(prop, 1.0f);
        RNA_def_property_ui_text(prop, "Radius", "Radius of bounding sphere and material physics");
        RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
 
@@ -1721,39 +1718,67 @@ static void rna_def_object_game_settings(BlenderRNA *brna)
        prop = RNA_def_property(srna, "damping", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "damping");
        RNA_def_property_range(prop, 0.0, 1.0);
+       RNA_def_property_float_default(prop, 0.04f);
        RNA_def_property_ui_text(prop, "Damping", "General movement damping");
 
        prop = RNA_def_property(srna, "rotation_damping", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "rdamping");
        RNA_def_property_range(prop, 0.0, 1.0);
+       RNA_def_property_float_default(prop, 0.1f);
        RNA_def_property_ui_text(prop, "Rotation Damping", "General rotation damping");
 
-       prop = RNA_def_property(srna, "velocity_min", PROP_FLOAT, PROP_NONE);
+       prop = RNA_def_property(srna, "velocity_min", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "min_vel");
        RNA_def_property_range(prop, 0.0, 1000.0);
-       RNA_def_property_ui_text(prop, "Velocity Min", "Clamp velocity to this minimum speed (except when totally still)");
+       RNA_def_property_ui_text(prop, "Velocity Min", "Clamp velocity to this minimum speed (except when totally still), "
+                                "in distance per second");
 
-       prop = RNA_def_property(srna, "velocity_max", PROP_FLOAT, PROP_NONE);
+       prop = RNA_def_property(srna, "velocity_max", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "max_vel");
        RNA_def_property_range(prop, 0.0, 1000.0);
-       RNA_def_property_ui_text(prop, "Velocity Max", "Clamp velocity to this maximum speed");
+       RNA_def_property_ui_text(prop, "Velocity Max", "Clamp velocity to this maximum speed, "
+                                "in distance per second");
        
+       prop = RNA_def_property(srna, "angular_velocity_min", PROP_FLOAT, PROP_ANGLE);
+       RNA_def_property_float_sdna(prop, NULL, "min_angvel");
+       RNA_def_property_range(prop, 0.0, 1000.0);
+       RNA_def_property_ui_text(prop, "Angular Velocity Min",
+                                "Clamp angular velocity to this minimum speed (except when totally still), "
+                                "in angle per second");
+
+       prop = RNA_def_property(srna, "angular_velocity_max", PROP_FLOAT, PROP_ANGLE);
+       RNA_def_property_float_sdna(prop, NULL, "max_angvel");
+       RNA_def_property_range(prop, 0.0, 1000.0);
+       RNA_def_property_ui_text(prop, "Angular Velocity Max", "Clamp angular velocity to this maximum speed, "
+                                "in angle per second");
+
        /* Character physics */
        prop = RNA_def_property(srna, "step_height", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "step_height");
        RNA_def_property_range(prop, 0.01, 1.0);
+       RNA_def_property_float_default(prop, 0.15f);
        RNA_def_property_ui_text(prop, "Step Height", "Maximum height of steps the character can run over");
 
        prop = RNA_def_property(srna, "jump_speed", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "jump_speed");
        RNA_def_property_range(prop, 0.0, 1000.0);
+       RNA_def_property_float_default(prop, 10.0f);
        RNA_def_property_ui_text(prop, "Jump Force", "Upward velocity applied to the character when jumping");
 
        prop = RNA_def_property(srna, "fall_speed", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "fall_speed");
        RNA_def_property_range(prop, 0.0, 1000.0);
+       RNA_def_property_float_default(prop, 55.0f);
        RNA_def_property_ui_text(prop, "Fall Speed Max", "Maximum speed at which the character will fall");
 
+       prop = RNA_def_property(srna, "max_jumps", PROP_INT, PROP_NONE);
+       RNA_def_property_int_sdna(prop, NULL, "max_jumps");
+       RNA_def_property_range(prop, 1, CHAR_MAX);
+       RNA_def_property_ui_range(prop, 1, 10, 1, 1);
+       RNA_def_property_int_default(prop, 1);
+       RNA_def_property_ui_text(prop, "Max Jumps",
+                                "The maximum number of jumps the character can make before it hits the ground");
+
        /* Collision Masks */
        prop = RNA_def_property(srna, "collision_group", PROP_BOOLEAN, PROP_LAYER_MEMBER);
        RNA_def_property_boolean_sdna(prop, NULL, "col_group", 1);
@@ -1812,6 +1837,7 @@ static void rna_def_object_game_settings(BlenderRNA *brna)
        prop = RNA_def_property(srna, "form_factor", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "formfactor");
        RNA_def_property_range(prop, 0.0, 1.0);
+       RNA_def_property_float_default(prop, 0.4f);
        RNA_def_property_ui_text(prop, "Form Factor", "Form factor scales the inertia tensor");
 
        prop = RNA_def_property(srna, "use_anisotropic_friction", PROP_BOOLEAN, PROP_NONE);
@@ -1844,6 +1870,7 @@ static void rna_def_object_game_settings(BlenderRNA *brna)
        prop = RNA_def_property(srna, "collision_margin", PROP_FLOAT, PROP_NONE | PROP_UNIT_LENGTH);
        RNA_def_property_float_sdna(prop, NULL, "margin");
        RNA_def_property_range(prop, 0.0, 1.0);
+       RNA_def_property_float_default(prop, 0.04f);
        RNA_def_property_ui_text(prop, "Collision Margin",
                                 "Extra margin around object for collision detection, small amount required "
                                 "for stability");
@@ -1859,6 +1886,7 @@ static void rna_def_object_game_settings(BlenderRNA *brna)
        prop = RNA_def_property(srna, "obstacle_radius", PROP_FLOAT, PROP_NONE | PROP_UNIT_LENGTH);
        RNA_def_property_float_sdna(prop, NULL, "obstacleRad");
        RNA_def_property_range(prop, 0.0, 1000.0);
+       RNA_def_property_float_default(prop, 1.0f);
        RNA_def_property_ui_text(prop, "Obstacle Radius", "Radius of object representation in obstacle simulation");
        
        /* state */
@@ -2118,7 +2146,7 @@ static void rna_def_object_lodlevel(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "use_object_hysteresis", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flags", OB_LOD_USE_HYST);
-       RNA_def_property_ui_text(prop, "Hysteresis Override", "Override LoD Hysteresis scene setting for this Lod Level");
+       RNA_def_property_ui_text(prop, "Hysteresis Override", "Override LoD Hysteresis scene setting for this LoD level");
        RNA_def_property_update(prop, NC_OBJECT | ND_LOD, NULL);
 }