diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-03-14 07:16:21 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-03-14 07:39:53 +0300 |
commit | 626b2bd071b334201996081b907e18d9c2dee919 (patch) | |
tree | 04bb52d92a9d25134c6186f4af2c6c78b536b421 /source/blender/blenkernel | |
parent | acab7450784a555bc03e75405178f6423e2aeb5c (diff) |
Cleanup: use doxy sections
Diffstat (limited to 'source/blender/blenkernel')
-rw-r--r-- | source/blender/blenkernel/intern/multires_reshape.h | 80 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/multires_reshape_util.c | 51 |
2 files changed, 82 insertions, 49 deletions
diff --git a/source/blender/blenkernel/intern/multires_reshape.h b/source/blender/blenkernel/intern/multires_reshape.h index 6a51c1112cb..ae14e565ac9 100644 --- a/source/blender/blenkernel/intern/multires_reshape.h +++ b/source/blender/blenkernel/intern/multires_reshape.h @@ -127,9 +127,9 @@ typedef struct ReshapeConstGridElement { float mask; } ReshapeConstGridElement; -/* ================================================================================================ - * Construct/destruct reshape context. - */ +/* -------------------------------------------------------------------- */ +/** \name Construct/destruct reshape context. + * \{ */ /* Create subdivision surface descriptor which is configured for surface evaluation at a given * multires modifier. */ @@ -154,9 +154,11 @@ bool multires_reshape_context_create_from_subdivide(MultiresReshapeContext *resh void multires_reshape_context_free(MultiresReshapeContext *reshape_context); -/* ================================================================================================ - * Helper accessors. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Helper accessors. + * \{ */ /* For the given grid index get index of face it was created for. */ int multires_reshape_grid_to_face_index(const MultiresReshapeContext *reshape_context, @@ -199,9 +201,11 @@ ReshapeGridElement multires_reshape_grid_element_for_ptex_coord( ReshapeConstGridElement multires_reshape_orig_grid_element_for_grid_coord( const MultiresReshapeContext *reshape_context, const GridCoord *grid_coord); -/* ================================================================================================ - * Sample limit surface of the base mesh. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sample limit surface of the base mesh. + * \{ */ /* Evaluate limit surface created from base mesh. * This is the limit surface which defines tangent space for MDisps. */ @@ -210,16 +214,20 @@ void multires_reshape_evaluate_limit_at_grid(const MultiresReshapeContext *resha float r_P[3], float r_tangent_matrix[3][3]); -/* ================================================================================================ - * Custom data preparation. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Custom data preparation. + * \{ */ /* Make sure custom data is allocated for the given level. */ void multires_reshape_ensure_grids(struct Mesh *mesh, const int level); -/* ================================================================================================ - * Functions specific to reshaping from a set of vertices in a object position. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Functions specific to reshaping from a set of vertices in a object position. + * \{ */ /* Returns truth if all coordinates were assigned. * @@ -230,9 +238,11 @@ bool multires_reshape_assign_final_coords_from_vertcos( const float (*vert_coords)[3], const int num_vert_coords); -/* ================================================================================================ - * Functions specific to reshaping from CCG. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Functions specific to reshaping from CCG. + * \{ */ /* NOTE: Displacement grids to be at least at a reshape level. * @@ -240,9 +250,11 @@ bool multires_reshape_assign_final_coords_from_vertcos( bool multires_reshape_assign_final_coords_from_ccg(const MultiresReshapeContext *reshape_context, struct SubdivCCG *subdiv_ccg); -/* ================================================================================================ - * Functions specific to reshaping from MDISPS. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Functions specific to reshaping from MDISPS. + * \{ */ /* Reads and writes to the current mesh CD_MDISPS. */ void multires_reshape_assign_final_coords_from_mdisps( @@ -252,9 +264,11 @@ void multires_reshape_assign_final_coords_from_mdisps( void multires_reshape_assign_final_coords_from_orig_mdisps( const MultiresReshapeContext *reshape_context); -/* ================================================================================================ - * Displacement smooth. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Displacement smooth. + * \{ */ /* Operates on a displacement grids (CD_MDISPS) which contains object space coordinates stopred for * the reshape level. @@ -271,9 +285,11 @@ void multires_reshape_smooth_object_grids_with_details( */ void multires_reshape_smooth_object_grids(const MultiresReshapeContext *reshape_context); -/* ================================================================================================ - * Displacement, space conversion. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Displacement, space conversion. + * \{ */ /* Store original grid data, so then it's possible to calculate delta from it and add * high-frequency content on top of reshaped grids. */ @@ -282,9 +298,11 @@ void multires_reshape_store_original_grids(MultiresReshapeContext *reshape_conte void multires_reshape_object_grids_to_tangent_displacement( const MultiresReshapeContext *reshape_context); -/* ================================================================================================ - * Apply base. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Apply base. + * \{ */ /* Update mesh coordinates to the final positions of displacement in object space. * This is effectively desired position of base mesh vertices after caneling out displacement. @@ -299,4 +317,6 @@ void multires_reshape_apply_base_refit_base_mesh(MultiresReshapeContext *reshape /* Refine subdivision surface to the new positions of the base mesh. */ void multires_reshape_apply_base_refine_subdiv(MultiresReshapeContext *reshape_context); +/** \} */ + #endif /* __BKE_INTERN_MULTIRES_RESHAPE_H__ */ diff --git a/source/blender/blenkernel/intern/multires_reshape_util.c b/source/blender/blenkernel/intern/multires_reshape_util.c index 1ebaf743858..814501996c8 100644 --- a/source/blender/blenkernel/intern/multires_reshape_util.c +++ b/source/blender/blenkernel/intern/multires_reshape_util.c @@ -43,9 +43,9 @@ #include "DEG_depsgraph_query.h" -/* ================================================================================================ - * Construct/destruct reshape context. - */ +/* -------------------------------------------------------------------- */ +/** \name Construct/destruct reshape context. + * \{ */ /* Create subdivision surface descriptor which is configured for surface evaluation at a given * multires modifier. */ @@ -269,9 +269,11 @@ void multires_reshape_context_free(MultiresReshapeContext *reshape_context) MEM_freeN(reshape_context->grid_to_face_index); } -/* ================================================================================================ - * Helper accessors. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Helper accessors. + * \{ */ /* For the given grid index get index of face it was created for. */ int multires_reshape_grid_to_face_index(const MultiresReshapeContext *reshape_context, @@ -446,9 +448,11 @@ ReshapeConstGridElement multires_reshape_orig_grid_element_for_grid_coord( return grid_element; } -/* ================================================================================================ - * Sample limit surface of the base mesh. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sample limit surface of the base mesh. + * \{ */ void multires_reshape_evaluate_limit_at_grid(const MultiresReshapeContext *reshape_context, const GridCoord *grid_coord, @@ -468,9 +472,11 @@ void multires_reshape_evaluate_limit_at_grid(const MultiresReshapeContext *resha reshape_context, face_index, corner, dPdu, dPdv, r_tangent_matrix); } -/* ================================================================================================ - * Custom data preparation. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Custom data preparation. + * \{ */ static void allocate_displacement_grid(MDisps *displacement_grid, const int level) { @@ -532,9 +538,11 @@ void multires_reshape_ensure_grids(Mesh *mesh, const int level) ensure_mask_grids(mesh, level); } -/* ================================================================================================ - * Displacement, space conversion. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Displacement, space conversion. + * \{ */ void multires_reshape_store_original_grids(MultiresReshapeContext *reshape_context) { @@ -671,10 +679,13 @@ void multires_reshape_object_grids_to_tangent_displacement( NULL); } -/* ================================================================================================ - * MDISPS - * - * TODO(sergey): Make foreach_grid_coordinate more accessible and move this functionality to +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name MDISPS. + * \{ */ + +/* TODO(sergey): Make foreach_grid_coordinate more accessible and move this functionality to * own file. */ static void assign_final_coords_from_mdisps(const MultiresReshapeContext *reshape_context, @@ -725,3 +736,5 @@ void multires_reshape_assign_final_coords_from_orig_mdisps( foreach_grid_coordinate( reshape_context, reshape_context->top.level, assign_final_coords_from_orig_mdisps, NULL); } + +/** \} */ |