diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-01-07 14:19:13 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-01-07 16:43:00 +0300 |
commit | 5a43406e1bad973a8cb32702b4fdb588068a6dcd (patch) | |
tree | b47ac75f429b586950dab5300669c373023efab8 /source/blender/makesdna/DNA_view3d_types.h | |
parent | 0215caeac2ad013fa03e2799049f5358d951ebfa (diff) |
Cleanup: move DNA comments before struct members
Needed for clang-format in some cases, see: T53211
Diffstat (limited to 'source/blender/makesdna/DNA_view3d_types.h')
-rw-r--r-- | source/blender/makesdna/DNA_view3d_types.h | 137 |
1 files changed, 89 insertions, 48 deletions
diff --git a/source/blender/makesdna/DNA_view3d_types.h b/source/blender/makesdna/DNA_view3d_types.h index 72c9be2c12c..0b474e9066f 100644 --- a/source/blender/makesdna/DNA_view3d_types.h +++ b/source/blender/makesdna/DNA_view3d_types.h @@ -64,65 +64,88 @@ struct GPUViewport; typedef struct RegionView3D { - float winmat[4][4]; /* GL_PROJECTION matrix */ - float viewmat[4][4]; /* GL_MODELVIEW matrix */ - float viewinv[4][4]; /* inverse of viewmat */ - float persmat[4][4]; /* viewmat*winmat */ - float persinv[4][4]; /* inverse of persmat */ - float viewcamtexcofac[4]; /* offset/scale for camera glsl texcoords */ - - /* viewmat/persmat multiplied with object matrix, while drawing and selection */ + /** GL_PROJECTION matrix. */ + float winmat[4][4]; + /** GL_MODELVIEW matrix. */ + float viewmat[4][4]; + /** Inverse of viewmat. */ + float viewinv[4][4]; + /** Viewmat*winmat. */ + float persmat[4][4]; + /** Inverse of persmat. */ + float persinv[4][4]; + /** Offset/scale for camera glsl texcoords. */ + float viewcamtexcofac[4]; + + /** viewmat/persmat multiplied with object matrix, while drawing and selection. */ float viewmatob[4][4]; float persmatob[4][4]; - /* user defined clipping planes */ + /** User defined clipping planes. */ float clip[6][4]; - float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */ + /** Clip in object space, means we can test for clipping in editmode without first going into worldspace. */ + float clip_local[6][4]; struct BoundBox *clipbb; - struct RegionView3D *localvd; /* allocated backup of its self while in localview */ + /** Allocated backup of its self while in localview. */ + struct RegionView3D *localvd; struct RenderEngine *render_engine; struct ViewDepths *depths; void *gpuoffscreen; - /* animated smooth view */ + /** Animated smooth view. */ struct SmoothView3DStore *sms; struct wmTimer *smooth_timer; - /* transform gizmo matrix */ + /** Transform gizmo matrix. */ float twmat[4][4]; - /* min/max dot product on twmat xyz axis. */ + /** min/max dot product on twmat xyz axis. */ float tw_axis_min[3], tw_axis_max[3]; float tw_axis_matrix[3][3]; float gridview DNA_DEPRECATED; - float viewquat[4]; /* view rotation, must be kept normalized */ - float dist; /* distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs' */ - float camdx, camdy; /* camera view offsets, 1.0 = viewplane moves entire width/height */ - float pixsize; /* runtime only */ - float ofs[3]; /* view center & orbit pivot, negative of worldspace location, - * also matches -viewinv[3][0:3] in ortho mode.*/ - float camzoom; /* viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac */ - char is_persp; /* check if persp/ortho view, since 'persp' cant be used for this since - * it can have cameras assigned as well. (only set in view3d_winmatrix_set) */ + /** View rotation, must be kept normalized. */ + float viewquat[4]; + /** Distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs'. */ + float dist; + /** Camera view offsets, 1.0 = viewplane moves entire width/height. */ + float camdx, camdy; + /** Runtime only. */ + float pixsize; + /** + * View center & orbit pivot, negative of worldspace location, + * also matches -viewinv[3][0:3] in ortho mode. + */ + float ofs[3]; + /** Viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac. */ + float camzoom; + /** + * Check if persp/ortho view, since 'persp' cant be used for this since + * it can have cameras assigned as well. (only set in #view3d_winmatrix_set) + */ + char is_persp; char persp; char view; char viewlock; - char viewlock_quad; /* options for quadview (store while out of quad view) */ + /** Options for quadview (store while out of quad view). */ + char viewlock_quad; char pad[3]; - float ofs_lock[2]; /* normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right */ + /** Normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right. */ + float ofs_lock[2]; - short twdrawflag; /* XXX can easily get rid of this (Julian) */ + /** XXX can easily get rid of this (Julian). */ + short twdrawflag; short rflag; - /* last view (use when switching out of camera view) */ + /** Last view (use when switching out of camera view). */ float lviewquat[4]; - short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */ + /** Lpersp can never be set to 'RV3D_CAMOB'. */ + short lpersp, lview; - /* active rotation from NDOF or elsewhere */ + /** Active rotation from NDOF or elsewhere. */ float rot_angle; float rot_axis[3]; } RegionView3D; @@ -135,8 +158,10 @@ typedef struct View3DCursor { /* 3D Viewport Shading settings */ typedef struct View3DShading { - char type; /* Shading type (VIEW3D_SHADE_SOLID, ..) */ - char prev_type; /* Runtime, for toggle between rendered viewport. */ + /** Shading type (VIEW3D_SHADE_SOLID, ..). */ + char type; + /** Runtime, for toggle between rendered viewport. */ + char prev_type; char prev_type_wire; char color_type; @@ -147,9 +172,12 @@ typedef struct View3DShading { char cavity_type; char pad[7]; - char studio_light[256]; /* FILE_MAXFILE */ - char lookdev_light[256]; /* FILE_MAXFILE */ - char matcap[256]; /* FILE_MAXFILE */ + /** FILE_MAXFILE. */ + char studio_light[256]; + /** FILE_MAXFILE. */ + char lookdev_light[256]; + /** FILE_MAXFILE. */ + char matcap[256]; float shadow_intensity; float single_color[3]; @@ -209,7 +237,8 @@ typedef struct View3DOverlay { /* 3D ViewPort Struct */ typedef struct View3D { struct SpaceLink *next, *prev; - ListBase regionbase; /* storage of regions for inactive spaces */ + /** Storage of regions for inactive spaces. */ + ListBase regionbase; char spacetype; char link_flag; char _pad0[6]; @@ -218,12 +247,16 @@ typedef struct View3D { float viewquat[4] DNA_DEPRECATED; float dist DNA_DEPRECATED; - float bundle_size; /* size of bundles in reconstructed data */ - char bundle_drawtype; /* display style for bundle */ + /** Size of bundles in reconstructed data. */ + float bundle_size; + /** Display style for bundle. */ + char bundle_drawtype; char pad[3]; - unsigned int lay_prev DNA_DEPRECATED; /* for active layer toggle */ - unsigned int lay_used DNA_DEPRECATED; /* used while drawing */ + /** For active layer toggle. */ + unsigned int lay_prev DNA_DEPRECATED; + /** Used while drawing. */ + unsigned int lay_used DNA_DEPRECATED; int object_type_exclude_viewport; int object_type_exclude_select; @@ -234,15 +267,18 @@ typedef struct View3D { struct Object *camera, *ob_centre; rctf render_border; - struct View3D *localvd; /* allocated backup of its self while in localview */ + /** Allocated backup of its self while in localview. */ + struct View3D *localvd; - char ob_centre_bone[64]; /* optional string for armature bone to define center, MAXBONENAME */ + /** Optional string for armature bone to define center, MAXBONENAME. */ + char ob_centre_bone[64]; unsigned short local_view_uuid; short _pad6; int layact DNA_DEPRECATED; - short ob_centre_cursor; /* optional bool for 3d cursor to define center */ + /** Optional bool for 3d cursor to define center. */ + short ob_centre_cursor; short scenelock; short gp_flag; short flag; @@ -250,14 +286,16 @@ typedef struct View3D { float lens, grid; float near, far; - float ofs[3] DNA_DEPRECATED; /* XXX deprecated */ + float ofs[3] DNA_DEPRECATED; char _pad[4]; - short matcap_icon; /* icon id */ + /** Icon id. */ + short matcap_icon; short gridlines; - short gridsubdiv; /* Number of subdivisions in the grid between each highlighted grid line */ + /** Number of subdivisions in the grid between each highlighted grid line. */ + short gridsubdiv; char gridflag; /* transform gizmo info */ @@ -269,7 +307,8 @@ typedef struct View3D { char _pad3; char transp, xray; - char multiview_eye; /* multiview current eye - for internal use */ + /** Multiview current eye - for internal use. */ + char multiview_eye; /* actually only used to define the opacity of the grease pencil vertex in edit mode */ float vertex_opacity; @@ -278,10 +317,12 @@ typedef struct View3D { * instead set (temporarily) from camera */ struct GPUFXSettings fx_settings; - void *properties_storage; /* Nkey panel stores stuff here (runtime only!) */ + /** Nkey panel stores stuff here (runtime only!). */ + void *properties_storage; /* XXX deprecated? */ - struct bGPdata *gpd DNA_DEPRECATED; /* Grease-Pencil Data (annotation layers) */ + /** Grease-Pencil Data (annotation layers). */ + struct bGPdata *gpd DNA_DEPRECATED; /* Stereoscopy settings */ short stereo3d_flag; |