[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [43270] trunk/blender/source/blender/ makesdna/DNA_scene_types.h: Commenting and comment fixing

Joshua Leung aligorith at gmail.com
Wed Jan 11 00:14:33 CET 2012


Revision: 43270
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=43270
Author:   aligorith
Date:     2012-01-10 23:14:20 +0000 (Tue, 10 Jan 2012)
Log Message:
-----------
Commenting and comment fixing

* 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

Modified Paths:
--------------
    trunk/blender/source/blender/makesdna/DNA_scene_types.h

Modified: trunk/blender/source/blender/makesdna/DNA_scene_types.h
===================================================================
--- trunk/blender/source/blender/makesdna/DNA_scene_types.h	2012-01-10 22:15:50 UTC (rev 43269)
+++ trunk/blender/source/blender/makesdna/DNA_scene_types.h	2012-01-10 23:14:20 UTC (rev 43270)
@@ -59,6 +59,10 @@
 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 @@
 	struct Object *object;
 } Base;
 
+/* ************************************************************* */
+/* Output Format Data */
+
 typedef struct AviCodecData {
 	void			*lpFormat;  /* save format */
 	void			*lpParms;   /* compressor options */
@@ -142,6 +149,8 @@
 	IDProperty *properties;
 } FFMpegCodecData;
 
+/* ************************************************************* */
+/* Audio */
 
 typedef struct AudioData {
 	int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
@@ -155,6 +164,10 @@
 	float pad2;
 } AudioData;
 
+/* *************************************************************** */
+/* Render Layers */
+
+/* Render Layer */
 typedef struct SceneRenderLayer {
 	struct SceneRenderLayer *next, *prev;
 	
@@ -211,6 +224,7 @@
 
 /* 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 @@
 /* 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 @@
 	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 @@
 	
 } RenderProfile;
 
+/* *************************************************************** */
+/* Game Engine - Dome */
+
 typedef struct GameDome {
 	short res, mode;
 	short angle, tilt;
@@ -527,6 +550,9 @@
 #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 @@
 #define GAME_MAT_MULTITEX	1
 #define GAME_MAT_GLSL		2
 
+/* *************************************************************** */
+/* Markers */
+
 typedef struct TimeMarker {
 	struct TimeMarker *next, *prev;
 	int frame;
@@ -648,6 +677,10 @@
 	struct Object *camera;
 } TimeMarker;
 
+/* *************************************************************** */
+/* Paint Mode/Tool Data */
+
+/* Paint Tool Base */
 typedef struct Paint {
 	struct Brush *brush;
 	
@@ -658,6 +691,10 @@
 	int flags;
 } Paint;
 
+/* ------------------------------------------- */
+/* Image Paint */
+
+/* Texture/Image Editor */
 typedef struct ImagePaintSettings {
 	Paint paint;
 
@@ -672,6 +709,10 @@
 	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 @@
 	float strength;
 } ParticleBrushData;
 
+/* Particle Edit Mode Settings */
 typedef struct ParticleEditSettings {
 	short flag;
 	short totrekey;
@@ -699,12 +741,10 @@
 	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 @@
 	int pad;
 } Sculpt;
 
+/* ------------------------------------------- */
+/* Vertex Paint */
+
+/* Vertex Paint */
 typedef struct VPaint {
 	Paint paint;
 
@@ -755,7 +799,18 @@
 // #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 */
 	VPaint *wpaint;		/* weight paint */
@@ -882,26 +937,40 @@
 	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 @@
 
 	/* 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



More information about the Bf-blender-cvs mailing list