diff options
Diffstat (limited to 'source/blender/depsgraph/DEG_depsgraph_query.h')
| -rw-r--r-- | source/blender/depsgraph/DEG_depsgraph_query.h | 150 |
1 files changed, 148 insertions, 2 deletions
diff --git a/source/blender/depsgraph/DEG_depsgraph_query.h b/source/blender/depsgraph/DEG_depsgraph_query.h index f8cfb407831..1c4e11d1197 100644 --- a/source/blender/depsgraph/DEG_depsgraph_query.h +++ b/source/blender/depsgraph/DEG_depsgraph_query.h @@ -33,19 +33,162 @@ #ifndef __DEG_DEPSGRAPH_QUERY_H__ #define __DEG_DEPSGRAPH_QUERY_H__ +#include "DEG_depsgraph.h" + struct ID; +struct Base; +struct BLI_Iterator; struct Depsgraph; +struct DupliObject; +struct ListBase; +struct Scene; +struct ViewLayer; #ifdef __cplusplus extern "C" { #endif +/* *********************** 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 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); + +/* ********************* DEG evaluated data ******************* */ + /* Check if given ID type was tagged for update. */ -bool DEG_id_type_tagged(struct Main *bmain, short idtype); +bool DEG_id_type_updated(const struct Depsgraph *depsgraph, short id_type); +bool DEG_id_type_any_updated(const struct Depsgraph *depsgraph); /* Get additional evaluation flags for the given ID. */ -short DEG_get_eval_flags_for_id(struct Depsgraph *graph, struct ID *id); +short DEG_get_eval_flags_for_id(const struct Depsgraph *graph, struct ID *id); + +/* Get scene the despgraph is created for. */ +struct Scene *DEG_get_evaluated_scene(const struct Depsgraph *graph); + +/* Get scene layer the despgraph is created for. */ +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 datablock. */ +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 datablock. */ +struct ID *DEG_get_original_id(struct ID *id); + +/* ************************ 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; + + int visibility_check; /* eObjectVisibilityCheck. */ + + /* **** 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 ober 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; \ + } + +/** + * 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 + + +/* ************************ 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); /* ************************ DEG traversal ********************* */ @@ -58,6 +201,9 @@ void DEG_foreach_dependent_ID(const Depsgraph *depsgraph, const ID *id, DEGForeachIDCallback callback, void *user_data); +void DEG_foreach_ID(const Depsgraph *depsgraph, + DEGForeachIDCallback callback, void *user_data); + #ifdef __cplusplus } /* extern "C" */ |