BKE_bake_geometry_nodes_modifier.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_mutex.hh"
#include "BLI_sub_frame.hh"
 
#include "BKE_bake_items.hh"
#include "BKE_bake_items_paths.hh"
#include "BKE_bake_items_serialize.hh"
 
#include "DNA_modifier_types.h"
 
struct NodesModifierData;
struct Main;
struct Object;
struct Scene;
 
namespace blender::bke::bake {
 
enum class CacheStatus {
  Valid,
  Invalid,
  Baked,
};

struct FrameCache {
  SubFrame frame;
  BakeState state;
  std::optional<std::variant<std::string, Span<std::byte>>> meta_data_source;
};

struct PrevCache {
  BakeState state;
  SubFrame frame;
};

struct NodeBakeCache {
  Vector<std::unique_ptr<FrameCache>> frames;

  std::unique_ptr<MemoryBlobReader> memory_blob_reader;
  std::optional<std::string> blobs_dir;

  std::unique_ptr<BlobReadSharing> blob_sharing;
  bool failed_finding_bake = false;

  IndexRange frame_range() const;
 
  void reset();
};
 
struct SimulationNodeCache {
  NodeBakeCache bake;
 
  CacheStatus cache_status = CacheStatus::Valid;

  std::optional<PrevCache> prev_cache;
 
  void reset();
};
 
struct BakeNodeCache {
  NodeBakeCache bake;
 
  void reset();
};
 
struct ModifierCache {
  mutable Mutex mutex;
  Set<int> requested_bakes;
  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);
  BakeNodeCache *get_bake_node_cache(const int id);
  NodeBakeCache *get_node_bake_cache(const int id);
 
  void reset_cache(int id);
};

void scene_simulation_states_reset(Scene &scene);
 
std::optional<NodesModifierBakeTarget> get_node_bake_target(const Object &object,
                                                            const NodesModifierData &nmd,
                                                            int node_id);
std::optional<BakePath> get_node_bake_path(const Main &bmain,
                                           const Object &object,
                                           const NodesModifierData &nmd,
                                           int node_id);
std::optional<IndexRange> get_node_bake_frame_range(const Scene &scene,
                                                    const Object &object,
                                                    const NodesModifierData &nmd,
                                                    int node_id);
std::optional<std::string> get_modifier_bake_path(const Main &bmain,
                                                  const Object &object,
                                                  const NodesModifierData &nmd);

std::string get_default_modifier_bake_directory(const Main &bmain,
                                                const Object &object,
                                                const NodesModifierData &nmd);
std::string get_default_node_bake_directory(const Main &bmain,
                                            const Object &object,
                                            const NodesModifierData &nmd,
                                            int node_id);
 
}  // namespace blender::bke::bake