diff options
Diffstat (limited to 'source/blender/depsgraph/DEG_depsgraph_query.h')
| -rw-r--r-- | source/blender/depsgraph/DEG_depsgraph_query.h | 94 |
1 files changed, 63 insertions, 31 deletions
diff --git a/source/blender/depsgraph/DEG_depsgraph_query.h b/source/blender/depsgraph/DEG_depsgraph_query.h index e9195a1eb26..ebb5f4d669c 100644 --- a/source/blender/depsgraph/DEG_depsgraph_query.h +++ b/source/blender/depsgraph/DEG_depsgraph_query.h @@ -47,87 +47,106 @@ struct ViewLayer; extern "C" { #endif -/* *********************** DEG input data ********************* */ +/* -------------------------------------------------------------------- */ +/** \name DEG input data + * \{ */ -/* Get scene that depsgraph was built for. */ +/** Get scene that depsgraph was built for. */ struct Scene *DEG_get_input_scene(const Depsgraph *graph); -/* Get view layer that depsgraph was built for. */ +/** 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. */ +/** Get bmain that depsgraph was built for. */ struct Main *DEG_get_bmain(const Depsgraph *graph); -/* Get evaluation mode that depsgraph was built for. */ +/** 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. */ +/** 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. */ +/* -------------------------------------------------------------------- */ +/** \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 */ +/** 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. */ +/** Get additional evaluation flags for the given ID. */ uint32_t DEG_get_eval_flags_for_id(const struct Depsgraph *graph, struct ID *id); -/* Get additional mesh CustomData_MeshMasks flags for the given object. */ +/** 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. +/** + * 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. */ + * 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. */ +/** + * 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. */ +/** 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. */ +/** 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 */ +/** 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. */ +/** 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. */ +/** 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, +/** + * 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. */ + * 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: +/** + * Check whether depsgraph is fully evaluated. This includes the following checks: * - Relations are up-to-date. - * - Nothing is tagged for update. */ + * - Nothing is tagged for update. + */ bool DEG_is_fully_evaluated(const struct Depsgraph *depsgraph); -/* ************************ DEG object iterators ********************* */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name DEG object iterators + * \{ */ enum { DEG_ITER_OBJECT_FLAG_LINKED_DIRECTLY = (1 << 0), @@ -207,7 +226,11 @@ void DEG_iterator_objects_end(struct BLI_Iterator *iter); #define DEG_OBJECT_ITER_FOR_RENDER_ENGINE_END DEG_OBJECT_ITER_END -/* ************************ DEG ID iterators ********************* */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name DEG ID iterators + * \{ */ typedef struct DEGIDIterData { struct Depsgraph *graph; @@ -221,15 +244,20 @@ 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 ********************* */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \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! +/** + * \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, @@ -240,8 +268,10 @@ void DEG_foreach_dependent_ID(const Depsgraph *depsgraph, 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. */ +/** + * 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: @@ -262,6 +292,8 @@ void DEG_foreach_dependent_ID_component(const Depsgraph *depsgraph, void DEG_foreach_ID(const Depsgraph *depsgraph, DEGForeachIDCallback callback, void *user_data); +/** \} */ + #ifdef __cplusplus } /* extern "C" */ #endif |