blender-archive/source/blender/depsgraph/DEG_depsgraph_query.h

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2013 Blender Foundation.
 * All rights reserved.
 *
 * Original Author: Joshua Leung
 * Contributor(s): Sergey Sharybin
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file blender/depsgraph/DEG_depsgraph_query.h
 *  \ingroup depsgraph
 *
 * Public API for Querying and Filtering Depsgraph.
 */

#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

/* Check if given ID type was tagged for update. */
bool DEG_id_type_tagged(struct Main *bmain, short id_type);

/* Get additional evaluation flags for the given 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);

/* ************************ DEG 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 enum eDepsObjectIteratorMode {
	DEG_ITER_OBJECT_MODE_VIEWPORT = 0,
	DEG_ITER_OBJECT_MODE_RENDER   = 1,
} eDepsObjectIteratorMode;

typedef struct DEGObjectIterData {
	struct Depsgraph *graph;
	struct Scene *scene;
	struct EvaluationContext eval_ctx;

	int flag;
	eDepsObjectIteratorMode mode;

	/* **** 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(graph_, instance_, mode_, flag_)                          \
	{                                                                             \
		DEGObjectIterData data_ = {                                               \
			.graph = (graph_),                                                    \
			.mode = (mode_),                                                      \
			.flag = (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(graph_, instance_, mode_) \
	DEG_OBJECT_ITER(graph_, instance_, mode_,                \
	        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 traversal ********************* */

typedef void (*DEGForeachIDCallback)(ID *id, 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_dependent_ID(const Depsgraph *depsgraph,
                              const ID *id,
                              DEGForeachIDCallback callback, void *user_data);


#ifdef __cplusplus
} /* extern "C" */
#endif

#endif  /* __DEG_DEPSGRAPH_QUERY_H__ */