BKE_mesh_legacy_derived_mesh.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
/*
 * NOTE: This structure is read-only, for all practical purposes.
 *       At some point in the future, we may want to consider
 *       creating a replacement structure that implements a proper
 *       abstract mesh kernel interface.  Or, we can leave this
 *       as it is and stick with using BMesh and CDDM.
 */
 
#include "BLI_compiler_attrs.h"
#include "BLI_math_vector_types.hh"
#include "BLI_span.hh"
 
#include "DNA_customdata_types.h"
 
struct CCGElem;
struct CCGKey;
struct CustomData_MeshMasks;
struct Mesh;
 
enum DerivedMeshType {
  DM_TYPE_CDDM,
  DM_TYPE_CCGDM,
};
 
struct DerivedMesh {
  CustomData vertData, edgeData, faceData, loopData, polyData;
  int numVertData, numEdgeData, numTessFaceData, numLoopData, numPolyData;
  DerivedMeshType type;
  /* Always owned by this object. */
  int *face_offsets;
 
  short tangent_mask; /* which tangent layers are calculated */
 
  /* Misc. Queries */
 
  /* Also called in Editmode */
  int (*getNumVerts)(DerivedMesh *dm);
  int (*getNumEdges)(DerivedMesh *dm);
  int (*getNumLoops)(DerivedMesh *dm);
  int (*getNumPolys)(DerivedMesh *dm);
 
  float *(*getVertArray)(DerivedMesh *dm);
  blender::int2 *(*getEdgeArray)(DerivedMesh *dm);
  int *(*getCornerVertArray)(DerivedMesh *dm);
  int *(*getCornerEdgeArray)(DerivedMesh *dm);
  int *(*getPolyArray)(DerivedMesh *dm);
 
  void (*copyVertArray)(DerivedMesh *dm, float (*r_positions)[3]);
  void (*copyEdgeArray)(DerivedMesh *dm, blender::int2 *r_edge);
  void (*copyCornerVertArray)(DerivedMesh *dm, int *r_corner_verts);
  void (*copyCornerEdgeArray)(DerivedMesh *dm, int *r_corner_edges);
  void (*copyPolyArray)(DerivedMesh *dm, int *r_face_offsets);
 
  void *(*getVertDataArray)(DerivedMesh *dm, eCustomDataType type);
  void *(*getEdgeDataArray)(DerivedMesh *dm, eCustomDataType type);
  void *(*getLoopDataArray)(DerivedMesh *dm, eCustomDataType type);
  void *(*getPolyDataArray)(DerivedMesh *dm, eCustomDataType type);
 
  int (*getNumGrids)(DerivedMesh *dm);
  int (*getGridSize)(DerivedMesh *dm);
  CCGElem **(*getGridData)(DerivedMesh *dm);
  int *(*getGridOffset)(DerivedMesh *dm);
  void (*getGridKey)(DerivedMesh *dm, CCGKey *key);
 
  /* Direct Access Operations
   * - Can be undefined
   * - Must be defined for modifiers that only deform however. */
 
  void (*release)(DerivedMesh *dm);
};
 
void DM_init_funcs(DerivedMesh *dm);
 
void DM_init(DerivedMesh *dm,
             DerivedMeshType type,
             int numVerts,
             int numEdges,
             int numTessFaces,
             int numLoops,
             int numPolys);
 
void DM_from_template(DerivedMesh *dm,
                      DerivedMesh *source,
                      DerivedMeshType type,
                      int numVerts,
                      int numEdges,
                      int numTessFaces,
                      int numLoops,
                      int numPolys);
 
void DM_release(DerivedMesh *dm);
 
void DM_set_only_copy(DerivedMesh *dm, const CustomData_MeshMasks *mask);
 
/* creates a CDDerivedMesh from the given Mesh, this will reference the
 * original data in Mesh, but it is safe to apply vertex coordinates or
 * calculate normals as those functions will automatically create new
 * data to not overwrite the original. */
DerivedMesh *CDDM_from_mesh(Mesh *mesh);
 
/* -------------------------------------------------------------------- */
void *DM_get_vert_data_layer(DerivedMesh *dm, eCustomDataType type);
void *DM_get_edge_data_layer(DerivedMesh *dm, eCustomDataType type);
void *DM_get_poly_data_layer(DerivedMesh *dm, eCustomDataType type);
void *DM_get_loop_data_layer(DerivedMesh *dm, eCustomDataType type);
 
void DM_copy_vert_data(
    const DerivedMesh *source, DerivedMesh *dest, int source_index, int dest_index, int count);
 
void DM_interp_vert_data(const DerivedMesh *source,
                         DerivedMesh *dest,
                         int *src_indices,
                         float *weights,
                         int count,
                         int dest_index);