Campbell Barton
c434782e3a
Use a shorter/simpler license convention, stops the header taking so much space. Follow the SPDX license specification: https://spdx.org/licenses - C/C++/objc/objc++ - Python - Shell Scripts - CMake, GNUmakefile While most of the source tree has been included - `./extern/` was left out. - `./intern/cycles` & `./intern/atomic` are also excluded because they use different header conventions. doc/license/SPDX-license-identifiers.txt has been added to list SPDX all used identifiers. See P2788 for the script that automated these edits. Reviewed By: brecht, mont29, sergey Ref D14069
273 lines
9.1 KiB
C++
273 lines
9.1 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2013 Blender Foundation. All rights reserved. */
|
|
|
|
/** \file
|
|
* \ingroup depsgraph
|
|
*
|
|
* Public API for Depsgraph
|
|
*
|
|
* Dependency Graph
|
|
* ================
|
|
*
|
|
* The dependency graph tracks relations between various pieces of data in
|
|
* a Blender file, but mainly just those which make up scene data. It is used
|
|
* to determine the set of operations need to ensure that all data has been
|
|
* correctly evaluated in response to changes, based on dependencies and visibility
|
|
* of affected data.
|
|
* Evaluation Engine
|
|
* =================
|
|
*
|
|
* The evaluation takes the operation-nodes the Depsgraph has tagged for updating,
|
|
* and schedules them up for being evaluated/executed such that the all dependency
|
|
* relationship constraints are satisfied.
|
|
*/
|
|
|
|
/* ************************************************* */
|
|
/* 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 */
|
|
typedef struct Depsgraph Depsgraph;
|
|
|
|
/* ------------------------------------------------ */
|
|
|
|
struct Main;
|
|
|
|
struct Scene;
|
|
struct ViewLayer;
|
|
|
|
typedef enum eEvaluationMode {
|
|
DAG_EVAL_VIEWPORT = 0, /* evaluate for OpenGL viewport */
|
|
DAG_EVAL_RENDER = 1, /* evaluate for render purposes */
|
|
} eEvaluationMode;
|
|
|
|
/* 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),
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* ************************************************ */
|
|
/* Depsgraph API */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name CRUD
|
|
* \{ */
|
|
|
|
/* Get main depsgraph instance from context! */
|
|
|
|
/**
|
|
* Create new Depsgraph instance.
|
|
*
|
|
* TODO: what arguments are needed here? What's the building-graph entry point?
|
|
*/
|
|
Depsgraph *DEG_graph_new(struct Main *bmain,
|
|
struct Scene *scene,
|
|
struct ViewLayer *view_layer,
|
|
eEvaluationMode mode);
|
|
|
|
/**
|
|
* Replace the "owner" pointers (currently Main/Scene/ViewLayer) of this depsgraph.
|
|
* Used for:
|
|
* - Undo steps when we do want to re-use the old depsgraph data as much as possible.
|
|
* - Rendering where we want to re-use objects between different view layers.
|
|
*/
|
|
void DEG_graph_replace_owners(struct Depsgraph *depsgraph,
|
|
struct Main *bmain,
|
|
struct Scene *scene,
|
|
struct ViewLayer *view_layer);
|
|
|
|
/** Free graph's contents and graph itself. */
|
|
void DEG_graph_free(Depsgraph *graph);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Node Types Registry
|
|
* \{ */
|
|
|
|
/** Register all node types. */
|
|
void DEG_register_node_types(void);
|
|
|
|
/** Free node type registry on exit. */
|
|
void DEG_free_node_types(void);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Update Tagging
|
|
* \{ */
|
|
|
|
/** Tag dependency graph for updates when visible scenes/layers changes. */
|
|
void DEG_graph_tag_on_visible_update(Depsgraph *depsgraph, bool do_time);
|
|
|
|
/** Tag all dependency graphs for update when visible scenes/layers changes. */
|
|
void DEG_tag_on_visible_update(struct Main *bmain, bool do_time);
|
|
|
|
/**
|
|
* \note Will return NULL if the flag is not known, allowing to gracefully handle situations
|
|
* when recalc flag has been removed.
|
|
*/
|
|
const char *DEG_update_tag_as_string(IDRecalcFlag flag);
|
|
|
|
/** Tag given ID for an update in all the dependency graphs. */
|
|
void DEG_id_tag_update(struct ID *id, int flag);
|
|
void DEG_id_tag_update_ex(struct Main *bmain, struct ID *id, int flag);
|
|
|
|
void DEG_graph_id_tag_update(struct Main *bmain,
|
|
struct Depsgraph *depsgraph,
|
|
struct ID *id,
|
|
int flag);
|
|
|
|
/** Tag all dependency graphs when time has changed. */
|
|
void DEG_time_tag_update(struct Main *bmain);
|
|
|
|
/** Tag a dependency graph when time has changed. */
|
|
void DEG_graph_time_tag_update(struct Depsgraph *depsgraph);
|
|
|
|
/**
|
|
* Mark a particular data-block type as having changing.
|
|
* This does not cause any updates but is used by external
|
|
* render engines to detect if for example a data-block was removed.
|
|
*/
|
|
void DEG_graph_id_type_tag(struct Depsgraph *depsgraph, short id_type);
|
|
void DEG_id_type_tag(struct Main *bmain, short id_type);
|
|
|
|
/**
|
|
* Set a depsgraph to flush updates to editors. This would be done
|
|
* for viewport depsgraphs, but not render or export depsgraph for example.
|
|
*/
|
|
void DEG_enable_editors_update(struct Depsgraph *depsgraph);
|
|
|
|
/** Check if something was changed in the database and inform editors about this. */
|
|
void DEG_editors_update(struct Depsgraph *depsgraph, bool time);
|
|
|
|
/** Clear recalc flags after editors or renderers have handled updates. */
|
|
void DEG_ids_clear_recalc(Depsgraph *depsgraph, bool backup);
|
|
|
|
/**
|
|
* Restore recalc flags, backed up by a previous call to #DEG_ids_clear_recalc.
|
|
* This also clears the backup.
|
|
*/
|
|
void DEG_ids_restore_recalc(Depsgraph *depsgraph);
|
|
|
|
/** \} */
|
|
|
|
/* ************************************************ */
|
|
/* Evaluation Engine API */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Graph Evaluation
|
|
* \{ */
|
|
|
|
/**
|
|
* Frame changed recalculation entry point.
|
|
*
|
|
* \note The frame-change happened for root scene that graph belongs to.
|
|
*/
|
|
void DEG_evaluate_on_framechange(Depsgraph *graph, float frame);
|
|
|
|
/**
|
|
* Data changed recalculation entry point.
|
|
* Evaluate all nodes tagged for updating.
|
|
*/
|
|
void DEG_evaluate_on_refresh(Depsgraph *graph);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Editors Integration
|
|
*
|
|
* Mechanism to allow editors to be informed of depsgraph updates,
|
|
* to do their own updates based on changes.
|
|
* \{ */
|
|
|
|
typedef struct DEGEditorUpdateContext {
|
|
struct Main *bmain;
|
|
struct Depsgraph *depsgraph;
|
|
struct Scene *scene;
|
|
struct ViewLayer *view_layer;
|
|
} DEGEditorUpdateContext;
|
|
|
|
typedef void (*DEG_EditorUpdateIDCb)(const DEGEditorUpdateContext *update_ctx, struct ID *id);
|
|
typedef void (*DEG_EditorUpdateSceneCb)(const DEGEditorUpdateContext *update_ctx, bool updated);
|
|
|
|
/** Set callbacks which are being called when depsgraph changes. */
|
|
void DEG_editors_set_update_cb(DEG_EditorUpdateIDCb id_func, DEG_EditorUpdateSceneCb scene_func);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Evaluation
|
|
* \{ */
|
|
|
|
bool DEG_is_evaluating(const struct Depsgraph *depsgraph);
|
|
|
|
bool DEG_is_active(const struct Depsgraph *depsgraph);
|
|
void DEG_make_active(struct Depsgraph *depsgraph);
|
|
void DEG_make_inactive(struct Depsgraph *depsgraph);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Evaluation Debug
|
|
* \{ */
|
|
|
|
void DEG_debug_print_begin(struct Depsgraph *depsgraph);
|
|
|
|
void DEG_debug_print_eval(struct Depsgraph *depsgraph,
|
|
const char *function_name,
|
|
const char *object_name,
|
|
const void *object_address);
|
|
|
|
void DEG_debug_print_eval_subdata(struct 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(struct 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(struct 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(struct Depsgraph *depsgraph,
|
|
const char *function_name,
|
|
const char *object_name,
|
|
const void *object_address,
|
|
float time);
|
|
|
|
/** \} */
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|