Blender V5.3
bake_geometry_nodes_modifier.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <sstream>
10
12#include "BKE_collection.hh"
13#include "BKE_library.hh"
14#include "BKE_main.hh"
15#include "BKE_path_templates.hh"
16
17#include "DNA_modifier_types.h"
18#include "DNA_node_types.h"
19
20#include "BLI_listbase.hh"
21#include "BLI_path_utils.hh"
22#include "BLI_string.hh"
23
24#include "MOD_nodes.hh"
25
26namespace blender::bke::bake {
27
29{
30 std::destroy_at(this);
31 new (this) SimulationNodeCache();
32}
33
35{
36 std::destroy_at(this);
37 new (this) BakeNodeCache();
38}
39
41{
42 std::destroy_at(this);
43 new (this) NodeBakeCache();
44}
45
47{
48 if (this->frames.is_empty()) {
49 return {};
50 }
51 const int start_frame = this->frames.first()->frame.frame();
52 const int end_frame = this->frames.last()->frame.frame();
53 return IndexRange::from_begin_end_inclusive(start_frame, end_frame);
54}
55
57{
58 std::unique_ptr<SimulationNodeCache> *ptr = this->simulation_cache_by_id.lookup_ptr(id);
59 return ptr ? (*ptr).get() : nullptr;
60}
61
63{
64 std::unique_ptr<BakeNodeCache> *ptr = this->bake_cache_by_id.lookup_ptr(id);
65 return ptr ? (*ptr).get() : nullptr;
66}
67
69{
70 if (SimulationNodeCache *cache = this->get_simulation_node_cache(id)) {
71 return &cache->bake;
72 }
73 if (BakeNodeCache *cache = this->get_bake_node_cache(id)) {
74 return &cache->bake;
75 }
76 return nullptr;
77}
78
80{
81 if (SimulationNodeCache *cache = this->get_simulation_node_cache(id)) {
82 cache->reset();
83 }
84 if (BakeNodeCache *cache = this->get_bake_node_cache(id)) {
85 cache->reset();
86 }
87}
88
90{
91 FOREACH_SCENE_OBJECT_BEGIN (&scene, ob) {
92 for (ModifierData &md : ob->modifiers) {
93 if (md.type != eModifierType_Nodes) {
94 continue;
95 }
96 NodesModifierData *nmd = reinterpret_cast<NodesModifierData *>(&md);
97 if (!nmd->runtime->cache) {
98 continue;
99 }
100 for (auto item : nmd->runtime->cache->simulation_cache_by_id.items()) {
101 item.value->reset();
102 }
103 }
104 }
106}
107
108static std::optional<std::string> resolve_bake_directory(const Main &bmain,
109 const Object &object,
110 const StringRef directory)
111{
112 if (directory.is_empty() || directory.size() >= FILE_MAX) {
113 return std::nullopt;
114 }
115 char absolute_bake_dir[FILE_MAX];
116 directory.copy_bytes_truncated(absolute_bake_dir);
119 BKE_add_template_variables_general(variables, &object.id, project);
120 });
121 if (!BKE_path_apply_template(absolute_bake_dir, sizeof(absolute_bake_dir), variables).is_empty())
122 {
123 return std::nullopt;
124 }
125 if (absolute_bake_dir[0] == '\0') {
126 return std::nullopt;
127 }
128 if (!BLI_path_is_rel(absolute_bake_dir)) {
129 return absolute_bake_dir;
130 }
131 const char *base_path = ID_BLEND_PATH(&bmain, &object.id);
132 if (StringRef(base_path).is_empty()) {
133 return std::nullopt;
134 }
135 BLI_path_abs(absolute_bake_dir, base_path);
136 return absolute_bake_dir;
137}
138
139std::optional<std::string> get_modifier_bake_path(const Main &bmain,
140 const Object &object,
141 const NodesModifierData &nmd)
142{
143 return resolve_bake_directory(bmain, object, nmd.bake_directory);
144}
145
146std::optional<NodesModifierBakeTarget> get_node_bake_target(const Object & /*object*/,
147 const NodesModifierData &nmd,
148 int node_id)
149{
150 const NodesModifierBake *bake = nmd.find_bake(node_id);
151 if (!bake) {
152 return std::nullopt;
153 }
154 if (bake->bake_target != NODES_MODIFIER_BAKE_TARGET_INHERIT) {
155 return NodesModifierBakeTarget(bake->bake_target);
156 }
159 }
161}
162
163std::optional<bake::BakePath> get_node_bake_path(const Main &bmain,
164 const Object &object,
165 const NodesModifierData &nmd,
166 int node_id)
167{
168 const NodesModifierBake *bake = nmd.find_bake(node_id);
169 if (bake == nullptr) {
170 return std::nullopt;
171 }
173 const std::optional<std::string> bake_dir = resolve_bake_directory(
174 bmain, object, bake->directory);
175 if (!bake_dir) {
176 return std::nullopt;
177 }
178 return BakePath::from_single_root(*bake_dir);
179 }
180 const std::optional<std::string> modifier_bake_path = get_modifier_bake_path(bmain, object, nmd);
181 if (!modifier_bake_path) {
182 return std::nullopt;
183 }
184 char bake_dir[FILE_MAX];
186 bake_dir, sizeof(bake_dir), modifier_bake_path->c_str(), std::to_string(node_id).c_str());
187 return bake::BakePath::from_single_root(bake_dir);
188}
189
190static IndexRange fix_frame_range(const int start, const int end)
191{
192 const int num_frames = std::max(1, end - start + 1);
193 return IndexRange(start, num_frames);
194}
195
196std::optional<IndexRange> get_node_bake_frame_range(const Scene &scene,
197 const Object & /*object*/,
198 const NodesModifierData &nmd,
199 int node_id)
200{
201 const NodesModifierBake *bake = nmd.find_bake(node_id);
202 if (bake == nullptr) {
203 return std::nullopt;
204 }
206 return fix_frame_range(bake->frame_start, bake->frame_end);
207 }
208 if (scene.flag & SCE_CUSTOM_SIMULATION_RANGE) {
210 }
211 return fix_frame_range(scene.r.sfra, scene.r.efra);
212}
213
218static std::string escape_name(const StringRef name)
219{
220 std::stringstream ss;
221 for (const char c : name) {
222 /* Only some letters allowed. Digits are not because they could lead to name collisions. */
223 if (('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z')) {
224 ss << c;
225 }
226 else {
227 ss << int(c);
228 }
229 }
230 return ss.str();
231}
232
233static std::string get_blend_file_name(const Main &bmain)
234{
235 const StringRefNull blend_file_path = BKE_main_blendfile_path(&bmain);
236 char blend_name[FILE_MAX];
237
238 BLI_path_split_file_part(blend_file_path.c_str(), blend_name, sizeof(blend_name));
239 const int64_t type_start_index = StringRef(blend_name).rfind(".");
240 if (type_start_index == StringRef::not_found) {
241 return "";
242 }
243 blend_name[type_start_index] = '\0';
244 return "blendcache_" + StringRef(blend_name);
245}
246
247static std::string get_modifier_directory_name(const Object &object, const ModifierData &md)
248{
249 const std::string object_name_escaped = escape_name(object.id.name + 2);
250 const std::string modifier_name_escaped = escape_name(md.name);
251 return object_name_escaped + "_" + modifier_name_escaped;
252}
253
255 const Object &object,
256 const NodesModifierData &nmd)
257{
258 char dir[FILE_MAX];
259 /* Make path that's relative to the .blend file. */
260 BLI_path_join(dir,
261 sizeof(dir),
262 "//",
263 get_blend_file_name(bmain).c_str(),
264 get_modifier_directory_name(object, nmd.modifier).c_str());
265 return dir;
266}
267
268std::string get_default_node_bake_directory(const Main &bmain,
269 const Object &object,
270 const NodesModifierData &nmd,
271 int node_id)
272{
273 char dir[FILE_MAX];
274 BLI_path_join(dir,
275 sizeof(dir),
276 "//",
277 get_blend_file_name(bmain).c_str(),
278 get_modifier_directory_name(object, nmd.modifier).c_str(),
279 std::to_string(node_id).c_str());
280 return dir;
281}
282
283} // namespace blender::bke::bake
#define FOREACH_SCENE_OBJECT_END
#define FOREACH_SCENE_OBJECT_BEGIN(scene, _instance)
Functions and classes for evaluating template expressions in filepaths.
#define FILE_MAX
#define BLI_path_join(...)
#define ID_BLEND_PATH(_bmain, _id)
Definition DNA_ID.h:688
constexpr IndexRange()=default
static constexpr IndexRange from_begin_end_inclusive(const int64_t begin, const int64_t last)
constexpr const char * c_str() const
constexpr StringRef()
static constexpr int64_t not_found
constexpr bool is_empty() const
constexpr int64_t size() const
void copy_bytes_truncated(char *dst, int64_t dst_size) const
Definition string_ref.cc:47
std::optional< NodesModifierBakeTarget > get_node_bake_target(const Object &object, const NodesModifierData &nmd, int node_id)
std::string get_default_modifier_bake_directory(const Main &bmain, const Object &object, const NodesModifierData &nmd)
std::optional< BakePath > get_node_bake_path(const Main &bmain, const Object &object, const NodesModifierData &nmd, int node_id)
static IndexRange fix_frame_range(const int start, const int end)
std::optional< IndexRange > get_node_bake_frame_range(const Scene &scene, const Object &object, const NodesModifierData &nmd, int node_id)
static std::string escape_name(const StringRef name)
void scene_simulation_states_reset(Scene &scene)
static std::optional< std::string > resolve_bake_directory(const Main &bmain, const Object &object, const StringRef directory)
static std::string get_blend_file_name(const Main &bmain)
std::optional< std::string > get_modifier_bake_path(const Main &bmain, const Object &object, const NodesModifierData &nmd)
static std::string get_modifier_directory_name(const Object &object, const ModifierData &md)
std::string get_default_node_bake_directory(const Main &bmain, const Object &object, const NodesModifierData &nmd, int node_id)
@ SCE_CUSTOM_SIMULATION_RANGE
__int64 int64_t
Definition BKE_text.h:90
@ NODES_MODIFIER_BAKE_CUSTOM_PATH
@ NODES_MODIFIER_BAKE_CUSTOM_SIMULATION_FRAME_RANGE
bool BLI_path_abs(char path[FILE_MAX], const char *basepath) ATTR_NONNULL(1
void BKE_add_template_variables_general(bke::path_templates::VariableMap &variables, const ID *path_owner_id, const bke::BlenderProject *project)
auto BKE_blender_project_read_callback(const Main *bmain, Fn lambda)
const char * BKE_main_blendfile_path(const Main *bmain) ATTR_NONNULL()
Definition main.cc:1058
Vector< bke::path_templates::Error > BKE_path_apply_template(char *path, int path_maxncpy, const bke::path_templates::VariableMap &template_variables)
@ NODES_MODIFIER_BAKE_TARGET_PACKED
@ NODES_MODIFIER_BAKE_TARGET_INHERIT
void void void BLI_path_split_file_part(const char *filepath, char *file, size_t file_maxncpy) ATTR_NONNULL(1
bool BLI_path_is_rel(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
NodesModifierBakeTarget bake_target
NodesModifierRuntime * runtime
std::shared_ptr< bke::bake::ModifierCache > cache
Definition MOD_nodes.hh:64
struct RenderData r
static BakePath from_single_root(StringRefNull root_dir)
BakeNodeCache * get_bake_node_cache(const int id)
Map< int, std::unique_ptr< SimulationNodeCache > > simulation_cache_by_id
Map< int, std::unique_ptr< BakeNodeCache > > bake_cache_by_id
SimulationNodeCache * get_simulation_node_cache(const int id)
NodeBakeCache * get_node_bake_cache(const int id)
Vector< std::unique_ptr< FrameCache > > frames