Commenting and comment fixing
authorJoshua Leung <aligorith@gmail.com>
Tue, 10 Jan 2012 23:14:20 +0000 (23:14 +0000)
committerJoshua Leung <aligorith@gmail.com>
Tue, 10 Jan 2012 23:14:20 +0000 (23:14 +0000)
* Fixed incorrect description for scene.keyingsets list
* Added dividers to try and make it clearer what structs were related.
  * Reshuffled TransformOrientation struct since it occurred right in the middle
of all the other Paint-Mode stuff

source/blender/makesdna/DNA_scene_types.h

index 9b49bc53ef3684eed33676eac138eb9819423390..7d611acc5519d4367d5ef08c14ba32b46ed7492f 100644 (file)
@@ -59,6 +59,10 @@ struct SceneStats;
 struct bGPdata;
 struct MovieClip;
 
+/* ************************************************************* */
+/* Scene Data */
+
+/* Base - Wrapper for referencing Objects in a Scene */
 typedef struct Base {
        struct Base *next, *prev;
        unsigned int lay, selcol;
@@ -67,6 +71,9 @@ typedef struct Base {
        struct Object *object;
 } Base;
 
+/* ************************************************************* */
+/* Output Format Data */
+
 typedef struct AviCodecData {
        void                    *lpFormat;  /* save format */
        void                    *lpParms;   /* compressor options */
@@ -142,6 +149,8 @@ typedef struct FFMpegCodecData {
        IDProperty *properties;
 } FFMpegCodecData;
 
+/* ************************************************************* */
+/* Audio */
 
 typedef struct AudioData {
        int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
@@ -155,6 +164,10 @@ typedef struct AudioData {
        float pad2;
 } AudioData;
 
+/* *************************************************************** */
+/* Render Layers */
+
+/* Render Layer */
 typedef struct SceneRenderLayer {
        struct SceneRenderLayer *next, *prev;
        
@@ -211,6 +224,7 @@ typedef struct SceneRenderLayer {
 
 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
 
+/* *************************************************************** */
 
 /* Generic image format settings,
  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
@@ -314,6 +328,9 @@ typedef struct ImageFormatData {
 /* ImageFormatData.cineon_flag */
 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
 
+/* *************************************************************** */
+/* Render Data */
+
 typedef struct RenderData {
        struct ImageFormatData im_format;
        
@@ -499,6 +516,9 @@ typedef struct RenderData {
        char engine[32];
 } RenderData;
 
+/* *************************************************************** */
+/* Render Conversion/Simplfication Settings */
+
 /* control render convert and shading engine */
 typedef struct RenderProfile {
        struct RenderProfile *next, *prev;
@@ -513,6 +533,9 @@ typedef struct RenderProfile {
        
 } RenderProfile;
 
+/* *************************************************************** */
+/* Game Engine - Dome */
+
 typedef struct GameDome {
        short res, mode;
        short angle, tilt;
@@ -527,6 +550,9 @@ typedef struct GameDome {
 #define DOME_PANORAM_SPH               5
 #define DOME_NUM_MODES                 6
 
+/* *************************************************************** */
+/* Game Engine */
+
 typedef struct GameFraming {
        float col[3];
        char type, pad1, pad2, pad3;
@@ -640,6 +666,9 @@ typedef struct GameData {
 #define GAME_MAT_MULTITEX      1
 #define GAME_MAT_GLSL          2
 
+/* *************************************************************** */
+/* Markers */
+
 typedef struct TimeMarker {
        struct TimeMarker *next, *prev;
        int frame;
@@ -648,6 +677,10 @@ typedef struct TimeMarker {
        struct Object *camera;
 } TimeMarker;
 
+/* *************************************************************** */
+/* Paint Mode/Tool Data */
+
+/* Paint Tool Base */
 typedef struct Paint {
        struct Brush *brush;
        
@@ -658,6 +691,10 @@ typedef struct Paint {
        int flags;
 } Paint;
 
+/* ------------------------------------------- */
+/* Image Paint */
+
+/* Texture/Image Editor */
 typedef struct ImagePaintSettings {
        Paint paint;
 
@@ -672,6 +709,10 @@ typedef struct ImagePaintSettings {
        void *paintcursor;                      /* wm handle */
 } ImagePaintSettings;
 
+/* ------------------------------------------- */
+/* Particle Edit */
+
+/* Settings for a Particle Editing Brush */
 typedef struct ParticleBrushData {
        short size;                                             /* common setting */
        short step, invert, count;              /* for specific brushes only */
@@ -679,6 +720,7 @@ typedef struct ParticleBrushData {
        float strength;
 } ParticleBrushData;
 
+/* Particle Edit Mode Settings */
 typedef struct ParticleEditSettings {
        short flag;
        short totrekey;
@@ -699,12 +741,10 @@ typedef struct ParticleEditSettings {
        struct Object *object;
 } ParticleEditSettings;
 
-typedef struct TransformOrientation {
-       struct TransformOrientation *next, *prev;
-       char name[36];
-       float mat[3][3];
-} TransformOrientation;
+/* ------------------------------------------- */
+/* Sculpt */
 
+/* Sculpt */
 typedef struct Sculpt {
        Paint paint;
 
@@ -735,6 +775,10 @@ typedef struct Sculpt {
        int pad;
 } Sculpt;
 
+/* ------------------------------------------- */
+/* Vertex Paint */
+
+/* Vertex Paint */
 typedef struct VPaint {
        Paint paint;
 
@@ -755,6 +799,17 @@ typedef struct VPaint {
 // #define VP_MIRROR_X 32 // deprecated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X)
 #define VP_ONLYVGROUP  128
 
+/* *************************************************************** */
+/* Transform Orientations */
+
+typedef struct TransformOrientation {
+       struct TransformOrientation *next, *prev;
+       char name[36];
+       float mat[3][3];
+} TransformOrientation;
+
+/* *************************************************************** */
+/* Tool Settings */
 
 typedef struct ToolSettings {
        VPaint *vpaint;         /* vertex paint */
@@ -882,26 +937,40 @@ typedef struct ToolSettings {
        float sculpt_paint_unified_alpha; /* unified strength of brush */
 } ToolSettings;
 
+/* *************************************************************** */
+/* Assorted Scene Data */
+
+/* ------------------------------------------- */
+/* Stats (show in Info header) */
+
 typedef struct bStats {
        /* scene totals for visible layers */
        int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
        int totvert, totface;
 } bStats;
 
+/* ------------------------------------------- */
+/* Unit Settings */
+
 typedef struct UnitSettings {
        /* Display/Editing unit options for each scene */
        float scale_length; /* maybe have other unit conversions? */
        char system; /* imperial, metric etc */
        char system_rotation; /* not implimented as a propper unit system yet */
        short flag;
-       
 } UnitSettings;
 
+/* ------------------------------------------- */
+/* Global/Common Physics Settings */
+
 typedef struct PhysicsSettings {
        float gravity[3];
        int flag, quick_cache_step, rt;
 } PhysicsSettings;
 
+/* *************************************************************** */
+/* Scene ID-Block */
+
 typedef struct Scene {
        ID id;
        struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
@@ -959,7 +1028,7 @@ typedef struct Scene {
 
        /* User-Defined KeyingSets */
        int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
-       ListBase keyingsets;                    /* KeyingSets for the given frame */
+       ListBase keyingsets;                    /* KeyingSets for this scene */
        
        /* Game Settings */
        struct GameFraming framing  DNA_DEPRECATED; // XXX  deprecated since 2.5