Cr8-xyz/blender
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: use doxy sections for space types

Browse Source 
Also use struct names in enum/define comments.
This commit is contained in:
Campbell Barton
2018-05-31 09:49:58 +02:00
parent d9324b61d5
commit 84a9647f22
1 changed files with 166 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

181
source/blender/makesdna/DNA_space_types.h
View File

@@ -67,8 +67,9 @@ struct MovieClipScopes;
struct Mask;
struct BLI_mempool;
/* SpaceLink (Base) ==================================== */
/* -------------------------------------------------------------------- */
/** \name SpaceLink (Base)
* \{ */
/**
* The base structure all the other spaces
@@ -83,8 +84,9 @@ typedef struct SpaceLink {
short blockhandler[8] DNA_DEPRECATED; /* XXX make deprecated */
} SpaceLink;
/* Space Info ========================================== */
/* -------------------------------------------------------------------- */
/** \name Space Info
* \{ */
/* Info Header */
typedef struct SpaceInfo {
@@ -107,8 +109,11 @@ typedef enum eSpaceInfo_RptMask {
INFO_RPT_ERR = (1 << 4),
} eSpaceInfo_RptMask;
/** \} */
/* Properties Editor ==================================== */
/* -------------------------------------------------------------------- */
/** \name Properties Editor
* \{ */
/* Properties Editor */
typedef struct SpaceButs {
@@ -136,18 +141,18 @@ typedef struct SpaceButs {
} SpaceButs;
/* button defines (deprecated) */
/* warning: the values of these defines are used in sbuts->tabs[8] */
/* sbuts->mainb new */
#ifdef DNA_DEPRECATED_ALLOW
/* warning: the values of these defines are used in SpaceButs.tabs[8] */
/* SpaceButs.mainb new */
#define CONTEXT_SCENE 0
#define CONTEXT_OBJECT 1
#define CONTEXT_TYPES 2
// #define CONTEXT_TYPES 2
#define CONTEXT_SHADING 3
#define CONTEXT_EDITING 4
#define CONTEXT_SCRIPT 5
// #define CONTEXT_SCRIPT 5
#define CONTEXT_LOGIC 6
/* sbuts->mainb old (deprecated) */
#ifdef DNA_DEPRECATED_ALLOW
/* SpaceButs.mainb old (deprecated) */
// #define BUTS_VIEW 0
#define BUTS_LAMP 1
#define BUTS_MAT 2
@@ -163,9 +168,9 @@ typedef struct SpaceButs {
// #define BUTS_SOUND 12
#define BUTS_CONSTRAINT 13
// #define BUTS_EFFECTS 14
#endif
#endif /* DNA_DEPRECATED_ALLOW */
/* buts->mainb new */
/* SpaceButs.mainb new */
typedef enum eSpaceButtons_Context {
BCONTEXT_RENDER = 0,
BCONTEXT_SCENE = 1,
@@ -186,7 +191,7 @@ typedef enum eSpaceButtons_Context {
BCONTEXT_TOT
} eSpaceButtons_Context;
/* sbuts->flag */
/* SpaceButs.flag */
typedef enum eSpaceButtons_Flag {
SB_PRV_OSA = (1 << 0),
SB_PIN_CONTEXT = (1 << 1),
@@ -196,7 +201,7 @@ typedef enum eSpaceButtons_Flag {
SB_SHADING_CONTEXT = (1 << 4),
} eSpaceButtons_Flag;
/* sbuts->texture_context */
/* SpaceButs.texture_context */
typedef enum eSpaceButtons_Texture_Context {
SB_TEXC_MATERIAL = 0,
SB_TEXC_WORLD = 1,
@@ -206,7 +211,7 @@ typedef enum eSpaceButtons_Texture_Context {
SB_TEXC_LINESTYLE = 5,
} eSpaceButtons_Texture_Context;
/* sbuts->align */
/* SpaceButs.align */
typedef enum eSpaceButtons_Align {
BUT_FREE = 0,
BUT_HORIZONTAL = 1,
@@ -214,7 +219,7 @@ typedef enum eSpaceButtons_Align {
BUT_AUTO = 3,
} eSpaceButtons_Align;
/* sbuts->scaflag */
/* SpaceButs.scaflag */
#define BUTS_SENS_SEL 1
#define BUTS_SENS_ACT 2
#define BUTS_SENS_LINK 4
@@ -229,7 +234,11 @@ typedef enum eSpaceButtons_Align {
#define BUTS_CONT_INIT_STATE 2048
/* Outliner =============================================== */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Outliner
* \{ */
/* Outliner */
typedef struct SpaceOops {
@@ -262,7 +271,7 @@ typedef struct SpaceOops {
} SpaceOops;
/* SpaceOops->flag */
/* SpaceOops.flag */
typedef enum eSpaceOutliner_Flag {
SO_TESTBLOCKS = (1 << 0),
SO_NEWSELECTED = (1 << 1),
@@ -271,7 +280,7 @@ typedef enum eSpaceOutliner_Flag {
SO_SKIP_SORT_ALPHA = (1 << 4),
} eSpaceOutliner_Flag;
/* SpaceOops->outlinevis */
/* SpaceOops.outlinevis */
typedef enum eSpaceOutliner_Mode {
SO_ALL_SCENES = 0,
SO_CUR_SCENE = 1,
@@ -290,7 +299,7 @@ typedef enum eSpaceOutliner_Mode {
SO_ID_ORPHANS = 14,
} eSpaceOutliner_Mode;
/* SpaceOops->storeflag */
/* SpaceOops.storeflag */
typedef enum eSpaceOutliner_StoreFlag {
/* cleanup tree */
SO_TREESTORE_CLEANUP = (1 << 0),
@@ -301,15 +310,18 @@ typedef enum eSpaceOutliner_StoreFlag {
SO_TREESTORE_REBUILD = (1 << 2),
} eSpaceOutliner_StoreFlag;
/* outliner search flags (SpaceOops->search_flags) */
/* outliner search flags (SpaceOops.search_flags) */
typedef enum eSpaceOutliner_Search_Flags {
SO_FIND_CASE_SENSITIVE = (1 << 0),
SO_FIND_COMPLETE = (1 << 1),
SO_SEARCH_RECURSIVE = (1 << 2),
} eSpaceOutliner_Search_Flags;
/** \} */
/* Graph Editor ========================================= */
/* -------------------------------------------------------------------- */
/** \name Graph Editor
* \{ */
/* 'Graph' Editor (formerly known as the IPO Editor) */
typedef struct SpaceIpo {
@@ -336,7 +348,7 @@ typedef struct SpaceIpo {
} SpaceIpo;
/* SpaceIpo->flag (Graph Editor Settings) */
/* SpaceIpo.flag (Graph Editor Settings) */
typedef enum eGraphEdit_Flag {
/* OLD DEPRECEATED SETTING */
/* SIPO_LOCK_VIEW = (1 << 0), */
@@ -373,7 +385,7 @@ typedef enum eGraphEdit_Flag {
SIPO_NORMALIZE_FREEZE = (1 << 15),
} eGraphEdit_Flag;
/* SpaceIpo->mode (Graph Editor Mode) */
/* SpaceIpo.mode (Graph Editor Mode) */
typedef enum eGraphEdit_Mode {
/* all animation curves (from all over Blender) */
SIPO_MODE_ANIMATION = 0,
@@ -381,8 +393,11 @@ typedef enum eGraphEdit_Mode {
SIPO_MODE_DRIVERS = 1,
} eGraphEdit_Mode;
/** \} */
/* NLA Editor ============================================= */
/* -------------------------------------------------------------------- */
/** \name NLA Editor
* \{ */
/* NLA Editor */
typedef struct SpaceNla {
@@ -400,7 +415,7 @@ typedef struct SpaceNla {
View2D v2d DNA_DEPRECATED; /* deprecated, copied to region */
} SpaceNla;
/* nla->flag */
/* SpaceNla.flag */
typedef enum eSpaceNla_Flag {
/* flags (1<<0), (1<<1), and (1<<3) are deprecated flags from old verisons */
@@ -416,8 +431,11 @@ typedef enum eSpaceNla_Flag {
SNLA_NOLOCALMARKERS = (1 << 7),
} eSpaceNla_Flag;
/** \} */
/* Timeline =============================================== */
/* -------------------------------------------------------------------- */
/** \name Timeline
* \{ */
/* Pointcache drawing data */
# /* Only store the data array in the cache to avoid constant reallocation. */
@@ -443,7 +461,7 @@ typedef struct SpaceTime {
} SpaceTime;
/* time->flag */
/* SpaceTime.flag */
typedef enum eTimeline_Flag {
/* show timing in frames instead of in seconds */
TIME_DRAWFRAMES = (1 << 0),
@@ -453,7 +471,7 @@ typedef enum eTimeline_Flag {
TIME_ONLYACTSEL = (1 << 2),
} eTimeline_Flag;
/* time->redraws (now screen->redraws_flag) */
/* SpaceTime.redraws (now bScreen.redraws_flag) */
typedef enum eScreen_Redraws_Flag {
TIME_REGION = (1 << 0),
TIME_ALL_3D_WIN = (1 << 1),
@@ -469,7 +487,7 @@ typedef enum eScreen_Redraws_Flag {
TIME_FOLLOW = (1 << 15),
} eScreen_Redraws_Flag;
/* time->cache */
/* SpaceTime.cache */
typedef enum eTimeline_Cache_Flag {
TIME_CACHE_DISPLAY = (1 << 0),
TIME_CACHE_SOFTBODY = (1 << 1),
@@ -480,8 +498,11 @@ typedef enum eTimeline_Cache_Flag {
TIME_CACHE_RIGIDBODY = (1 << 6),
} eTimeline_Cache_Flag;
/** \} */
/* Sequence Editor ======================================= */
/* -------------------------------------------------------------------- */
/** \name Sequence Editor
* \{ */
/* Sequencer */
typedef struct SpaceSeq {
@@ -518,7 +539,7 @@ typedef struct SpaceSeq {
} SpaceSeq;
/* sseq->mainb */
/* SpaceSeq.mainb */
typedef enum eSpaceSeq_RegionType {
SEQ_DRAW_SEQUENCE = 0,
SEQ_DRAW_IMG_IMBUF = 1,
@@ -527,14 +548,14 @@ typedef enum eSpaceSeq_RegionType {
SEQ_DRAW_IMG_HISTOGRAM = 4,
} eSpaceSeq_RegionType;
/* sseq->draw_flag */
/* SpaceSeq.draw_flag */
typedef enum eSpaceSeq_DrawFlag {
SEQ_DRAW_BACKDROP = (1 << 0),
SEQ_DRAW_OFFSET_EXT = (1 << 1),
} eSpaceSeq_DrawFlag;
/* sseq->flag */
/* SpaceSeq.flag */
typedef enum eSpaceSeq_Flag {
SEQ_DRAWFRAMES = (1 << 0),
SEQ_MARKER_TRANS = (1 << 1),
@@ -549,14 +570,14 @@ typedef enum eSpaceSeq_Flag {
SEQ_SHOW_METADATA = (1 << 10),
} eSpaceSeq_Flag;
/* sseq->view */
/* SpaceSeq.view */
typedef enum eSpaceSeq_Displays {
SEQ_VIEW_SEQUENCE = 1,
SEQ_VIEW_PREVIEW = 2,
SEQ_VIEW_SEQUENCE_PREVIEW = 3,
} eSpaceSeq_Dispays;
/* sseq->render_size */
/* SpaceSeq.render_size */
typedef enum eSpaceSeq_Proxy_RenderSize {
SEQ_PROXY_RENDER_SIZE_NONE = -1,
SEQ_PROXY_RENDER_SIZE_SCENE = 0,
@@ -577,14 +598,18 @@ typedef struct MaskSpaceInfo {
char pad3[5];
} MaskSpaceInfo;
/* sseq->mainb */
/* SpaceSeq.mainb */
typedef enum eSpaceSeq_OverlayType {
SEQ_DRAW_OVERLAY_RECT = 0,
SEQ_DRAW_OVERLAY_REFERENCE = 1,
SEQ_DRAW_OVERLAY_CURRENT = 2
} eSpaceSeq_OverlayType;
/* File Selector ========================================== */
/** \} */
/* -------------------------------------------------------------------- */
/** \name File Selector
* \{ */
/* Config and Input for File Selector */
typedef struct FileSelectParams {
@@ -870,7 +895,11 @@ enum {
FILE_ENTRY_INVALID_PREVIEW = 1 << 0, /* The preview for this entry could not be generated. */
};
/* Image/UV Editor ======================================== */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Image/UV Editor
* \{ */
/* Image/UV Editor */
typedef struct SpaceImage {
@@ -911,7 +940,7 @@ typedef struct SpaceImage {
} SpaceImage;
/* SpaceImage->dt_uv */
/* SpaceImage.dt_uv */
typedef enum eSpaceImage_UVDT {
SI_UVDT_OUTLINE = 0,
SI_UVDT_DASH = 1,
@@ -919,20 +948,20 @@ typedef enum eSpaceImage_UVDT {
SI_UVDT_WHITE = 3,
} eSpaceImage_UVDT;
/* SpaceImage->dt_uvstretch */
/* SpaceImage.dt_uvstretch */
typedef enum eSpaceImage_UVDT_Stretch {
SI_UVDT_STRETCH_ANGLE = 0,
SI_UVDT_STRETCH_AREA = 1,
} eSpaceImage_UVDT_Stretch;
/* SpaceImage->mode */
/* SpaceImage.mode */
typedef enum eSpaceImage_Mode {
SI_MODE_VIEW = 0,
SI_MODE_PAINT = 1,
SI_MODE_MASK = 2 /* note: mesh edit mode overrides mask */
} eSpaceImage_Mode;
/* SpaceImage->sticky
/* SpaceImage.sticky
* Note DISABLE should be 0, however would also need to re-arrange icon order,
* also, sticky loc is the default mode so this means we don't need to 'do_versions' */
typedef enum eSpaceImage_Sticky {
@@ -941,7 +970,7 @@ typedef enum eSpaceImage_Sticky {
SI_STICKY_VERTEX = 2,
} eSpaceImage_Sticky;
/* SpaceImage->flag */
/* SpaceImage.flag */
typedef enum eSpaceImage_Flag {
/* SI_BE_SQUARE = (1 << 0), */ /* deprecated */
SI_EDITTILE = (1 << 1), /* XXX - not used but should be? */
@@ -985,13 +1014,17 @@ typedef enum eSpaceImage_Flag {
SI_SHOW_B = (1 << 29),
} eSpaceImage_Flag;
/* SpaceImage->other_uv_filter */
/* SpaceImage.other_uv_filter */
typedef enum eSpaceImage_OtherUVFilter {
SI_FILTER_SAME_IMAGE = 0,
SI_FILTER_ALL = 1,
} eSpaceImage_OtherUVFilter;
/* Text Editor ============================================ */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Text Editor
* \{ */
/* Text Editor */
typedef struct SpaceText {
@@ -1050,10 +1083,14 @@ typedef enum eSpaceText_Flags {
ST_FIND_ACTIVATE = (1 << 9),
} eSpaceText_Flags;
/* stext->findstr/replacestr */
/* SpaceText.findstr/replacestr */
#define ST_MAX_FIND_STR 256
/* Script View (Obsolete) ================================== */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Script View (Obsolete)
* \{ */
/* Script Runtime Data - Obsolete (pre 2.5) */
typedef struct Script {
@@ -1086,9 +1123,11 @@ typedef struct SpaceScript {
void *but_refs;
} SpaceScript;
/* Nodes Editor =========================================== */
/** \} */
/* Node Editor */
/* -------------------------------------------------------------------- */
/** \name Nodes Editor
* \{ */
typedef struct bNodeTreePath {
struct bNodeTreePath *next, *prev;
@@ -1146,7 +1185,7 @@ typedef struct SpaceNode {
struct bGPdata *gpd; /* grease-pencil data */
} SpaceNode;
/* snode->flag */
/* SpaceNode.flag */
typedef enum eSpaceNode_Flag {
SNODE_BACKDRAW = (1 << 1),
SNODE_SHOW_GPENCIL = (1 << 2),
@@ -1163,7 +1202,7 @@ typedef enum eSpaceNode_Flag {
SNODE_SKIP_INSOFFSET = (1 << 13), /* automatically offset following nodes in a chain on insertion */
} eSpaceNode_Flag;
/* snode->texfrom */
/* SpaceNode.texfrom */
typedef enum eSpaceNode_TexFrom {
SNODE_TEX_OBJECT = 0,
SNODE_TEX_WORLD = 1,
@@ -1171,20 +1210,24 @@ typedef enum eSpaceNode_TexFrom {
SNODE_TEX_LINESTYLE = 3,
} eSpaceNode_TexFrom;
/* snode->shaderfrom */
/* SpaceNode.shaderfrom */
typedef enum eSpaceNode_ShaderFrom {
SNODE_SHADER_OBJECT = 0,
SNODE_SHADER_WORLD = 1,
SNODE_SHADER_LINESTYLE = 2,
} eSpaceNode_ShaderFrom;
/* snode->insert_ofs_dir */
/* SpaceNode.insert_ofs_dir */
enum {
SNODE_INSERTOFS_DIR_RIGHT = 0,
SNODE_INSERTOFS_DIR_LEFT = 1,
};
/* Game Logic Editor ===================================== */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Game Logic Editor
* \{ */
/* Logic Editor */
typedef struct SpaceLogic {
@@ -1201,7 +1244,11 @@ typedef struct SpaceLogic {
struct bGPdata *gpd; /* grease-pencil data */
} SpaceLogic;
/* Console ================================================ */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Console
* \{ */
/* Console content */
typedef struct ConsoleLine {
@@ -1245,10 +1292,12 @@ typedef struct SpaceConsole {
int sel_end;
} SpaceConsole;
/** \} */
/* User Preferences ======================================= */
/* -------------------------------------------------------------------- */
/** \name User Preferences
* \{ */
/* User Preferences View */
typedef struct SpaceUserPref {
SpaceLink *next, *prev;
ListBase regionbase; /* storage of regions for inactive spaces */
@@ -1259,7 +1308,11 @@ typedef struct SpaceUserPref {
char filter[64]; /* search term for filtering in the UI */
} SpaceUserPref;
/* Motion Tracking ======================================== */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Motion Tracking
* \{ */
/* Clip Editor */
typedef struct SpaceClip {
@@ -1300,7 +1353,7 @@ typedef struct SpaceClip {
MaskSpaceInfo mask_info;
} SpaceClip;
/* SpaceClip->flag */
/* SpaceClip.flag */
typedef enum eSpaceClip_Flag {
SC_SHOW_MARKER_PATTERN = (1 << 0),
SC_SHOW_MARKER_SEARCH = (1 << 1),
@@ -1327,7 +1380,7 @@ typedef enum eSpaceClip_Flag {
SC_SHOW_METADATA = (1 << 22),
} eSpaceClip_Flag;
/* SpaceClip->mode */
/* SpaceClip.mode */
typedef enum eSpaceClip_Mode {
SC_MODE_TRACKING = 0,
/*SC_MODE_RECONSTRUCTION = 1,*/ /* DEPRECATED */
@@ -1335,14 +1388,14 @@ typedef enum eSpaceClip_Mode {
SC_MODE_MASKEDIT = 3,
} eSpaceClip_Mode;
/* SpaceClip->view */
/* SpaceClip.view */
typedef enum eSpaceClip_View {
SC_VIEW_CLIP = 0,
SC_VIEW_GRAPH = 1,
SC_VIEW_DOPESHEET = 2,
} eSpaceClip_View;
/* SpaceClip->gpencil_src */
/* SpaceClip.gpencil_src */
typedef enum eSpaceClip_GPencil_Source {
SC_GPENCIL_SRC_CLIP = 0,
SC_GPENCIL_SRC_TRACK = 1,