source/blender/depsgraph/DEG_depsgraph_query.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2013 Blender Foundation.
  19  * All rights reserved.
  20  *
  21  * Original Author: Joshua Leung
  22  * Contributor(s): Sergey Sharybin
  23  *
  24  * ***** END GPL LICENSE BLOCK *****
  25  */
  26
  27 /** \file blender/depsgraph/DEG_depsgraph_query.h
  28  *  \ingroup depsgraph
  29  *
  30  * Public API for Querying and Filtering Depsgraph.
  31  */
  32
  33 #ifndef __DEG_DEPSGRAPH_QUERY_H__
  34 #define __DEG_DEPSGRAPH_QUERY_H__
  35
  36 struct ID;
  37
  38 struct Depsgraph;
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /* Check if given ID type was tagged for update. */
  45 bool DEG_id_type_tagged(struct Main *bmain, short idtype);
  46
  47 /* Get additional evaluation flags for the given ID. */
  48 short DEG_get_eval_flags_for_id(struct Depsgraph *graph, struct ID *id);
  49
  50 /* ************************ DEG traversal ********************* */
  51
  52 typedef void (*DEGForeachIDCallback)(ID *id, void *user_data);
  53
  54 /* NOTE: Modifies runtime flags in depsgraph nodes, so can not be used in
  55  * parallel. Keep an eye on that!
  56  */
  57 void DEG_foreach_dependent_ID(const Depsgraph *depsgraph,
  58                               const ID *id,
  59                               DEGForeachIDCallback callback, void *user_data);
  60
  61
  62 #ifdef __cplusplus
  63 } /* extern "C" */
  64 #endif
  65
  66 #endif  /* __DEG_DEPSGRAPH_QUERY_H__ */