diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:19:15 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:38:48 +0300 |
commit | ffc4c126f5416b04a01653e7a03451797b98aba4 (patch) | |
tree | ac63d70d33aae5ab1666c9c2f62058c9c1eebd5c /source/blender/blenkernel/intern/shrinkwrap.c | |
parent | f159d49f56cedccd509ee93f5a5fb51f4f39eeb8 (diff) |
Cleanup: move public doc-strings into headers for 'blenkernel'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenkernel/intern/shrinkwrap.c')
-rw-r--r-- | source/blender/blenkernel/intern/shrinkwrap.c | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/source/blender/blenkernel/intern/shrinkwrap.c b/source/blender/blenkernel/intern/shrinkwrap.c index dd863f1ce06..00a80d6e74f 100644 --- a/source/blender/blenkernel/intern/shrinkwrap.c +++ b/source/blender/blenkernel/intern/shrinkwrap.c @@ -101,7 +101,6 @@ typedef struct ShrinkwrapCalcCBData { SpaceTransform *local2aux; } ShrinkwrapCalcCBData; -/* Checks if the modifier needs target normals with these settings. */ bool BKE_shrinkwrap_needs_normals(int shrinkType, int shrinkMode) { return (shrinkType == MOD_SHRINKWRAP_TARGET_PROJECT) || @@ -109,7 +108,6 @@ bool BKE_shrinkwrap_needs_normals(int shrinkType, int shrinkMode) shrinkMode == MOD_SHRINKWRAP_ABOVE_SURFACE); } -/* Initializes the mesh data structure from the given mesh and settings. */ bool BKE_shrinkwrap_init_tree( ShrinkwrapTreeData *data, Mesh *mesh, int shrinkType, int shrinkMode, bool force_normals) { @@ -160,13 +158,11 @@ bool BKE_shrinkwrap_init_tree( return true; } -/* Frees the tree data if necessary. */ void BKE_shrinkwrap_free_tree(ShrinkwrapTreeData *data) { free_bvhtree_from_mesh(&data->treeData); } -/* Free boundary data for target project */ void BKE_shrinkwrap_discard_boundary_data(struct Mesh *mesh) { struct ShrinkwrapBoundaryData *data = mesh->runtime.shrinkwrap_data; @@ -434,14 +430,6 @@ static void shrinkwrap_calc_nearest_vertex(ShrinkwrapCalcData *calc) 0, calc->numVerts, &data, shrinkwrap_calc_nearest_vertex_cb_ex, &settings); } -/* - * This function raycast a single vertex and updates the hit if the "hit" is considered valid. - * Returns true if "hit" was updated. - * Opts control whether an hit is valid or not - * Supported options are: - * - MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE (front faces hits are ignored) - * - MOD_SHRINKWRAP_CULL_TARGET_BACKFACE (back faces hits are ignored) - */ bool BKE_shrinkwrap_project_normal(char options, const float vert[3], const float dir[3], @@ -1089,9 +1077,6 @@ static void mesh_looptri_target_project(void *userdata, } } -/* - * Maps the point to the nearest surface, either by simple nearest, or by target normal projection. - */ void BKE_shrinkwrap_find_nearest_surface(struct ShrinkwrapTreeData *tree, BVHTreeNearest *nearest, float co[3], @@ -1196,13 +1181,6 @@ static void shrinkwrap_calc_nearest_surface_point_cb_ex(void *__restrict userdat } } -/** - * Compute a smooth normal of the target (if applicable) at the hit location. - * - * \param tree: information about the mesh - * \param transform: transform from the hit coordinate space to the object space; may be null - * \param r_no: output in hit coordinate space; may be shared with inputs - */ void BKE_shrinkwrap_compute_smooth_normal(const struct ShrinkwrapTreeData *tree, const struct SpaceTransform *transform, int looptri_idx, @@ -1318,13 +1296,6 @@ static void shrinkwrap_snap_with_side(float r_point_co[3], } } -/** - * Apply the shrink to surface modes to the given original coordinates and nearest point. - * - * \param tree: mesh data for smooth normals - * \param transform: transform from the hit coordinate space to the object space; may be null - * \param r_point_co: may be the same memory location as point_co, hit_co, or hit_no. - */ void BKE_shrinkwrap_snap_point_to_surface(const struct ShrinkwrapTreeData *tree, const struct SpaceTransform *transform, int mode, @@ -1404,7 +1375,6 @@ static void shrinkwrap_calc_nearest_surface_point(ShrinkwrapCalcData *calc) 0, calc->numVerts, &data, shrinkwrap_calc_nearest_surface_point_cb_ex, &settings); } -/* Main shrinkwrap function */ void shrinkwrapModifier_deform(ShrinkwrapModifierData *smd, const ModifierEvalContext *ctx, struct Scene *scene, |