Hans Goudey
c34c6d3e25
This commit replaces the `Mesh_Runtime` struct embedded in `Mesh` with `blender::bke::MeshRuntime`. This has quite a few benefits: - It's possible to use C++ types like `std::mutex`, `Array`, `BitVector`, etc. more easily - Meshes saved in files are slightly smaller - Copying and writing meshes is a bit more obvious without clearing of runtime data, etc. The first is by far the most important. It will allows us to avoid a bunch of manual memory management boilerplate that is error-prone and annoying. It should also simplify future CoW improvements for runtime data. This patch doesn't change anything besides changing `mesh.runtime.data` to `mesh.runtime->data`. The cleanups above will happen separately. Differential Revision: https://developer.blender.org/D16180
104 lines
3.9 KiB
C++
104 lines
3.9 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2001-2002 NaN Holding BV. All rights reserved. */
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*
|
|
* This file contains access functions for the Mesh.runtime struct.
|
|
*/
|
|
|
|
//#include "BKE_customdata.h" /* for eCustomDataMask */
|
|
#include "BKE_mesh_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct CustomData;
|
|
struct CustomData_MeshMasks;
|
|
struct Depsgraph;
|
|
struct KeyBlock;
|
|
struct MLoop;
|
|
struct MLoopTri;
|
|
struct MVertTri;
|
|
struct Mesh;
|
|
struct Object;
|
|
struct Scene;
|
|
|
|
/**
|
|
* \brief Free all data (and mutexes) inside the runtime of the given mesh.
|
|
*/
|
|
void BKE_mesh_runtime_free_data(struct Mesh *mesh);
|
|
|
|
int BKE_mesh_runtime_looptri_len(const struct Mesh *mesh);
|
|
void BKE_mesh_runtime_looptri_recalc(struct Mesh *mesh);
|
|
/**
|
|
* \note This function only fills a cache, and therefore the mesh argument can
|
|
* be considered logically const. Concurrent access is protected by a mutex.
|
|
* \note This is a ported copy of dm_getLoopTriArray(dm).
|
|
*/
|
|
const struct MLoopTri *BKE_mesh_runtime_looptri_ensure(const struct Mesh *mesh);
|
|
bool BKE_mesh_runtime_ensure_edit_data(struct Mesh *mesh);
|
|
bool BKE_mesh_runtime_clear_edit_data(struct Mesh *mesh);
|
|
bool BKE_mesh_runtime_reset_edit_data(struct Mesh *mesh);
|
|
void BKE_mesh_runtime_clear_geometry(struct Mesh *mesh);
|
|
/**
|
|
* \brief This function clears runtime cache of the given mesh.
|
|
*
|
|
* Call this function to recalculate runtime data when used.
|
|
*/
|
|
void BKE_mesh_runtime_clear_cache(struct Mesh *mesh);
|
|
|
|
/* This is a copy of DM_verttri_from_looptri(). */
|
|
void BKE_mesh_runtime_verttri_from_looptri(struct MVertTri *r_verttri,
|
|
const struct MLoop *mloop,
|
|
const struct MLoopTri *looptri,
|
|
int looptri_num);
|
|
|
|
/** \note Only used for access in C. */
|
|
bool BKE_mesh_is_deformed_only(const struct Mesh *mesh);
|
|
/** \note Only used for access in C. */
|
|
eMeshWrapperType BKE_mesh_wrapper_type(const struct Mesh *mesh);
|
|
|
|
/* NOTE: the functions below are defined in DerivedMesh.cc, and are intended to be moved
|
|
* to a more suitable location when that file is removed.
|
|
* They should also be renamed to use conventions from BKE, not old DerivedMesh.cc.
|
|
* For now keep the names similar to avoid confusion. */
|
|
|
|
struct Mesh *mesh_get_eval_final(struct Depsgraph *depsgraph,
|
|
const struct Scene *scene,
|
|
struct Object *ob,
|
|
const struct CustomData_MeshMasks *dataMask);
|
|
|
|
struct Mesh *mesh_get_eval_deform(struct Depsgraph *depsgraph,
|
|
const struct Scene *scene,
|
|
struct Object *ob,
|
|
const struct CustomData_MeshMasks *dataMask);
|
|
|
|
struct Mesh *mesh_create_eval_final(struct Depsgraph *depsgraph,
|
|
const struct Scene *scene,
|
|
struct Object *ob,
|
|
const struct CustomData_MeshMasks *dataMask);
|
|
|
|
struct Mesh *mesh_create_eval_no_deform(struct Depsgraph *depsgraph,
|
|
const struct Scene *scene,
|
|
struct Object *ob,
|
|
const struct CustomData_MeshMasks *dataMask);
|
|
struct Mesh *mesh_create_eval_no_deform_render(struct Depsgraph *depsgraph,
|
|
const struct Scene *scene,
|
|
struct Object *ob,
|
|
const struct CustomData_MeshMasks *dataMask);
|
|
|
|
void BKE_mesh_runtime_eval_to_meshkey(struct Mesh *me_deformed,
|
|
struct Mesh *me,
|
|
struct KeyBlock *kb);
|
|
|
|
#ifndef NDEBUG
|
|
bool BKE_mesh_runtime_is_valid(struct Mesh *me_eval);
|
|
#endif /* NDEBUG */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|