DEG_depsgraph_query.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2013 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_function_ref.hh"
#include "BLI_iterator.h"
#include "BLI_set.hh"
#include "BLI_utildefines.h"
 
#include "DEG_depsgraph.hh"
#include "DEG_depsgraph_build.hh"
 
/* Needed for the instance iterator. */
#include "DNA_object_types.h"
 
#include "BKE_object_types.hh"
 
struct BLI_Iterator;
struct CustomData_MeshMasks;
struct Depsgraph;
struct DupliObject;
struct ID;
struct ListBase;
struct PointerRNA;
struct Scene;
struct ViewLayer;
struct ViewerPath;
 
/* -------------------------------------------------------------------- */

Scene *DEG_get_input_scene(const Depsgraph *graph);

ViewLayer *DEG_get_input_view_layer(const Depsgraph *graph);

Main *DEG_get_bmain(const Depsgraph *graph);

eEvaluationMode DEG_get_mode(const Depsgraph *graph);

float DEG_get_ctime(const Depsgraph *graph);

 
/* -------------------------------------------------------------------- */

bool DEG_id_type_updated(const Depsgraph *depsgraph, short id_type);
bool DEG_id_type_any_updated(const Depsgraph *depsgraph);

bool DEG_id_type_any_exists(const Depsgraph *depsgraph, short id_type);

uint32_t DEG_get_eval_flags_for_id(const Depsgraph *graph, const ID *id);

void DEG_get_customdata_mask_for_object(const Depsgraph *graph,
                                        Object *object,
                                        CustomData_MeshMasks *r_mask);

Scene *DEG_get_evaluated_scene(const Depsgraph *graph);

ViewLayer *DEG_get_evaluated_view_layer(const Depsgraph *graph);

ID *DEG_get_evaluated_id(const Depsgraph *depsgraph, ID *id);
const ID *DEG_get_evaluated_id(const Depsgraph *depsgraph, const ID *id);
 
template<typename T> T *DEG_get_evaluated(const Depsgraph *depsgraph, T *id)
{
  static_assert(blender::dna::is_ID_v<T>);
  return reinterpret_cast<T *>(DEG_get_evaluated_id(depsgraph, reinterpret_cast<ID *>(id)));
}
 
template<typename T> const T *DEG_get_evaluated(const Depsgraph *depsgraph, const T *id)
{
  static_assert(blender::dna::is_ID_v<T>);
  return reinterpret_cast<const T *>(
      DEG_get_evaluated_id(depsgraph, reinterpret_cast<const ID *>(id)));
}

void DEG_get_evaluated_rna_pointer(const Depsgraph *depsgraph,
                                   PointerRNA *ptr,
                                   PointerRNA *r_ptr_eval);

ID *DEG_get_original_id(ID *id);
const ID *DEG_get_original_id(const ID *id);
 
template<typename T> T *DEG_get_original(T *id)
{
  static_assert(blender::dna::is_ID_v<T>);
  return reinterpret_cast<T *>(DEG_get_original_id(reinterpret_cast<ID *>(id)));
}
 
template<typename T> const T *DEG_get_original(const T *id)
{
  static_assert(blender::dna::is_ID_v<T>);
  return reinterpret_cast<const T *>(DEG_get_original_id(reinterpret_cast<const ID *>(id)));
}

Depsgraph *DEG_get_depsgraph_by_id(const ID &id);

bool DEG_is_original_id(const ID *id);
 
template<typename T> bool DEG_is_original(const T *id)
{
  static_assert(blender::dna::is_ID_v<T>);
  return DEG_is_original_id(reinterpret_cast<const ID *>(id));
}
 
/* Opposite of the above (`DEG_is_original_*`).
 *
 * If the data-block is not original it must be evaluated, and vice versa. */
 
bool DEG_is_evaluated_id(const ID *id);
 
template<typename T> bool DEG_is_evaluated(const T *id)
{
  static_assert(blender::dna::is_ID_v<T>);
  return DEG_is_evaluated_id(reinterpret_cast<const ID *>(id));
}

bool DEG_is_fully_evaluated(const Depsgraph *depsgraph);

bool DEG_id_is_fully_evaluated(const Depsgraph *depsgraph, const ID *id_eval);

bool DEG_object_geometry_is_evaluated(const Object &object);

bool DEG_object_transform_is_evaluated(const Object &object);

bool DEG_collection_geometry_is_evaluated(const Collection &collection);

 
/* -------------------------------------------------------------------- */
 
enum DegIterFlag {
  DEG_ITER_OBJECT_FLAG_LINKED_DIRECTLY = (1 << 0),
  DEG_ITER_OBJECT_FLAG_LINKED_INDIRECTLY = (1 << 1),
  DEG_ITER_OBJECT_FLAG_LINKED_VIA_SET = (1 << 2),
  DEG_ITER_OBJECT_FLAG_VISIBLE = (1 << 3),
  DEG_ITER_OBJECT_FLAG_DUPLI = (1 << 4),
};
ENUM_OPERATORS(DegIterFlag, DEG_ITER_OBJECT_FLAG_DUPLI)
 
struct DEGObjectIterSettings {
  Depsgraph *depsgraph;
  uint32_t flags;

  const ViewerPath *viewer_path;

  blender::Set<const Object *> *included_objects;
};

#define DEG_OBJECT_ITER_FOR_RENDER_ENGINE_FLAGS \
  DEG_ITER_OBJECT_FLAG_LINKED_DIRECTLY | DEG_ITER_OBJECT_FLAG_LINKED_VIA_SET | \
      DEG_ITER_OBJECT_FLAG_VISIBLE | DEG_ITER_OBJECT_FLAG_DUPLI
 
struct DEGObjectIterData {
  DEGObjectIterSettings *settings;
  Depsgraph *graph;
  int flag;
 
  Scene *scene;
 
  eEvaluationMode eval_mode;

  Object *object_orig_with_preview;
 
  Object *next_object;
 
  /* **** Iteration over dupli-list. *** */
 
  /* Object which created the dupli-list. */
  Object *dupli_parent;
  /* List of duplicated objects. */
  ListBase *dupli_list;
  /* Next duplicated object to step into. */
  DupliObject *dupli_object_next;
  /* Corresponds to current object: current iterator object is evaluated from
   * this duplicated object. */
  DupliObject *dupli_object_current;
  /* Temporary storage to report fully populated DNA to the render engine or
   * other users of the iterator. */
  Object temp_dupli_object;
  blender::bke::ObjectRuntime temp_dupli_object_runtime;
 
  /* **** Iteration over ID nodes **** */
  size_t id_node_index;
  size_t num_id_nodes;
  DEGObjectIterData &operator=(const DEGObjectIterData &other);
};
 
void DEG_iterator_objects_begin(BLI_Iterator *iter, DEGObjectIterData *data);
void DEG_iterator_objects_next(BLI_Iterator *iter);
void DEG_iterator_objects_end(BLI_Iterator *iter);
 
#define DEG_OBJECT_ITER_BEGIN(settings_, instance_) \
  { \
    DEGObjectIterData data_ = { \
        (settings_), \
        (settings_)->depsgraph, \
        (int)(settings_)->flags, \
    }; \
\
    ITER_BEGIN (DEG_iterator_objects_begin, \
                DEG_iterator_objects_next, \
                DEG_iterator_objects_end, \
                &data_, \
                Object *, \
                instance_)
 
#define DEG_OBJECT_ITER_END \
  ITER_END; \
  } \
  ((void)0)

 
/* -------------------------------------------------------------------- */
 
struct DEGIDIterData {
  Depsgraph *graph;
  bool only_updated;
 
  size_t id_node_index;
  size_t num_id_nodes;
};
 
void DEG_iterator_ids_begin(BLI_Iterator *iter, DEGIDIterData *data);
void DEG_iterator_ids_next(BLI_Iterator *iter);
void DEG_iterator_ids_end(BLI_Iterator *iter);

 
/* -------------------------------------------------------------------- */
 
using DEGForeachIDCallback = blender::FunctionRef<void(ID *id)>;
using DEGForeachIDComponentCallback =
    blender::FunctionRef<void(ID *id, eDepsObjectComponentType component)>;

void DEG_foreach_ancestor_ID(const Depsgraph *depsgraph,
                             const ID *id,
                             DEGForeachIDCallback callback);
void DEG_foreach_dependent_ID(const Depsgraph *depsgraph,
                              const ID *id,
                              DEGForeachIDCallback callback);

enum {
  /* Ignore transform solvers which depends on multiple inputs and affects final transform.
   * Is used for cases like snapping objects which are part of a rigid body simulation:
   * without this there will be "false-positive" dependencies between transform components of
   * objects:
   *
   *     object 1 transform before solver ---> solver ------> object 1 final transform
   *     object 2 transform before solver -----^     \------> object 2 final transform
   */
  DEG_FOREACH_COMPONENT_IGNORE_TRANSFORM_SOLVERS = (1 << 0),
};
void DEG_foreach_dependent_ID_component(const Depsgraph *depsgraph,
                                        const ID *id,
                                        eDepsObjectComponentType source_component_type,
                                        int flags,
                                        DEGForeachIDComponentCallback callback);
 
void DEG_foreach_ID(const Depsgraph *depsgraph, DEGForeachIDCallback callback);