test/source/blender/bmesh/intern/bmesh_operators.h

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

#pragma once

/** \file
 * \ingroup bmesh
 */

/* See comments in `intern/bmesh_opdefines.cc` for documentation of specific operators. */

#ifdef __cplusplus
extern "C" {
#endif

/*--------defines/enumerations for specific operators-------*/

/* Quad `innervert` values. */
enum {
  SUBD_CORNER_INNERVERT,
  SUBD_CORNER_PATH,
  SUBD_CORNER_FAN,
  SUBD_CORNER_STRAIGHT_CUT,
};

/* aligned with PROP_SMOOTH and friends */
enum {
  SUBD_FALLOFF_SMOOTH = 0,
  SUBD_FALLOFF_SPHERE,
  SUBD_FALLOFF_ROOT,
  SUBD_FALLOFF_SHARP,
  SUBD_FALLOFF_LIN,
  SUBD_FALLOFF_INVSQUARE = 7, /* matching PROP_INVSQUARE */
};

enum {
  SUBDIV_SELECT_NONE,
  SUBDIV_SELECT_ORIG,
  SUBDIV_SELECT_INNER,
  SUBDIV_SELECT_LOOPCUT,
};

/* subdivide_edgering */
enum {
  /* just subdiv */
  SUBD_RING_INTERP_LINEAR,

  /* single bezier spline - curve follows bezier rotation */
  SUBD_RING_INTERP_PATH,

  /* beziers based on adjacent faces (fallback to tangent) */
  SUBD_RING_INTERP_SURF,
};

/* similar face selection slot values */
enum {
  SIMFACE_MATERIAL = 201,
  SIMFACE_AREA,
  SIMFACE_SIDES,
  SIMFACE_PERIMETER,
  SIMFACE_NORMAL,
  SIMFACE_COPLANAR,
  SIMFACE_SMOOTH,
  SIMFACE_FREESTYLE,
};

/* similar edge selection slot values */
enum {
  SIMEDGE_LENGTH = 101,
  SIMEDGE_DIR,
  SIMEDGE_FACE,
  SIMEDGE_FACE_ANGLE,
  SIMEDGE_CREASE,
  SIMEDGE_BEVEL,
  SIMEDGE_SEAM,
  SIMEDGE_SHARP,
  SIMEDGE_FREESTYLE,
};

/* similar vertex selection slot values */
enum {
  SIMVERT_NORMAL = 0,
  SIMVERT_FACE,
  SIMVERT_VGROUP,
  SIMVERT_EDGE,
  SIMVERT_CREASE,
};

/* Poke face center calculation */
enum {
  BMOP_POKE_MEDIAN_WEIGHTED = 0,
  BMOP_POKE_MEDIAN,
  BMOP_POKE_BOUNDS,
};

/* Bevel offset_type slot values */
enum {
  BEVEL_AMT_OFFSET,
  BEVEL_AMT_WIDTH,
  BEVEL_AMT_DEPTH,
  BEVEL_AMT_PERCENT,
  BEVEL_AMT_ABSOLUTE,
};

/* Bevel profile type */
enum {
  BEVEL_PROFILE_SUPERELLIPSE,
  BEVEL_PROFILE_CUSTOM,
};

/* Bevel face_strength_mode values: should match face_str mode enum in DNA_modifier_types.h */
enum {
  BEVEL_FACE_STRENGTH_NONE,
  BEVEL_FACE_STRENGTH_NEW,
  BEVEL_FACE_STRENGTH_AFFECTED,
  BEVEL_FACE_STRENGTH_ALL,
};

/* Bevel miter slot values */
enum {
  BEVEL_MITER_SHARP,
  BEVEL_MITER_PATCH,
  BEVEL_MITER_ARC,
};

/* Bevel vertex mesh creation methods */
enum {
  BEVEL_VMESH_ADJ,
  BEVEL_VMESH_CUTOFF,
};

/* Bevel affect option. */
enum {
  BEVEL_AFFECT_VERTICES = 0,
  BEVEL_AFFECT_EDGES = 1,
};

/* Normal Face Strength values */
enum {
  FACE_STRENGTH_WEAK = -16384,
  FACE_STRENGTH_MEDIUM = 0,
  FACE_STRENGTH_STRONG = 16384,
};

extern const BMOpDefine *bmo_opdefines[];
extern const int bmo_opdefines_total;

/*------specific operator helper functions-------*/
void BM_mesh_esubdivide(BMesh *bm,
                        char edge_hflag,
                        float smooth,
                        short smooth_falloff,
                        bool use_smooth_even,
                        float fractal,
                        float along_normal,
                        int numcuts,
                        int seltype,
                        int cornertype,
                        short use_single_edge,
                        short use_grid_fill,
                        short use_only_quads,
                        int seed);

/**
 * Fills first available UV-map with grid-like UVs for all faces with `oflag` set.
 *
 * \param bm: The BMesh to operate on
 * \param x_segments: The x-resolution of the grid
 * \param y_segments: The y-resolution of the grid
 * \param oflag: The flag to check faces with.
 */
void BM_mesh_calc_uvs_grid(
    BMesh *bm, uint x_segments, uint y_segments, short oflag, int cd_loop_uv_offset);
/**
 * Fills first available UV-map with spherical projected UVs for all faces with `oflag` set.
 *
 * \param bm: The BMesh to operate on
 * \param oflag: The flag to check faces with.
 */
void BM_mesh_calc_uvs_sphere(BMesh *bm, short oflag, int cd_loop_uv_offset);
/**
 * Fills first available UV-map with 2D projected UVs for all faces with `oflag` set.
 *
 * \param bm: The BMesh to operate on.
 * \param mat: The transform matrix applied to the created circle.
 * \param radius: The size of the circle.
 * \param oflag: The flag to check faces with.
 */
void BM_mesh_calc_uvs_circle(
    BMesh *bm, float mat[4][4], float radius, short oflag, int cd_loop_uv_offset);
/**
 * Fills first available UV-map with cylinder/cone-like UVs for all faces with `oflag` set.
 *
 * \param bm: The BMesh to operate on.
 * \param mat: The transform matrix applied to the created cone/cylinder.
 * \param radius_top: The size of the top end of the cone/cylinder.
 * \param radius_bottom: The size of the bottom end of the cone/cylinder.
 * \param segments: The number of subdivisions in the sides of the cone/cylinder.
 * \param cap_ends: Whether the ends of the cone/cylinder are filled or not.
 * \param oflag: The flag to check faces with.
 */
void BM_mesh_calc_uvs_cone(BMesh *bm,
                           float mat[4][4],
                           float radius_top,
                           float radius_bottom,
                           int segments,
                           bool cap_ends,
                           short oflag,
                           int cd_loop_uv_offset);
/**
 * Fills first available UV-map with cube-like UVs for all faces with `oflag` set.
 *
 * \note Expects tagged faces to be six quads.
 * \note Caller must order faces for correct alignment.
 *
 * \param bm: The BMesh to operate on.
 * \param oflag: The flag to check faces with.
 */
void BM_mesh_calc_uvs_cube(BMesh *bm, short oflag);

#include "intern/bmesh_operator_api_inline.h"

#ifdef __cplusplus
}
#endif