diff options
Diffstat (limited to 'source/blender/blenkernel/BKE_multires.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_multires.h | 98 |
1 files changed, 71 insertions, 27 deletions
diff --git a/source/blender/blenkernel/BKE_multires.h b/source/blender/blenkernel/BKE_multires.h index 11bfc4b2b3a..504771fa733 100644 --- a/source/blender/blenkernel/BKE_multires.h +++ b/source/blender/blenkernel/BKE_multires.h @@ -45,7 +45,9 @@ struct MLoopTri; struct MPoly; struct MVert; -/* Delete mesh mdisps and grid paint masks */ +/** + * Delete mesh mdisps and grid paint masks. + */ void multires_customdata_delete(struct Mesh *me); void multires_set_tot_level(struct Object *ob, struct MultiresModifierData *mmd, int lvl); @@ -62,6 +64,9 @@ void multires_force_external_reload(struct Object *object); void multires_modifier_update_mdisps(struct DerivedMesh *dm, struct Scene *scene); void multires_modifier_update_hidden(struct DerivedMesh *dm); +/** + * Reset the multi-res levels to match the number of mdisps. + */ void multiresModifier_set_levels_from_disps(struct MultiresModifierData *mmd, struct Object *ob); typedef enum { @@ -79,6 +84,10 @@ struct DerivedMesh *multires_make_derived_from_derived(struct DerivedMesh *dm, struct MultiresModifierData *find_multires_modifier_before(struct Scene *scene, struct ModifierData *lastmd); +/** + * used for applying scale on mdisps layer and syncing subdivide levels when joining objects. + * \param use_first: return first multi-res modifier if all multi-res'es are disabled. + */ struct MultiresModifierData *get_multires_modifier(struct Scene *scene, struct Object *ob, bool use_first); @@ -88,18 +97,25 @@ int multires_get_level(const struct Scene *scene, bool render, bool ignore_simplify); -/* Creates mesh with multires modifier applied on current object's deform mesh. */ +/** + * Creates mesh with multi-res modifier applied on current object's deform mesh. + */ struct Mesh *BKE_multires_create_mesh(struct Depsgraph *depsgraph, struct Object *object, struct MultiresModifierData *mmd); -/* Get coordinates of a deformed base mesh which is an input to the given multires modifier. - * NOTE: The modifiers will be re-evaluated. */ +/** + * Get coordinates of a deformed base mesh which is an input to the given multi-res modifier. + * \note The modifiers will be re-evaluated. + */ float (*BKE_multires_create_deformed_base_mesh_vert_coords(struct Depsgraph *depsgraph, struct Object *object, struct MultiresModifierData *mmd, int *r_num_deformed_verts))[3]; +/** + * \param direction: 1 for delete higher, 0 for lower (not implemented yet). + */ void multiresModifier_del_levels(struct MultiresModifierData *mmd, struct Scene *scene, struct Object *object, @@ -112,6 +128,10 @@ int multiresModifier_rebuild_subdiv(struct Depsgraph *depsgraph, struct MultiresModifierData *mmd, int rebuild_limit, bool switch_view_to_lower_level); +/** + * If `ob_src` and `ob_dst` both have multi-res modifiers, + * synchronize them such that `ob_dst` has the same total number of levels as `ob_src`. + */ void multiresModifier_sync_levels_ex(struct Object *ob_dst, struct MultiresModifierData *mmd_src, struct MultiresModifierData *mmd_dst); @@ -128,22 +148,36 @@ void multiresModifier_prepare_join(struct Depsgraph *depsgraph, int multires_mdisp_corners(struct MDisps *s); -/* update multires data after topology changing */ +/** + * Update multi-res data after topology changing. + */ void multires_topology_changed(struct Mesh *me); +/** + * Makes sure data from an external file is fully read. + * + * Since the multi-res data files only contain displacement vectors without knowledge about + * subdivision level some extra work is needed. Namely make is to all displacement grids have + * proper level and number of displacement vectors set. + */ void multires_ensure_external_read(struct Mesh *mesh, int top_level); void multiresModifier_ensure_external_read(struct Mesh *mesh, const struct MultiresModifierData *mmd); /**** interpolation stuff ****/ -void old_mdisps_bilinear(float out[3], float (*disps)[3], const int st, float u, float v); +/* Adapted from `sculptmode.c` */ + +void old_mdisps_bilinear(float out[3], float (*disps)[3], int st, float u, float v); +/** + * Find per-corner coordinate with given per-face UV coord. + */ int mdisp_rot_face_to_crn(struct MVert *mvert, struct MPoly *mpoly, struct MLoop *mloop, const struct MLoopTri *lt, - const int face_side, - const float u, - const float v, + int face_side, + float u, + float v, float *x, float *y); @@ -153,7 +187,13 @@ bool multiresModifier_reshapeFromVertcos(struct Depsgraph *depsgraph, struct Object *object, struct MultiresModifierData *mmd, const float (*vert_coords)[3], - const int num_vert_coords); + int num_vert_coords); +/** + * Returns truth on success, false otherwise. + * + * This function might fail in cases like source and destination not having + * matched amount of vertices. + */ bool multiresModifier_reshapeFromObject(struct Depsgraph *depsgraph, struct MultiresModifierData *mmd, struct Object *dst, @@ -162,11 +202,11 @@ bool multiresModifier_reshapeFromDeformModifier(struct Depsgraph *depsgraph, struct Object *ob, struct MultiresModifierData *mmd, struct ModifierData *deform_md); -bool multiresModifier_reshapeFromCCG(const int tot_level, +bool multiresModifier_reshapeFromCCG(int tot_level, struct Mesh *coarse_mesh, struct SubdivCCG *subdiv_ccg); -/* Subdivide multires displacement once. */ +/* Subdivide multi-res displacement once. */ typedef enum eMultiresSubdivideModeType { MULTIRES_SUBDIVIDE_CATMULL_CLARK, @@ -176,16 +216,18 @@ typedef enum eMultiresSubdivideModeType { void multiresModifier_subdivide(struct Object *object, struct MultiresModifierData *mmd, - const eMultiresSubdivideModeType mode); + eMultiresSubdivideModeType mode); void multires_subdivide_create_tangent_displacement_linear_grids(struct Object *object, struct MultiresModifierData *mmd); -/* Subdivide displacement to the given level. - * If level is lower than the current top level nothing happens. */ +/** + * Subdivide displacement to the given level. + * If level is lower than the current top level nothing happens. + */ void multiresModifier_subdivide_to_level(struct Object *object, struct MultiresModifierData *mmd, - const int top_level, - const eMultiresSubdivideModeType mode); + int top_level, + eMultiresSubdivideModeType mode); /* Subdivision integration, defined in multires_subdiv.c */ @@ -200,27 +242,29 @@ void BKE_multires_subdiv_mesh_settings_init(struct SubdivToMeshSettings *mesh_se const struct Scene *scene, const struct Object *object, const struct MultiresModifierData *mmd, - const bool use_render_params, - const bool ignore_simplify, - const bool ignore_control_edges); + bool use_render_params, + bool ignore_simplify, + bool ignore_control_edges); /* General helpers. */ -/* For a given partial derivatives of a ptex face get tangent matrix for - * displacement. +/** + * For a given partial derivatives of a PTEX face get tangent matrix for displacement. * * Corner needs to be known to properly "rotate" partial derivatives when the - * matrix is being constructed for quad. For non-quad the corner is to be set - * to 0. */ + * matrix is being constructed for quad. For non-quad the corner is to be set to 0. + */ BLI_INLINE void BKE_multires_construct_tangent_matrix(float tangent_matrix[3][3], const float dPdu[3], const float dPdv[3], - const int corner); + int corner); /* Versioning. */ -/* Convert displacement which is stored for simply-subdivided mesh to a Catmull-Clark - * subdivided mesh. */ +/** + * Convert displacement which is stored for simply-subdivided mesh to a Catmull-Clark + * subdivided mesh. + */ void multires_do_versions_simple_to_catmull_clark(struct Object *object, struct MultiresModifierData *mmd); |