multires_reshape.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2020 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_math_vector_types.hh"
#include "BLI_offset_indices.hh"
#include "BLI_span.hh"
#include "BLI_virtual_array.hh"
 
#include "BKE_multires.hh"
 
struct Depsgraph;
struct GridPaintMask;
struct MDisps;
struct Mesh;
struct MultiresModifierData;
struct Object;
namespace blender::bke::subdiv {
struct Subdiv;
}
struct SubdivCCG;
 
struct MultiresReshapeContext {
  /* NOTE: Only available when context is initialized from object. */
  Depsgraph *depsgraph;
  Object *object;
 
  MultiresModifierData *mmd;
 
  /* Base mesh from original object.
   * NOTE: Does NOT include any leading modifiers in it. */
  Mesh *base_mesh;
  blender::Span<blender::float3> base_positions;
  blender::Span<blender::int2> base_edges;
  blender::OffsetIndices<int> base_faces;
  blender::Span<int> base_corner_verts;
  blender::Span<int> base_corner_edges;
 
  /* Subdivision surface created for multires modifier.
   *
   * The coarse mesh of this subdivision surface is a base mesh with all deformation modifiers
   * leading multires applied on it. */
  blender::bke::subdiv::Subdiv *subdiv;
  bool need_free_subdiv;
 
  struct {
    /* Level at which displacement is being assigned to.
     * It will be propagated up from this level to top.level. */
    int level;
 
    /* Grid size for reshape.level. */
    int grid_size;
  } reshape;
 
  struct {
    /* Top level of the displacement grids.
     * The displacement will be propagated up to this level. */
    int level;
 
    /* Grid size for top.level. */
    int grid_size;
  } top;
 
  struct {
    /* Copy of original displacement and painting masks. */
    MDisps *mdisps;
    GridPaintMask *grid_paint_masks;
  } orig;
 
  /* Number of grids which are required for base_mesh. */
  int num_grids;
 
  /* Destination displacement and mask.
   * Points to a custom data on a destination mesh. */
  MDisps *mdisps;
  GridPaintMask *grid_paint_masks;
 
  /* Indexed by face index, gives first grid index of the face. */
  blender::Array<int> face_start_grid_index;
 
  /* Indexed by grid index, contains face index in the base mesh from which the grid has
   * been created (in other words, index of a face which contains loop corresponding to the grid
   * index). */
  blender::Array<int> grid_to_face_index;
 
  /* Indexed by ptex face index, gives first grid index of the ptex face.
   *
   * For non-quad base faces ptex face is created for every face corner, so it's similar to a
   * grid in this case. In this case start grid index will be the only one for this ptex face.
   *
   * For quad base faces there is a single ptex face but 4 grids. So in this case there will be
   * 4 grids for the ptex, starting at a value stored in this mapping. */
  blender::Array<int> ptex_start_grid_index;
 
  /* Indexed by base face index, returns first ptex face index corresponding
   * to that base face. */
  blender::Span<int> face_ptex_offset;
 
  /* Vertex crease custom data layer, empty if none is present. */
  blender::VArraySpan<float> cd_vertex_crease;
  /* Edge crease custom data layer, empty if none is present. */
  blender::VArraySpan<float> cd_edge_crease;
};

struct GridCoord {
  int grid_index;
  float u, v;
};

struct PTexCoord {
  int ptex_face_index;
  float u, v;
};

struct ReshapeGridElement {
  blender::float3 *displacement;
  float *mask;
};
 
struct ReshapeConstGridElement {
  blender::float3 displacement;
  float mask;
};
 
/* --------------------------------------------------------------------
 * Construct/destruct reshape context.
 */

blender::bke::subdiv::Subdiv *multires_reshape_create_subdiv(Depsgraph *depsgraph,
                                                             Object *object,
                                                             const MultiresModifierData *mmd);

bool multires_reshape_context_create_from_object(MultiresReshapeContext *reshape_context,
                                                 Depsgraph *depsgraph,
                                                 Object *object,
                                                 MultiresModifierData *mmd);
 
bool multires_reshape_context_create_from_base_mesh(MultiresReshapeContext *reshape_context,
                                                    Depsgraph *depsgraph,
                                                    Object *object,
                                                    MultiresModifierData *mmd);
 
bool multires_reshape_context_create_from_ccg(MultiresReshapeContext *reshape_context,
                                              SubdivCCG *subdiv_ccg,
                                              Mesh *base_mesh,
                                              int top_level);
 
bool multires_reshape_context_create_from_modifier(MultiresReshapeContext *reshape_context,
                                                   Object *object,
                                                   MultiresModifierData *mmd,
                                                   int top_level);
 
bool multires_reshape_context_create_from_subdiv(MultiresReshapeContext *reshape_context,
                                                 Object *object,
                                                 MultiresModifierData *mmd,
                                                 blender::bke::subdiv::Subdiv *subdiv,
                                                 int top_level);
 
void multires_reshape_free_original_grids(MultiresReshapeContext *reshape_context);
void multires_reshape_context_free(MultiresReshapeContext *reshape_context);
 
/* --------------------------------------------------------------------
 * Helper accessors.
 */

int multires_reshape_grid_to_face_index(const MultiresReshapeContext *reshape_context,
                                        int grid_index);

int multires_reshape_grid_to_corner(const MultiresReshapeContext *reshape_context, int grid_index);
 
bool multires_reshape_is_quad_face(const MultiresReshapeContext *reshape_context, int face_index);

int multires_reshape_grid_to_ptex_index(const MultiresReshapeContext *reshape_context,
                                        int grid_index);

PTexCoord multires_reshape_grid_coord_to_ptex(const MultiresReshapeContext *reshape_context,
                                              const GridCoord *grid_coord);

GridCoord multires_reshape_ptex_coord_to_grid(const MultiresReshapeContext *reshape_context,
                                              const PTexCoord *ptex_coord);

void multires_reshape_tangent_matrix_for_corner(const MultiresReshapeContext *reshape_context,
                                                int face_index,
                                                int corner,
                                                const blender::float3 &dPdu,
                                                const blender::float3 &dPdv,
                                                blender::float3x3 &r_tangent_matrix);

ReshapeGridElement multires_reshape_grid_element_for_grid_coord(
    const MultiresReshapeContext *reshape_context, const GridCoord *grid_coord);
ReshapeGridElement multires_reshape_grid_element_for_ptex_coord(
    const MultiresReshapeContext *reshape_context, const PTexCoord *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.
 */

void multires_reshape_evaluate_base_mesh_limit_at_grid(
    const MultiresReshapeContext *reshape_context,
    const GridCoord *grid_coord,
    blender::float3 &r_P,
    blender::float3x3 &r_tangent_matrix);
 
/* --------------------------------------------------------------------
 * Custom data preparation.
 */

void multires_reshape_ensure_grids(Mesh *mesh, int level);
 
/* --------------------------------------------------------------------
 * Functions specific to reshaping from a set of vertices in a object position.
 */

bool multires_reshape_assign_final_coords_from_vertcos(
    const MultiresReshapeContext *reshape_context, blender::Span<blender::float3> positions);
 
/* --------------------------------------------------------------------
 * Functions specific to reshaping from CCG.
 */

bool multires_reshape_assign_final_coords_from_ccg(const MultiresReshapeContext *reshape_context,
                                                   SubdivCCG *subdiv_ccg);
 
/* --------------------------------------------------------------------
 * Functions specific to reshaping from MDISPS.
 */

void multires_reshape_assign_final_coords_from_mdisps(
    const MultiresReshapeContext *reshape_context);

void multires_reshape_assign_final_elements_from_orig_mdisps(
    const MultiresReshapeContext *reshape_context);
 
/* --------------------------------------------------------------------
 * Displacement smooth.
 */

void multires_reshape_smooth_object_grids_with_details(
    const MultiresReshapeContext *reshape_context);

void multires_reshape_smooth_object_grids(const MultiresReshapeContext *reshape_context,
                                          enum MultiresSubdivideModeType mode);
 
/* --------------------------------------------------------------------
 * Displacement, space conversion.
 */

void multires_reshape_store_original_grids(MultiresReshapeContext *reshape_context);
 
void multires_reshape_object_grids_to_tangent_displacement(
    const MultiresReshapeContext *reshape_context);
 
/* --------------------------------------------------------------------
 * Apply base.
 */

void multires_reshape_apply_base_update_mesh_coords(MultiresReshapeContext *reshape_context);

void multires_reshape_apply_base_refit_base_mesh(MultiresReshapeContext *reshape_context);

void multires_reshape_apply_base_refine_from_base(MultiresReshapeContext *reshape_context);

void multires_reshape_apply_base_refine_from_deform(MultiresReshapeContext *reshape_context);