Heard that multi-bone selection would be better used for painting multiple bones...
[blender-staging.git] / source / blender / makesrna / intern / rna_scene.c
index e06e71d6a0e2c16f9162ed9f966c26ead6d7fba0..3f9710a58527105d34af9a61b3b70b3bda6fc916 100644 (file)
@@ -67,13 +67,13 @@ EnumPropertyItem snap_target_items[] = {
        {0, NULL, 0, NULL, NULL}};
        
 EnumPropertyItem proportional_falloff_items[] ={
-       {PROP_SMOOTH, "SMOOTH", ICON_SMOOTHCURVE, "Smooth", ""},
-       {PROP_SPHERE, "SPHERE", ICON_SPHERECURVE, "Sphere", ""},
-       {PROP_ROOT, "ROOT", ICON_ROOTCURVE, "Root", ""},
-       {PROP_SHARP, "SHARP", ICON_SHARPCURVE, "Sharp", ""},
-       {PROP_LIN, "LINEAR", ICON_LINCURVE, "Linear", ""},
-       {PROP_CONST, "CONSTANT", ICON_NOCURVE, "Constant", ""},
-       {PROP_RANDOM, "RANDOM", ICON_RNDCURVE, "Random", ""},
+       {PROP_SMOOTH, "SMOOTH", ICON_SMOOTHCURVE, "Smooth", "Smooth falloff"},
+       {PROP_SPHERE, "SPHERE", ICON_SPHERECURVE, "Sphere", "Spherical falloff"},
+       {PROP_ROOT, "ROOT", ICON_ROOTCURVE, "Root", "Root falloff"},
+       {PROP_SHARP, "SHARP", ICON_SHARPCURVE, "Sharp", "Sharp falloff"},
+       {PROP_LIN, "LINEAR", ICON_LINCURVE, "Linear", "Linear falloff"},
+       {PROP_CONST, "CONSTANT", ICON_NOCURVE, "Constant", "Consant falloff"},
+       {PROP_RANDOM, "RANDOM", ICON_RNDCURVE, "Random", "Random falloff"},
        {0, NULL, 0, NULL, NULL}};
 
 
@@ -100,52 +100,54 @@ EnumPropertyItem snap_element_items[] = {
 
 EnumPropertyItem image_type_items[] = {
        {0, "", 0, "Image", NULL},
-       {R_BMP, "BMP", ICON_FILE_IMAGE, "BMP", ""},
-       //{R_DDS, "DDS", ICON_FILE_IMAGE, "DDS", ""}, // XXX not yet implemented
-       {R_IRIS, "IRIS", ICON_FILE_IMAGE, "Iris", ""},
-       {R_PNG, "PNG", ICON_FILE_IMAGE, "PNG", ""},
-       {R_JPEG90, "JPEG", ICON_FILE_IMAGE, "JPEG", ""},
+       {R_BMP, "BMP", ICON_FILE_IMAGE, "BMP", "Output image in bitmap format"},
+#ifdef WITH_DDS
+       {R_DDS, "DDS", ICON_FILE_IMAGE, "DDS", "Output image in DDS format"},
+#endif
+       {R_IRIS, "IRIS", ICON_FILE_IMAGE, "Iris", "Output image in (old!) SGI IRIS format"},
+       {R_PNG, "PNG", ICON_FILE_IMAGE, "PNG", "Output image in PNG format"},
+       {R_JPEG90, "JPEG", ICON_FILE_IMAGE, "JPEG", "Output image in JPEG format"},
 #ifdef WITH_OPENJPEG
-       {R_JP2, "JPEG2000", ICON_FILE_IMAGE, "JPEG 2000", ""},
+       {R_JP2, "JPEG2000", ICON_FILE_IMAGE, "JPEG 2000", "Output image in JPEG 2000 format"},
 #endif
-       {R_TARGA, "TARGA", ICON_FILE_IMAGE, "Targa", ""},
-       {R_RAWTGA, "TARGA_RAW", ICON_FILE_IMAGE, "Targa Raw", ""},
+       {R_TARGA, "TARGA", ICON_FILE_IMAGE, "Targa", "Output image in Targa format"},
+       {R_RAWTGA, "TARGA_RAW", ICON_FILE_IMAGE, "Targa Raw", "Output image in uncompressed Targa format"},
        {0, "", 0, " ", NULL},
 #ifdef WITH_CINEON
-       {R_CINEON, "CINEON", ICON_FILE_IMAGE, "Cineon", ""},
-       {R_DPX, "DPX",ICON_FILE_IMAGE, "DPX", ""},
+       {R_CINEON, "CINEON", ICON_FILE_IMAGE, "Cineon", "Output image in Cineon format"},
+       {R_DPX, "DPX",ICON_FILE_IMAGE, "DPX", "Output image in DPX format"},
 #endif
 #ifdef WITH_OPENEXR
-       {R_MULTILAYER, "MULTILAYER", ICON_FILE_IMAGE, "MultiLayer", ""},
-       {R_OPENEXR, "OPEN_EXR", ICON_FILE_IMAGE, "OpenEXR", ""},
+       {R_MULTILAYER, "MULTILAYER", ICON_FILE_IMAGE, "MultiLayer", "Output image in multilayer OpenEXR format"},
+       {R_OPENEXR, "OPEN_EXR", ICON_FILE_IMAGE, "OpenEXR", "Output image in OpenEXR format"},
 #endif
 #ifdef WITH_HDR
-       {R_RADHDR, "HDR", ICON_FILE_IMAGE, "Radiance HDR", ""},
+       {R_RADHDR, "HDR", ICON_FILE_IMAGE, "Radiance HDR", "Output image in Radiance HDR format"},
 #endif
 #ifdef WITH_TIFF
-       {R_TIFF, "TIFF", ICON_FILE_IMAGE, "TIFF", ""},
+       {R_TIFF, "TIFF", ICON_FILE_IMAGE, "TIFF", "Output image in TIFF format"},
 #endif
        {0, "", 0, "Movie", NULL},
 #ifdef _WIN32
-       {R_AVICODEC, "AVICODEC", ICON_FILE_MOVIE, "AVI Codec", ""}, // XXX Missing codec menu
+       {R_AVICODEC, "AVICODEC", ICON_FILE_MOVIE, "AVI Codec", "Output video in AVI format"}, // XXX Missing codec menu
 #endif
-       {R_AVIJPEG, "AVI_JPEG", ICON_FILE_MOVIE, "AVI JPEG", ""},
-       {R_AVIRAW, "AVI_RAW", ICON_FILE_MOVIE, "AVI Raw", ""},
-       {R_FRAMESERVER, "FRAMESERVER", ICON_FILE_SCRIPT, "Frame Server", ""},
+       {R_AVIJPEG, "AVI_JPEG", ICON_FILE_MOVIE, "AVI JPEG", "Output video in AVI JPEG format"},
+       {R_AVIRAW, "AVI_RAW", ICON_FILE_MOVIE, "AVI Raw", "Output video in AVI Raw format"},
+       {R_FRAMESERVER, "FRAMESERVER", ICON_FILE_SCRIPT, "Frame Server", "Output image to a frameserver"},
 #ifdef WITH_FFMPEG
-       {R_H264, "H264", ICON_FILE_MOVIE, "H.264", ""},
-       {R_FFMPEG, "FFMPEG", ICON_FILE_MOVIE, "MPEG", ""},
-       {R_THEORA, "THEORA", ICON_FILE_MOVIE, "Ogg Theora", ""},
+       {R_H264, "H264", ICON_FILE_MOVIE, "H.264", "Output video in H.264 format"},
+       {R_FFMPEG, "FFMPEG", ICON_FILE_MOVIE, "MPEG", "Output video in MPEG format"},
+       {R_THEORA, "THEORA", ICON_FILE_MOVIE, "Ogg Theora", "Output video in Ogg format"},
 #endif
 #ifdef WITH_QUICKTIME
 #      ifdef USE_QTKIT
-       {R_QUICKTIME, "QUICKTIME_QTKIT", ICON_FILE_MOVIE, "QuickTime", ""},
+       {R_QUICKTIME, "QUICKTIME_QTKIT", ICON_FILE_MOVIE, "QuickTime", "Output video in Quicktime format"},
 #      else
-       {R_QUICKTIME, "QUICKTIME_CARBON", ICON_FILE_MOVIE, "QuickTime", ""},
+       {R_QUICKTIME, "QUICKTIME_CARBON", ICON_FILE_MOVIE, "QuickTime", "Output video in Quicktime format"},
 #      endif
 #endif
 #ifdef WITH_FFMPEG
-       {R_XVID, "XVID", ICON_FILE_MOVIE, "Xvid", ""},
+       {R_XVID, "XVID", ICON_FILE_MOVIE, "Xvid", "Output video in Xvid format"},
 #endif
        {0, NULL, 0, NULL, NULL}};
 
@@ -1085,6 +1087,12 @@ static void rna_def_tool_settings(BlenderRNA  *brna)
                "Ensure all bone-deforming vertex groups add up to 1.0 while "
                 "weight painting");
 
+       prop = RNA_def_property(srna, "use_multipaint", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "multipaint", 1);
+       RNA_def_property_ui_text(prop, "WPaint Multi-Paint", 
+               "Paint across all selected bones while "
+                "weight painting");
+
        prop= RNA_def_property(srna, "vertex_paint", PROP_POINTER, PROP_NONE);
        RNA_def_property_pointer_sdna(prop, NULL, "vpaint");
        RNA_def_property_ui_text(prop, "Vertex Paint", "");
@@ -1326,7 +1334,7 @@ static void rna_def_unit_settings(BlenderRNA  *brna)
                {0, NULL, 0, NULL, NULL}};
        
        static EnumPropertyItem rotation_units[] = {
-               {0, "DEGREES", 0, "Degrees", ""},
+               {0, "DEGREES", 0, "Degrees", "Use degrees for measuring rotation"},
                {USER_UNIT_ROT_RADIANS, "RADIANS", 0, "Radians", ""},
                {0, NULL, 0, NULL, NULL}};
 
@@ -1657,12 +1665,12 @@ static void rna_def_scene_game_data(BlenderRNA *brna)
                {0, NULL, 0, NULL, NULL}};
 
        static EnumPropertyItem physics_engine_items[] = {
-               {WOPHY_NONE, "NONE", 0, "None", ""},
+               {WOPHY_NONE, "NONE", 0, "None", "Don't use a physics engine"},
                //{WOPHY_ENJI, "ENJI", 0, "Enji", ""},
                //{WOPHY_SUMO, "SUMO", 0, "Sumo (Deprecated)", ""},
                //{WOPHY_DYNAMO, "DYNAMO", 0, "Dynamo", ""},
                //{WOPHY_ODE, "ODE", 0, "ODE", ""},
-               {WOPHY_BULLET, "BULLET", 0, "Bullet", ""},
+               {WOPHY_BULLET, "BULLET", 0, "Bullet", "Use the Bullet physics engine"},
                {0, NULL, 0, NULL, NULL}};
 
        static EnumPropertyItem material_items[] ={
@@ -1786,7 +1794,8 @@ static void rna_def_scene_game_data(BlenderRNA *brna)
 
        prop= RNA_def_property(srna, "physics_gravity", PROP_FLOAT, PROP_ACCELERATION);
        RNA_def_property_float_sdna(prop, NULL, "gravity");
-       RNA_def_property_range(prop, 0.0, 25.0);
+       RNA_def_property_ui_range(prop, 0.0, 25.0, 1, 2);
+       RNA_def_property_range(prop, 0.0, 10000.0);
        RNA_def_property_ui_text(prop, "Physics Gravity", "Gravitational constant used for physics simulation in the game engine");
        RNA_def_property_update(prop, NC_SCENE, NULL);
 
@@ -1966,13 +1975,13 @@ static void rna_def_scene_render_data(BlenderRNA *brna)
        PropertyRNA *prop;
        
        static EnumPropertyItem pixel_filter_items[] ={
-               {R_FILTER_BOX, "BOX", 0, "Box", ""},
-               {R_FILTER_TENT, "TENT", 0, "Tent", ""},
-               {R_FILTER_QUAD, "QUADRATIC", 0, "Quadratic", ""},
-               {R_FILTER_CUBIC, "CUBIC", 0, "Cubic", ""},
-               {R_FILTER_CATROM, "CATMULLROM", 0, "Catmull-Rom", ""},
-               {R_FILTER_GAUSS, "GAUSSIAN", 0, "Gaussian", ""},
-               {R_FILTER_MITCH, "MITCHELL", 0, "Mitchell-Netravali", ""},
+               {R_FILTER_BOX, "BOX", 0, "Box", "Use a box filter for anti-aliasing"},
+               {R_FILTER_TENT, "TENT", 0, "Tent", "Use a tent filter for anti-aliasing"},
+               {R_FILTER_QUAD, "QUADRATIC", 0, "Quadratic", "Use a quadratic filter for anti-aliasing"},
+               {R_FILTER_CUBIC, "CUBIC", 0, "Cubic", "Use a cubic filter for anti-aliasing"},
+               {R_FILTER_CATROM, "CATMULLROM", 0, "Catmull-Rom", "Use a Catmull-Rom filter for anti-aliasing"},
+               {R_FILTER_GAUSS, "GAUSSIAN", 0, "Gaussian", "Use a Gaussian filter for anti-aliasing"},
+               {R_FILTER_MITCH, "MITCHELL", 0, "Mitchell-Netravali", "Use a Mitchell-Netravali filter for anti-aliasing"},
                {0, NULL, 0, NULL, NULL}};
                
        static EnumPropertyItem alpha_mode_items[] ={
@@ -1996,19 +2005,25 @@ static void rna_def_scene_render_data(BlenderRNA *brna)
        
        /* Bake */
        static EnumPropertyItem bake_mode_items[] ={
-               {RE_BAKE_ALL, "FULL", 0, "Full Render", ""},
-               {RE_BAKE_AO, "AO", 0, "Ambient Occlusion", ""},
-               {RE_BAKE_SHADOW, "SHADOW", 0, "Shadow", ""},
-               {RE_BAKE_NORMALS, "NORMALS", 0, "Normals", ""},
-               {RE_BAKE_TEXTURE, "TEXTURE", 0, "Textures", ""},
-               {RE_BAKE_DISPLACEMENT, "DISPLACEMENT", 0, "Displacement", ""},
+               {RE_BAKE_ALL, "FULL", 0, "Full Render", "Bake everything"},
+               {RE_BAKE_AO, "AO", 0, "Ambient Occlusion", "Bake ambient occlusion"},
+               {RE_BAKE_SHADOW, "SHADOW", 0, "Shadow", "Bake shadows"},
+               {RE_BAKE_NORMALS, "NORMALS", 0, "Normals", "Bake normals"},
+               {RE_BAKE_TEXTURE, "TEXTURE", 0, "Textures", "Bake textures"},
+               {RE_BAKE_DISPLACEMENT, "DISPLACEMENT", 0, "Displacement", "Bake displacement"},
+               {RE_BAKE_EMIT, "EMIT", 0, "Emission", "Bake Emit values (glow)"},
+               {RE_BAKE_ALPHA, "ALPHA", 0, "Alpha", "Bake Alpha values (transparency)"},
+               {RE_BAKE_MIRROR_INTENSITY, "MIRROR_INTENSITY", 0, "Mirror Intensity", "Bake Mirror values"},
+               {RE_BAKE_MIRROR_COLOR, "MIRROR_COLOR", 0, "Mirror Colors", "Bake Mirror colors"},
+               {RE_BAKE_SPEC_INTENSITY, "SPEC_INTENSITY", 0, "Specular Intensity", "Bake Specular values"},
+               {RE_BAKE_SPEC_COLOR, "SPEC_COLOR", 0, "Specular Colors", "Bake Specular colors"},
                {0, NULL, 0, NULL, NULL}};
 
        static EnumPropertyItem bake_normal_space_items[] ={
-               {R_BAKE_SPACE_CAMERA, "CAMERA", 0, "Camera", ""},
-               {R_BAKE_SPACE_WORLD, "WORLD", 0, "World", ""},
-               {R_BAKE_SPACE_OBJECT, "OBJECT", 0, "Object", ""},
-               {R_BAKE_SPACE_TANGENT, "TANGENT", 0, "Tangent", ""},
+               {R_BAKE_SPACE_CAMERA, "CAMERA", 0, "Camera", "Bake the normals in camera space"},
+               {R_BAKE_SPACE_WORLD, "WORLD", 0, "World", "Bake the normals in world space"},
+               {R_BAKE_SPACE_OBJECT, "OBJECT", 0, "Object", "Bake the normals in object space"},
+               {R_BAKE_SPACE_TANGENT, "TANGENT", 0, "Tangent", "Bake the normals in tangent space"},
                {0, NULL, 0, NULL, NULL}};
 
        static EnumPropertyItem bake_qyad_split_items[] ={
@@ -2025,12 +2040,12 @@ static void rna_def_scene_render_data(BlenderRNA *brna)
                {0, NULL, 0, NULL, NULL}};
 
        static EnumPropertyItem raytrace_structure_items[] = {
-               {R_RAYSTRUCTURE_AUTO, "AUTO", 0, "Auto", ""},
+               {R_RAYSTRUCTURE_AUTO, "AUTO", 0, "Auto", "Automatically select acceleration structure"},
                {R_RAYSTRUCTURE_OCTREE, "OCTREE", 0, "Octree", "Use old Octree structure"},
                {R_RAYSTRUCTURE_BLIBVH, "BLIBVH", 0, "BLI BVH", "Use BLI K-Dop BVH.c"},
-               {R_RAYSTRUCTURE_VBVH, "VBVH", 0, "vBVH", ""},
-               {R_RAYSTRUCTURE_SIMD_SVBVH, "SIMD_SVBVH", 0, "SIMD SVBVH", ""},
-               {R_RAYSTRUCTURE_SIMD_QBVH, "SIMD_QBVH", 0, "SIMD QBVH", ""},
+               {R_RAYSTRUCTURE_VBVH, "VBVH", 0, "vBVH", "Use vBVH"},
+               {R_RAYSTRUCTURE_SIMD_SVBVH, "SIMD_SVBVH", 0, "SIMD SVBVH", "Use SIMD SVBVH"},
+               {R_RAYSTRUCTURE_SIMD_QBVH, "SIMD_QBVH", 0, "SIMD QBVH", "Use SIMD QBVH"},
                {0, NULL, 0, NULL, NULL}
                };
 
@@ -2159,7 +2174,7 @@ static void rna_def_scene_render_data(BlenderRNA *brna)
 #endif
 
        static EnumPropertyItem engine_items[] = {
-               {0, "BLENDER_RENDER", 0, "Blender Render", ""},
+               {0, "BLENDER_RENDER", 0, "Blender Render", "Use the Blender internal rendering engine for rendering"},
                {0, NULL, 0, NULL, NULL}};
 
        srna= RNA_def_struct(brna, "RenderSettings", NULL);
@@ -2600,7 +2615,7 @@ static void rna_def_scene_render_data(BlenderRNA *brna)
        prop= RNA_def_property(srna, "edge_color", PROP_FLOAT, PROP_COLOR);
        RNA_def_property_float_sdna(prop, NULL, "edgeR");
        RNA_def_property_array(prop, 3);
-       RNA_def_property_ui_text(prop, "Edge Color", "");
+       RNA_def_property_ui_text(prop, "Edge Color", "Edge color");
        RNA_def_property_update(prop, NC_SCENE|ND_RENDER_OPTIONS, NULL);
        
        /* threads */
@@ -3219,10 +3234,15 @@ void RNA_def_scene(BlenderRNA *brna)
        RNA_def_property_int_sdna(prop, NULL, "r.cfra");
        RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
        RNA_def_property_int_funcs(prop, NULL, "rna_Scene_current_frame_set", NULL);
-       RNA_def_property_ui_text(prop, "Current Frame", "");
+       RNA_def_property_ui_text(prop, "Current Frame", "Current Frame");
        RNA_def_property_flag(prop, PROP_CONTEXT_UPDATE);
        RNA_def_property_update(prop, NC_SCENE|ND_FRAME, "rna_Scene_frame_update");
        
+       prop= RNA_def_property(srna, "frame_subframe", PROP_FLOAT, PROP_TIME);
+       RNA_def_property_float_sdna(prop, NULL, "r.subframe");
+       RNA_def_property_ui_text(prop, "Current Sub-Frame", "");
+       RNA_def_property_clear_flag(prop, PROP_ANIMATABLE|PROP_EDITABLE);
+       
        prop= RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
        RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
        RNA_def_property_int_sdna(prop, NULL, "r.sfra");