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
This commit is contained in:
Joshua Leung
2012-01-10 23:14:20 +00:00
parent 2ef6163747
commit dbdd09869b

View File

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