* Added notifiers for camera rna
authorMatt Ebb <matt@mke3.net>
Mon, 5 Jan 2009 05:42:48 +0000 (05:42 +0000)
committerMatt Ebb <matt@mke3.net>
Mon, 5 Jan 2009 05:42:48 +0000 (05:42 +0000)
* Some tweaks to rna property descriptions

source/blender/makesrna/intern/rna_camera.c
source/blender/makesrna/intern/rna_color.c
source/blender/makesrna/intern/rna_curve.c
source/blender/makesrna/intern/rna_lamp.c

index 62de3914ee573c41760c196b6a0e5bc853d3556f..41b8872a6d1c4124f4b1d1123a95bb06e18f583a 100644 (file)
@@ -31,6 +31,8 @@
 
 #include "DNA_camera_types.h"
 
+#include "WM_types.h"
+
 #ifdef RNA_RUNTIME
 
 #else
@@ -61,73 +63,88 @@ void RNA_def_camera(BlenderRNA *brna)
        prop= RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
        RNA_def_property_range(prop, 0.0f, 1.0f);
-       RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the passepartout area in Camera view.");
+       RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "angle");
        RNA_def_property_range(prop, 0.0f, 100.0f);
-       RNA_def_property_ui_text(prop, "Angle", "Perspective Camera lens value in degrees.");
+       RNA_def_property_ui_text(prop, "Angle", "Perspective Camera lend field of view in degrees.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "clipsta");
        RNA_def_property_range(prop, 0.0f, 100.0f);
-       RNA_def_property_ui_text(prop, "Clip Start", "Camera clipping start.");
+       RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "clipend");
        RNA_def_property_range(prop, 1.0f, 5000.0f);
-       RNA_def_property_ui_text(prop, "Clip End", "Camera clipping end.");
+       RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "lens", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "lens");
        RNA_def_property_range(prop, 1.0f, 250.0f);
        RNA_def_property_ui_text(prop, "Lens", "Perspective Camera lens value in mm.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
        RNA_def_property_range(prop, 0.01f, 1000.0f);
-       RNA_def_property_ui_text(prop, "Orthographic Scale", "Ortographic Camera scale.");
+       RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom).");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "drawsize");
        RNA_def_property_range(prop, 0.1f, 10.0f);
        RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "shiftx");
        RNA_def_property_range(prop, -2.0f, 2.0f);
        RNA_def_property_ui_text(prop, "Shift X", "Perspective Camera horizontal shift.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "shifty");
        RNA_def_property_range(prop, -2.0f, 2.0f);
        RNA_def_property_ui_text(prop, "Shift Y", "Perspective Camera vertical shift.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
        RNA_def_property_range(prop, 0.0f, 5000.0f);
-       RNA_def_property_ui_text(prop, "DOF Distance", "Depth of field distance.");
+       RNA_def_property_ui_text(prop, "DOF Distance", "Distance to the focus point for depth of field.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        /* flag */
        prop= RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
-       RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focal point in Camera view.");
+       RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focus point on the camera.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
        RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
-       RNA_def_property_ui_text(prop, "Show Passepartout", "Enable passepartout mode in Camera view.");
+       RNA_def_property_ui_text(prop, "Show Passepartout", "Show a darkened overlay outside the image area in Camera view.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "show_title_safe", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWTITLESAFE);
-       RNA_def_property_ui_text(prop, "Show Title Safe", "Draw a title safe zone in Camera view.");
+       RNA_def_property_ui_text(prop, "Show Title Safe", "Show indicators for the title safe zone in Camera view.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
-       RNA_def_property_ui_text(prop, "Show Name", "Draw the active Camera's name in Camera view.");
+       RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 
        prop= RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
@@ -141,6 +158,7 @@ void RNA_def_camera(BlenderRNA *brna)
        RNA_def_property_struct_type(prop, "Object");
        RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
        RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define the depth of field focal point.");
+       RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
 }
 
 #endif
index 83c6da5d7e2c86efdf187ff33b253770a6fb3f96..e38264548cd83d81bb2a4e2ad1787bd3255ae36c 100644 (file)
@@ -130,17 +130,17 @@ static void rna_def_curvemappoint(BlenderRNA *brna)
        RNA_def_property_float_sdna(prop, NULL, "x");
        RNA_def_property_array(prop, 2);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
-       RNA_def_property_ui_text(prop, "Location", "");
+       RNA_def_property_ui_text(prop, "Location", "X/Y coordinates of the curve point.");
 
        prop= RNA_def_property(srna, "handle_type", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
        RNA_def_property_enum_items(prop, prop_handle_type_items);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
-       RNA_def_property_ui_text(prop, "Handle Type", "");
+       RNA_def_property_ui_text(prop, "Handle Type", "Curve interpolation at this point: bezier or vector.");
 
        prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_SELECT);
-       RNA_def_property_ui_text(prop, "Selected", "");
+       RNA_def_property_ui_text(prop, "Selected", "Selection state of the curve point.");
 }
 
 static void rna_def_curvemap(BlenderRNA *brna)
@@ -162,7 +162,7 @@ static void rna_def_curvemap(BlenderRNA *brna)
        RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
        RNA_def_property_enum_items(prop, prop_extend_items);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
-       RNA_def_property_ui_text(prop, "Extend", "");
+       RNA_def_property_ui_text(prop, "Extend", "Extrapolate the curve or extend it horizontally.");
 
        prop= RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
        RNA_def_property_collection_sdna(prop, NULL, "curve", "totpoint");
@@ -180,7 +180,7 @@ static void rna_def_curvemapping(BlenderRNA *brna)
        
        prop= RNA_def_property(srna, "clip", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_DO_CLIP);
-       RNA_def_property_ui_text(prop, "Clip", "");
+       RNA_def_property_ui_text(prop, "Clip", "Force the curve view to fit a defined boundary");
        RNA_def_property_boolean_funcs(prop, NULL, "rna_CurveMapping_clip_set");
 
        prop= RNA_def_property(srna, "clip_min_x", PROP_FLOAT, PROP_NONE);
@@ -214,12 +214,12 @@ static void rna_def_curvemapping(BlenderRNA *brna)
 
        prop= RNA_def_property(srna, "black_level", PROP_FLOAT, PROP_COLOR);
        RNA_def_property_float_sdna(prop, NULL, "black");
-       RNA_def_property_ui_text(prop, "Black Level", "");
+       RNA_def_property_ui_text(prop, "Black Level", "For RGB curves, the colour that black is mapped to");
        RNA_def_property_float_funcs(prop, NULL, "rna_CurveMapping_black_level_set", NULL);
 
        prop= RNA_def_property(srna, "white_level", PROP_FLOAT, PROP_COLOR);
        RNA_def_property_float_sdna(prop, NULL, "white");
-       RNA_def_property_ui_text(prop, "White Level", "");
+       RNA_def_property_ui_text(prop, "White Level", "For RGB curves, the colour that white is mapped to");
        RNA_def_property_float_funcs(prop, NULL, "rna_CurveMapping_white_level_set", NULL);
 }
 
index 0a3ac54f612d7b1a8e11ab6bfb0954b6b556018f..0d8df10f2a09c889946e9b0d9422fea67f04b2d6 100644 (file)
@@ -296,7 +296,7 @@ void rna_def_textbox(BlenderRNA *brna)
        PropertyRNA *prop;
        
        srna= RNA_def_struct(brna, "TextBox", NULL);
-       RNA_def_struct_ui_text(srna, "Text Box", "DOC_BROKEN");
+       RNA_def_struct_ui_text(srna, "Text Box", "Bounding box for text layout");
        
        /* number values */
        prop= RNA_def_property(srna, "x", PROP_FLOAT, PROP_NONE);
index 373175e9da89200b9d4852ad555b562f36b6243e..2f1ad00bf36c41df36ce077497b6b2e8ba23e1c5 100644 (file)
@@ -88,7 +88,7 @@ static void rna_def_lamp_sunsky_settings(BlenderRNA *brna)
                
        prop= RNA_def_property(srna, "sky_colorspace", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_items(prop, prop_skycolorspace_items);
-       RNA_def_property_ui_text(prop, "Sky Color Space", "");
+       RNA_def_property_ui_text(prop, "Sky Color Space", "Color space to use for internal XYZ->RGB color conversion");
        RNA_def_property_update(prop, NC_LAMP|ND_SKY, NULL);
 
        prop= RNA_def_property(srna, "sky_blend_type", PROP_ENUM, PROP_NONE);
@@ -178,11 +178,11 @@ void rna_def_lamp(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        static EnumPropertyItem prop_type_items[] = {
-               {LA_LOCAL, "OMNI", "Omni", ""},
-               {LA_SUN, "SUN", "Sun", ""},
-               {LA_SPOT, "SPOT", "Spot", ""},
-               {LA_HEMI, "HEMI", "Hemi", ""},
-               {LA_AREA, "AREA", "Area", ""},
+               {LA_LOCAL, "OMNI", "Omni", "Light cast evenly in all directions from a point source"},
+               {LA_SUN, "SUN", "Sun", "Light cast in a single direction from a distant source"},
+               {LA_SPOT, "SPOT", "Spot", "Light cast in a cone shape from a point"},
+               {LA_HEMI, "HEMI", "Hemi", "Light cast from a hemispherical direction"},
+               {LA_AREA, "AREA", "Area", "Light case from an area surface"},
                {0, NULL, NULL, NULL}};
        static EnumPropertyItem prop_shadow_items[] = {
                {0, "NOSHADOW", "No Shadow", ""},
@@ -272,7 +272,7 @@ void rna_def_lamp(BlenderRNA *brna)
        prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "dist");
        RNA_def_property_range(prop, 0.0f, 9999.0f);
-       RNA_def_property_ui_text(prop, "Distance", "Distance that the lamp emits light.");
+       RNA_def_property_ui_text(prop, "Distance", "Falloff distance - the light is at half the original intensity at this point.");
        RNA_def_property_update(prop, NC_LAMP|ND_LIGHTING_DRAW, NULL);
 
        prop= RNA_def_property(srna, "linear_attenuation", PROP_FLOAT, PROP_NONE);
@@ -290,7 +290,7 @@ void rna_def_lamp(BlenderRNA *brna)
        prop= RNA_def_property(srna, "spot_blend", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "spotblend");
        RNA_def_property_range(prop, 0.0f ,1.0f);
-       RNA_def_property_ui_text(prop, "Spot Blend", "The softeness of the spotlight edge.");
+       RNA_def_property_ui_text(prop, "Spot Blend", "The softness of the spotlight edge.");
        RNA_def_property_update(prop, NC_LAMP|ND_LIGHTING_DRAW, NULL);
 
        prop= RNA_def_property(srna, "spot_size", PROP_FLOAT, PROP_NONE);
@@ -361,14 +361,14 @@ void rna_def_lamp(BlenderRNA *brna)
        prop= RNA_def_property(srna, "buffer_size", PROP_INT, PROP_NONE);
        RNA_def_property_int_sdna(prop, NULL, "bufsize");
        RNA_def_property_range(prop, 512, 10240);
-       RNA_def_property_ui_text(prop, "Buffer Size", "Sets the size of the shadow buffer to nearest multiple of 16");
+       RNA_def_property_ui_text(prop, "Buffer Size", "Resolution of the buffer, higher values give crisper shadows but use more memory");
        RNA_def_property_int_funcs(prop, NULL, "rna_Lamp_buffer_size_set", NULL);
        RNA_def_property_update(prop, NC_LAMP|ND_LIGHTING, NULL);
 
        prop= RNA_def_property(srna, "halo_intensity", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "haint");
        RNA_def_property_range(prop, 0.0f, 5.0f);
-       RNA_def_property_ui_text(prop, "Halo Intensity", "Intensity of Spot Halo");
+       RNA_def_property_ui_text(prop, "Halo Intensity", "Brightness of the spotlight's halo cone.");
        RNA_def_property_update(prop, NC_LAMP|ND_LIGHTING, NULL);
 
        /*short sky_colorspace, pad4;*/