bmesh_mesh.hh

Go to the documentation of this file.

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

 
#include "BLI_array.hh"
#include "BLI_math_matrix_types.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_span.hh"
 
#include "bmesh_class.hh"
 
#include "intern/bmesh_operator_api.hh"
 
struct BMAllocTemplate;
 
void BM_mesh_elem_toolflags_ensure(BMesh *bm);
void BM_mesh_elem_toolflags_clear(BMesh *bm);
 
struct BMeshCreateParams {
  bool use_toolflags : 1;
};

BMesh *BM_mesh_create(const BMAllocTemplate *allocsize, const BMeshCreateParams *params);

void BM_mesh_free(BMesh *bm);
void BM_mesh_data_free(BMesh *bm);
void BM_mesh_clear(BMesh *bm);

void bmesh_edit_begin(BMesh *bm, BMOpTypeFlag type_flag);
void bmesh_edit_end(BMesh *bm, BMOpTypeFlag type_flag);
 
void BM_mesh_elem_index_ensure_ex(BMesh *bm, char htype, int elem_offset[4]);
void BM_mesh_elem_index_ensure(BMesh *bm, char htype);
void BM_mesh_elem_index_validate(
    BMesh *bm, const char *location, const char *func, const char *msg_a, const char *msg_b);
 
#ifndef NDEBUG
bool BM_mesh_elem_table_check(BMesh *bm);
#endif

void BM_mesh_toolflags_set(BMesh *bm, bool use_toolflags);
 
void BM_mesh_elem_table_ensure(BMesh *bm, char htype);
/* use BM_mesh_elem_table_ensure where possible to avoid full rebuild */
void BM_mesh_elem_table_init(BMesh *bm, char htype);
void BM_mesh_elem_table_free(BMesh *bm, char htype);
 
BLI_INLINE BMVert *BM_vert_at_index(BMesh *bm, const int index)
{
  BLI_assert((index >= 0) && (index < bm->totvert));
  BLI_assert((bm->elem_table_dirty & BM_VERT) == 0);
  return bm->vtable[index];
}
BLI_INLINE BMEdge *BM_edge_at_index(BMesh *bm, const int index)
{
  BLI_assert((index >= 0) && (index < bm->totedge));
  BLI_assert((bm->elem_table_dirty & BM_EDGE) == 0);
  return bm->etable[index];
}
BLI_INLINE BMFace *BM_face_at_index(BMesh *bm, const int index)
{
  BLI_assert((index >= 0) && (index < bm->totface));
  BLI_assert((bm->elem_table_dirty & BM_FACE) == 0);
  return bm->ftable[index];
}
 
BMVert *BM_vert_at_index_find(BMesh *bm, int index);
BMEdge *BM_edge_at_index_find(BMesh *bm, int index);
BMFace *BM_face_at_index_find(BMesh *bm, int index);
BMLoop *BM_loop_at_index_find(BMesh *bm, int index);

BMVert *BM_vert_at_index_find_or_table(BMesh *bm, int index);
BMEdge *BM_edge_at_index_find_or_table(BMesh *bm, int index);
BMFace *BM_face_at_index_find_or_table(BMesh *bm, int index);
 
// XXX

int BM_mesh_elem_count(BMesh *bm, char htype);

void BM_mesh_remap(BMesh *bm, const uint *vert_idx, const uint *edge_idx, const uint *face_idx);

void BM_mesh_rebuild(BMesh *bm,
                     const BMeshCreateParams *params,
                     BLI_mempool *vpool,
                     BLI_mempool *epool,
                     BLI_mempool *lpool,
                     BLI_mempool *fpool);
 
struct BMAllocTemplate {
  int totvert, totedge, totloop, totface;
};
 
/* used as an extern, defined in bmesh.h */
extern const BMAllocTemplate bm_mesh_allocsize_default;
extern const BMAllocTemplate bm_mesh_chunksize_default;
 
#define BMALLOC_TEMPLATE_FROM_BM(bm) \
  {(CHECK_TYPE_INLINE(bm, BMesh *), (bm)->totvert), (bm)->totedge, (bm)->totloop, (bm)->totface}
 
#define _VA_BMALLOC_TEMPLATE_FROM_ME_1(me) \
  { \
      (CHECK_TYPE_INLINE(me, Mesh *), (me)->verts_num), \
      (me)->edges_num, \
      (me)->corners_num, \
      (me)->faces_num, \
  }
#define _VA_BMALLOC_TEMPLATE_FROM_ME_2(me_a, me_b) \
  { \
      (CHECK_TYPE_INLINE(me_a, Mesh *), \
       CHECK_TYPE_INLINE(me_b, Mesh *), \
       (me_a)->verts_num + (me_b)->verts_num), \
      (me_a)->edges_num + (me_b)->edges_num, \
      (me_a)->corners_num + (me_b)->corners_num, \
      (me_a)->faces_num + (me_b)->faces_num, \
  }
#define BMALLOC_TEMPLATE_FROM_ME(...) \
  VA_NARGS_CALL_OVERLOAD(_VA_BMALLOC_TEMPLATE_FROM_ME_, __VA_ARGS__)
 
void BM_mesh_vert_normals_get(BMesh *bm, blender::MutableSpan<blender::float3> normals);
 
/* Vertex coords access. */
void BM_mesh_vert_coords_get(BMesh *bm, blender::MutableSpan<blender::float3> positions);
blender::Array<blender::float3> BM_mesh_vert_coords_alloc(BMesh *bm);
void BM_mesh_vert_coords_apply(BMesh *bm, blender::Span<blender::float3> vert_coords);
void BM_mesh_vert_coords_apply_with_mat4(BMesh *bm,
                                         blender::Span<blender::float3> vert_coords,
                                         const blender::float4x4 &transform);