Sergey Sharybin
26bc584e01
The ID is not modified by this function, so it can be const. Needed to tweak const correctness for original ID accessor as well. Additionally, did the same for accessor of evaluated ID for symmetry.
284 lines
9.2 KiB
C++
284 lines
9.2 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2013 Blender Foundation. All rights reserved. */
|
|
|
|
/** \file
|
|
* \ingroup depsgraph
|
|
*
|
|
* Public API for Querying Depsgraph.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "BLI_iterator.h"
|
|
|
|
#include "DEG_depsgraph.h"
|
|
#include "DEG_depsgraph_build.h"
|
|
|
|
/* Needed for the instance iterator. */
|
|
#include "DNA_object_types.h"
|
|
|
|
struct BLI_Iterator;
|
|
struct CustomData_MeshMasks;
|
|
struct Depsgraph;
|
|
struct DupliObject;
|
|
struct ID;
|
|
struct ListBase;
|
|
struct PointerRNA;
|
|
struct Scene;
|
|
struct ViewLayer;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name DEG input data
|
|
* \{ */
|
|
|
|
/** Get scene that depsgraph was built for. */
|
|
struct Scene *DEG_get_input_scene(const Depsgraph *graph);
|
|
|
|
/** Get view layer that depsgraph was built for. */
|
|
struct ViewLayer *DEG_get_input_view_layer(const Depsgraph *graph);
|
|
|
|
/** Get bmain that depsgraph was built for. */
|
|
struct Main *DEG_get_bmain(const Depsgraph *graph);
|
|
|
|
/** Get evaluation mode that depsgraph was built for. */
|
|
eEvaluationMode DEG_get_mode(const Depsgraph *graph);
|
|
|
|
/** Get time that depsgraph is being evaluated or was last evaluated at. */
|
|
float DEG_get_ctime(const Depsgraph *graph);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name DEG evaluated data
|
|
* \{ */
|
|
|
|
/** Check if given ID type was tagged for update. */
|
|
bool DEG_id_type_updated(const struct Depsgraph *depsgraph, short id_type);
|
|
bool DEG_id_type_any_updated(const struct Depsgraph *depsgraph);
|
|
|
|
/** Check if given ID type is present in the depsgraph */
|
|
bool DEG_id_type_any_exists(const struct Depsgraph *depsgraph, short id_type);
|
|
|
|
/** Get additional evaluation flags for the given ID. */
|
|
uint32_t DEG_get_eval_flags_for_id(const struct Depsgraph *graph, const struct ID *id);
|
|
|
|
/** Get additional mesh CustomData_MeshMasks flags for the given object. */
|
|
void DEG_get_customdata_mask_for_object(const struct Depsgraph *graph,
|
|
struct Object *object,
|
|
struct CustomData_MeshMasks *r_mask);
|
|
|
|
/**
|
|
* Get scene at its evaluated state.
|
|
*
|
|
* Technically, this is a copied-on-written and fully evaluated version of the input scene.
|
|
* This function will check that the data-block has been expanded (and copied) from the original
|
|
* one. Assert will happen if it's not.
|
|
*/
|
|
struct Scene *DEG_get_evaluated_scene(const struct Depsgraph *graph);
|
|
|
|
/**
|
|
* Get view layer at its evaluated state.
|
|
* This is a shortcut for accessing active view layer from evaluated scene.
|
|
*/
|
|
struct ViewLayer *DEG_get_evaluated_view_layer(const struct Depsgraph *graph);
|
|
|
|
/** Get evaluated version of object for given original one. */
|
|
struct Object *DEG_get_evaluated_object(const struct Depsgraph *depsgraph, struct Object *object);
|
|
|
|
/** Get evaluated version of given ID data-block. */
|
|
struct ID *DEG_get_evaluated_id(const struct Depsgraph *depsgraph, struct ID *id);
|
|
|
|
/** Get evaluated version of data pointed to by RNA pointer */
|
|
void DEG_get_evaluated_rna_pointer(const struct Depsgraph *depsgraph,
|
|
struct PointerRNA *ptr,
|
|
struct PointerRNA *r_ptr_eval);
|
|
|
|
/** Get original version of object for given evaluated one. */
|
|
struct Object *DEG_get_original_object(struct Object *object);
|
|
|
|
/** Get original version of given evaluated ID data-block. */
|
|
struct ID *DEG_get_original_id(struct ID *id);
|
|
|
|
/**
|
|
* Check whether given ID is an original,
|
|
*
|
|
* Original IDs are considered all the IDs which are not covered by copy-on-write system and are
|
|
* not out-of-main localized data-blocks.
|
|
*/
|
|
bool DEG_is_original_id(const struct ID *id);
|
|
bool DEG_is_original_object(const struct Object *object);
|
|
|
|
/* Opposite of the above.
|
|
*
|
|
* If the data-block is not original it must be evaluated, and vice versa. */
|
|
|
|
bool DEG_is_evaluated_id(const struct ID *id);
|
|
bool DEG_is_evaluated_object(const struct Object *object);
|
|
|
|
/**
|
|
* Check whether depsgraph is fully evaluated. This includes the following checks:
|
|
* - Relations are up-to-date.
|
|
* - Nothing is tagged for update.
|
|
*/
|
|
bool DEG_is_fully_evaluated(const struct Depsgraph *depsgraph);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name DEG object iterators
|
|
* \{ */
|
|
|
|
enum {
|
|
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),
|
|
};
|
|
|
|
typedef struct DEGObjectIterData {
|
|
struct Depsgraph *graph;
|
|
int flag;
|
|
|
|
struct Scene *scene;
|
|
|
|
eEvaluationMode eval_mode;
|
|
|
|
struct Object *next_object;
|
|
|
|
/* **** Iteration over dupli-list. *** */
|
|
|
|
/* Object which created the dupli-list. */
|
|
struct Object *dupli_parent;
|
|
/* List of duplicated objects. */
|
|
struct ListBase *dupli_list;
|
|
/* Next duplicated object to step into. */
|
|
struct DupliObject *dupli_object_next;
|
|
/* Corresponds to current object: current iterator object is evaluated from
|
|
* this duplicated object. */
|
|
struct DupliObject *dupli_object_current;
|
|
/* Temporary storage to report fully populated DNA to the render engine or
|
|
* other users of the iterator. */
|
|
struct Object temp_dupli_object;
|
|
|
|
/* **** Iteration over ID nodes **** */
|
|
size_t id_node_index;
|
|
size_t num_id_nodes;
|
|
} DEGObjectIterData;
|
|
|
|
void DEG_iterator_objects_begin(struct BLI_Iterator *iter, DEGObjectIterData *data);
|
|
void DEG_iterator_objects_next(struct BLI_Iterator *iter);
|
|
void DEG_iterator_objects_end(struct BLI_Iterator *iter);
|
|
|
|
/**
|
|
* NOTE: Be careful with DEG_ITER_OBJECT_FLAG_LINKED_INDIRECTLY objects.
|
|
* Although they are available they have no overrides (collection_properties)
|
|
* and will crash if you try to access it.
|
|
*/
|
|
#define DEG_OBJECT_ITER_BEGIN(graph_, instance_, flag_) \
|
|
{ \
|
|
DEGObjectIterData data_ = { \
|
|
graph_, \
|
|
flag_, \
|
|
}; \
|
|
\
|
|
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)
|
|
|
|
/**
|
|
* Depsgraph objects iterator for draw manager and final render
|
|
*/
|
|
#define DEG_OBJECT_ITER_FOR_RENDER_ENGINE_BEGIN(graph_, instance_) \
|
|
DEG_OBJECT_ITER_BEGIN (graph_, \
|
|
instance_, \
|
|
DEG_ITER_OBJECT_FLAG_LINKED_DIRECTLY | \
|
|
DEG_ITER_OBJECT_FLAG_LINKED_VIA_SET | DEG_ITER_OBJECT_FLAG_VISIBLE | \
|
|
DEG_ITER_OBJECT_FLAG_DUPLI)
|
|
|
|
#define DEG_OBJECT_ITER_FOR_RENDER_ENGINE_END DEG_OBJECT_ITER_END
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name DEG ID iterators
|
|
* \{ */
|
|
|
|
typedef struct DEGIDIterData {
|
|
struct Depsgraph *graph;
|
|
bool only_updated;
|
|
|
|
size_t id_node_index;
|
|
size_t num_id_nodes;
|
|
} DEGIDIterData;
|
|
|
|
void DEG_iterator_ids_begin(struct BLI_Iterator *iter, DEGIDIterData *data);
|
|
void DEG_iterator_ids_next(struct BLI_Iterator *iter);
|
|
void DEG_iterator_ids_end(struct BLI_Iterator *iter);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name DEG traversal
|
|
* \{ */
|
|
|
|
typedef void (*DEGForeachIDCallback)(ID *id, void *user_data);
|
|
typedef void (*DEGForeachIDComponentCallback)(ID *id,
|
|
eDepsObjectComponentType component,
|
|
void *user_data);
|
|
|
|
/**
|
|
* \note Modifies runtime flags in depsgraph nodes,
|
|
* so can not be used in parallel. Keep an eye on that!
|
|
*/
|
|
void DEG_foreach_ancestor_ID(const Depsgraph *depsgraph,
|
|
const ID *id,
|
|
DEGForeachIDCallback callback,
|
|
void *user_data);
|
|
void DEG_foreach_dependent_ID(const Depsgraph *depsgraph,
|
|
const ID *id,
|
|
DEGForeachIDCallback callback,
|
|
void *user_data);
|
|
|
|
/**
|
|
* Starts traversal from given component of the given ID, invokes callback for every other
|
|
* component which is directly on indirectly dependent on the source one.
|
|
*/
|
|
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 *user_data);
|
|
|
|
void DEG_foreach_ID(const Depsgraph *depsgraph, DEGForeachIDCallback callback, void *user_data);
|
|
|
|
/** \} */
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|