BKE_subdiv.hh

Go to the documentation of this file.

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

 
#pragma once
 
#include "BLI_array.hh"
#include "BLI_compiler_compat.h"
#include "BLI_math_vector_types.hh"
 
struct Mesh;
struct MultiresModifierData;
struct OpenSubdiv_Converter;
struct OpenSubdiv_Evaluator;
namespace blender::opensubdiv {
class TopologyRefinerImpl;
}
 
namespace blender::bke::subdiv {
 
enum VtxBoundaryInterpolation {
  SUBDIV_VTX_BOUNDARY_NONE,
  SUBDIV_VTX_BOUNDARY_EDGE_ONLY,
  SUBDIV_VTX_BOUNDARY_EDGE_AND_CORNER,
};
 
enum FVarLinearInterpolation {
  SUBDIV_FVAR_LINEAR_INTERPOLATION_NONE,
  SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_ONLY,
  SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_AND_JUNCTIONS,
  SUBDIV_FVAR_LINEAR_INTERPOLATION_CORNERS_JUNCTIONS_AND_CONCAVE,
  SUBDIV_FVAR_LINEAR_INTERPOLATION_BOUNDARIES,
  SUBDIV_FVAR_LINEAR_INTERPOLATION_ALL,
};
 
struct Settings {
  bool is_simple;

  bool is_adaptive;

  int level;
 
  bool use_creases;
 
  VtxBoundaryInterpolation vtx_boundary_interpolation;
  FVarLinearInterpolation fvar_linear_interpolation;
};

enum StatsValue {
  SUBDIV_STATS_TOPOLOGY_REFINER_CREATION_TIME = 0,
  SUBDIV_STATS_SUBDIV_TO_MESH,
  SUBDIV_STATS_SUBDIV_TO_MESH_GEOMETRY,
  SUBDIV_STATS_EVALUATOR_CREATE,
  SUBDIV_STATS_EVALUATOR_REFINE,
  SUBDIV_STATS_SUBDIV_TO_CCG,
  SUBDIV_STATS_SUBDIV_TO_CCG_ELEMENTS,
  SUBDIV_STATS_TOPOLOGY_COMPARE,
 
  NUM_SUBDIV_STATS_VALUES,
};
 
struct SubdivStats {
  union {
    struct {
      double topology_refiner_creation_time;
      double subdiv_to_mesh_time;
      double subdiv_to_mesh_geometry_time;
      double evaluator_creation_time;
      double evaluator_refine_time;
      double subdiv_to_ccg_time;
      double subdiv_to_ccg_elements_time;
      double topology_compare_time;
    };
    double values_[NUM_SUBDIV_STATS_VALUES];
  };

  double begin_timestamp_[NUM_SUBDIV_STATS_VALUES];
};

struct Displacement {
  void (*initialize)(Displacement *displacement);

  void (*eval_displacement)(Displacement *displacement,
                            int ptex_face_index,
                            float u,
                            float v,
                            const float3 &dPdu,
                            const float3 &dPdv,
                            float3 &r_D);

  void (*free)(Displacement *displacement);
 
  void *user_data;
};

struct Subdiv {
  Settings settings;
  blender::opensubdiv::TopologyRefinerImpl *topology_refiner;
  OpenSubdiv_Evaluator *evaluator;
  Displacement *displacement_evaluator;
  SubdivStats stats;

  struct {
    blender::Array<int> face_ptex_offset;
  } cache_;
};
 
/* -------------------------------------------------------------------- */
 
/* (De)initialize the entire subdivision surface module. */
void init();
void exit();

 
/* -------------------------------------------------------------------- */

FVarLinearInterpolation fvar_interpolation_from_uv_smooth(int uv_smooth);
 
VtxBoundaryInterpolation vtx_boundary_interpolation_from_subsurf(int boundary_smooth);

 
/* -------------------------------------------------------------------- */
 
void stats_init(SubdivStats *stats);
 
void stats_begin(SubdivStats *stats, StatsValue value);
void stats_end(SubdivStats *stats, StatsValue value);
 
void stats_reset(SubdivStats *stats, StatsValue value);
 
void stats_print(const SubdivStats *stats);

 
/* -------------------------------------------------------------------- */
 
bool settings_equal(const Settings *settings_a, const Settings *settings_b);

 
/* -------------------------------------------------------------------- */

Subdiv *new_from_converter(const Settings *settings, OpenSubdiv_Converter *converter);
Subdiv *new_from_mesh(const Settings *settings, const Mesh *mesh);

Subdiv *update_from_converter(Subdiv *subdiv,
                              const Settings *settings,
                              OpenSubdiv_Converter *converter);
Subdiv *update_from_mesh(Subdiv *subdiv, const Settings *settings, const Mesh *mesh);
 
void free(Subdiv *subdiv);

 
/* -------------------------------------------------------------------- */
 
void displacement_attach_from_multires(Subdiv *subdiv,
                                       const Mesh *mesh,
                                       const MultiresModifierData *mmd);
 
void displacement_detach(Subdiv *subdiv);

 
/* -------------------------------------------------------------------- */

Span<int> face_ptex_offset_get(Subdiv *subdiv);

 
/* -------------------------------------------------------------------- */

BLI_INLINE void ptex_face_uv_to_grid_uv(float ptex_u,
                                        float ptex_v,
                                        float *r_grid_u,
                                        float *r_grid_v);
BLI_INLINE float2 ptex_face_uv_to_grid_uv(const float2 &ptex_uv);

BLI_INLINE void grid_uv_to_ptex_face_uv(float grid_u,
                                        float grid_v,
                                        float *r_ptex_u,
                                        float *r_ptex_v);

BLI_INLINE int grid_size_from_level(int level);

BLI_INLINE int rotate_quad_to_corner(float quad_u,
                                     float quad_v,
                                     float *r_corner_u,
                                     float *r_corner_v);
BLI_INLINE float2 rotate_quad_to_corner(int corner, const float2 &quad);

BLI_INLINE void rotate_grid_to_quad(
    int corner, float grid_u, float grid_v, float *r_quad_u, float *r_quad_v);

BLI_INLINE float crease_to_sharpness(float crease);
BLI_INLINE float sharpness_to_crease(float sharpness);

 
}  // namespace blender::bke::subdiv
 
#include "intern/subdiv_inline.hh"  // IWYU pragma: export