DEG_depsgraph.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2013 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
/* ************************************************* */
/* Forward-defined typedefs for core types
 * - These are used in all depsgraph code and by all callers of Depsgraph API...
 */
 
#pragma once
 
#include "DNA_ID.h"
 
/* Dependency Graph */
struct Depsgraph;
 
/* ------------------------------------------------ */
 
struct Main;
struct Scene;
struct ViewLayer;
 
enum eEvaluationMode {
  DAG_EVAL_VIEWPORT = 0, /* evaluate for OpenGL viewport */
  DAG_EVAL_RENDER = 1,   /* evaluate for render purposes */
};
 
/* DagNode->eval_flags */
enum {
  /* Regardless to curve->path animation flag path is to be evaluated anyway,
   * to meet dependencies with such a things as curve modifier and other guys
   * who're using curve deform, where_on_path and so. */
  DAG_EVAL_NEED_CURVE_PATH = (1 << 0),
  /* A shrinkwrap modifier or constraint targeting this mesh needs information
   * about non-manifold boundary edges for the Target Normal Project mode. */
  DAG_EVAL_NEED_SHRINKWRAP_BOUNDARY = (1 << 1),
};
 
/* ************************************************ */
/* Depsgraph API */
 
/* -------------------------------------------------------------------- */
/* Get main depsgraph instance from context! */
 
Depsgraph *DEG_graph_new(Main *bmain, Scene *scene, ViewLayer *view_layer, eEvaluationMode mode);
 
void DEG_graph_replace_owners(Depsgraph *depsgraph,
                              Main *bmain,
                              Scene *scene,
                              ViewLayer *view_layer);
 
void DEG_graph_free(Depsgraph *graph);
 
/* -------------------------------------------------------------------- */
void DEG_register_node_types();
 
void DEG_free_node_types();
 
/* -------------------------------------------------------------------- */
void DEG_graph_tag_on_visible_update(Depsgraph *depsgraph, bool do_time);
 
void DEG_tag_on_visible_update(Main *bmain, bool do_time);
 
const char *DEG_update_tag_as_string(IDRecalcFlag flag);
 
void DEG_id_tag_update(ID *id, unsigned int flags);
void DEG_id_tag_update_ex(Main *bmain, ID *id, unsigned int flags);
 
void DEG_graph_id_tag_update(Main *bmain, Depsgraph *depsgraph, ID *id, unsigned int flags);
 
void DEG_id_tag_update_for_side_effect_request(Depsgraph *depsgraph, ID *id, unsigned int flags);
 
void DEG_time_tag_update(Main *bmain);
 
void DEG_graph_time_tag_update(Depsgraph *depsgraph);
 
void DEG_graph_id_type_tag(Depsgraph *depsgraph, short id_type);
void DEG_id_type_tag(Main *bmain, short id_type);
 
void DEG_enable_editors_update(Depsgraph *depsgraph);
 
void DEG_editors_update(Depsgraph *depsgraph, bool time);
 
void DEG_ids_clear_recalc(Depsgraph *depsgraph, bool backup);
 
void DEG_ids_restore_recalc(Depsgraph *depsgraph);
 
/* ************************************************ */
/* Evaluation Engine API */
 
/* -------------------------------------------------------------------- */
enum DepsgraphEvaluateSyncWriteback {
  DEG_EVALUATE_SYNC_WRITEBACK_NO,
  DEG_EVALUATE_SYNC_WRITEBACK_YES,
};
 
void DEG_evaluate_on_framechange(
    Depsgraph *graph,
    float frame,
    DepsgraphEvaluateSyncWriteback sync_writeback = DEG_EVALUATE_SYNC_WRITEBACK_NO);
 
void DEG_evaluate_on_refresh(
    Depsgraph *graph,
    DepsgraphEvaluateSyncWriteback sync_writeback = DEG_EVALUATE_SYNC_WRITEBACK_NO);
 
/* -------------------------------------------------------------------- */
struct DEGEditorUpdateContext {
  Main *bmain;
  Depsgraph *depsgraph;
  Scene *scene;
  ViewLayer *view_layer;
};
 
using DEG_EditorUpdateIDCb = void (*)(const DEGEditorUpdateContext *update_ctx, ID *id);
using DEG_EditorUpdateSceneCb = void (*)(const DEGEditorUpdateContext *update_ctx, bool updated);
 
void DEG_editors_set_update_cb(DEG_EditorUpdateIDCb id_func, DEG_EditorUpdateSceneCb scene_func);
 
/* -------------------------------------------------------------------- */
bool DEG_is_evaluating(const Depsgraph *depsgraph);
 
bool DEG_is_active(const Depsgraph *depsgraph);
void DEG_make_active(Depsgraph *depsgraph);
void DEG_make_inactive(Depsgraph *depsgraph);
 
/* Returns the number of times the graph has been evaluated. */
uint64_t DEG_get_update_count(const Depsgraph *depsgraph);
 
void DEG_disable_visibility_optimization(Depsgraph *depsgraph);
 
/* -------------------------------------------------------------------- */
void DEG_debug_print_begin(Depsgraph *depsgraph);
 
void DEG_debug_print_eval(Depsgraph *depsgraph,
                          const char *function_name,
                          const char *object_name,
                          const void *object_address);
 
void DEG_debug_print_eval_subdata(Depsgraph *depsgraph,
                                  const char *function_name,
                                  const char *object_name,
                                  const void *object_address,
                                  const char *subdata_comment,
                                  const char *subdata_name,
                                  const void *subdata_address);
 
void DEG_debug_print_eval_subdata_index(Depsgraph *depsgraph,
                                        const char *function_name,
                                        const char *object_name,
                                        const void *object_address,
                                        const char *subdata_comment,
                                        const char *subdata_name,
                                        const void *subdata_address,
                                        int subdata_index);
 
void DEG_debug_print_eval_parent_typed(Depsgraph *depsgraph,
                                       const char *function_name,
                                       const char *object_name,
                                       const void *object_address,
                                       const char *parent_comment,
                                       const char *parent_name,
                                       const void *parent_address);
 
void DEG_debug_print_eval_time(Depsgraph *depsgraph,
                               const char *function_name,
                               const char *object_name,
                               const void *object_address,
                               float time);