path: root/source/blender/depsgraph/intern/depsgraph_query.cc

/*
 * ***** 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): None Yet
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file blender/depsgraph/intern/depsgraph_query.cc
 *  \ingroup depsgraph
 *
 * Implementation of Querying and Filtering API's
 */

#include "MEM_guardedalloc.h"

extern "C" {
#include "BLI_utildefines.h"
#include "BLI_ghash.h"
#include "BLI_math.h"
#include "BKE_anim.h"
#include "BKE_idcode.h"
#include "BKE_layer.h"
#include "BKE_main.h"
#include "BLI_listbase.h"
} /* extern "C" */

#include "DNA_object_types.h"
#include "DNA_scene_types.h"

#include "DEG_depsgraph.h"
#include "DEG_depsgraph_query.h"

#include "intern/depsgraph_intern.h"
#include "util/deg_util_foreach.h"

#ifndef NDEBUG
#  include "intern/eval/deg_eval_copy_on_write.h"
#endif

bool DEG_id_type_tagged(Main *bmain, short id_type)
{
	return bmain->id_tag_update[BKE_idcode_to_index(id_type)] != 0;
}

short DEG_get_eval_flags_for_id(Depsgraph *graph, ID *id)
{
	if (graph == NULL) {
		/* Happens when converting objects to mesh from a python script
		 * after modifying scene graph.
		 *
		 * Currently harmless because it's only called for temporary
		 * objects which are out of the DAG anyway.
		 */
		return 0;
	}

	DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);

	DEG::IDDepsNode *id_node = deg_graph->find_id_node(id);
	if (id_node == NULL) {
		/* TODO(sergey): Does it mean we need to check set scene? */
		return 0;
	}

	return id_node->eval_flags;
}

Scene *DEG_get_evaluated_scene(Depsgraph *graph)
{
	DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
	Scene *scene_orig = deg_graph->scene;
	return reinterpret_cast<Scene *>(deg_graph->get_cow_id(&scene_orig->id));
}

SceneLayer *DEG_get_evaluated_scene_layer(Depsgraph *graph)
{
	DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
	Scene *scene_cow = DEG_get_evaluated_scene(graph);
	SceneLayer *scene_layer_orig = deg_graph->scene_layer;
	SceneLayer *scene_layer_cow =
	        (SceneLayer *)BLI_findstring(&scene_cow->render_layers,
	                                     scene_layer_orig->name,
	                                     offsetof(SceneLayer, name));
	return scene_layer_cow;
}

Object *DEG_get_evaluated_object(Depsgraph *depsgraph, Object *object)
{
	return (Object *)DEG_get_evaluated_id(depsgraph, &object->id);
}

ID *DEG_get_evaluated_id(struct Depsgraph *depsgraph, ID *id)
{
	/* TODO(sergey): This is a duplicate of Depsgraph::get_cow_id(),
	 * but here we never do assert, since we don't know nature of the
	 * incoming ID datablock.
	 */
	DEG::Depsgraph *deg_graph = (DEG::Depsgraph *)depsgraph;
	DEG::IDDepsNode *id_node = deg_graph->find_id_node(id);
	if (id_node == NULL) {
		return id;
	}
	return id_node->id_cow;
}

/* ************************ DEG ITERATORS ********************* */

/**
 * XXX (dfelinto/sergey) big hack, waiting for:
 * "Reshuffle collections base flags evaluation, make it so object is gathering its base flags from collections."
 *
 * Returns false if object shouldn't be found (which should never happen in the final implementation
 * and instead we should have a tag to the objects that were not directly part of the depsgraph).
 *
 * That means that the object is not in a collection but it's part of depsgraph, or the object is simply
 * not in the current SceneLayer - Depsgraph at the moment includes all the SceneLayer in the Scene.
 */
static bool deg_flush_base_flags_and_settings(
        DEGObjectsIteratorData *data, Object *ob_dst, Object *ob_src, const bool is_dupli)
{
	Base *base;
	Depsgraph *graph = data->graph;
	SceneLayer *scene_layer = data->eval_ctx.scene_layer;
	int flag = is_dupli ? BASE_FROMDUPLI : 0;

	/* First attempt, see if object is in the current SceneLayer. */
	base = (Base *)BLI_findptr(&scene_layer->object_bases, ob_src, offsetof(Base, object));

	/* Next attempt, see if object is in one of the sets. */
	if (base == NULL) {
		Scene *scene_iter, *scene = DEG_get_evaluated_scene(graph);
		scene_iter = scene;

		while ((scene_iter = (scene_iter)->set)) {
			SceneLayer *scene_layer_set = BKE_scene_layer_from_scene_get(scene_iter);
			base = (Base *)BLI_findptr(&scene_layer_set->object_bases, ob_src, offsetof(Base, object));
			if (base != NULL) {
				flag |= BASE_FROM_SET;
				flag &= ~(BASE_SELECTED | BASE_SELECTABLED);
				break;
			}
		}
	}

	if (base == NULL) {
		return false;
	}

	/* Make sure we have the base collection settings is already populated.
	 * This will fail when BKE_layer_eval_layer_collection_pre hasn't run yet
	 * Which usually means a missing call to DEG_id_tag_update(). */
	BLI_assert(!BLI_listbase_is_empty(&base->collection_properties->data.group));

	ob_dst->base_flag = base->flag | flag;
	ob_dst->base_collection_properties = base->collection_properties;
	return true;
}

static bool deg_objects_dupli_iterator_next(BLI_Iterator *iter)
{
	DEGObjectsIteratorData *data = (DEGObjectsIteratorData *)iter->data;
	while (data->dupli_object_next != NULL) {
		DupliObject *dob = data->dupli_object_next;
		Object *obd = dob->ob;

		data->dupli_object_next = data->dupli_object_next->next;

		/* Group duplis need to set ob matrices correct, for deform. so no_draw
		 * is part handled.
		 */
		if ((obd->transflag & OB_RENDER_DUPLI) == 0 && dob->no_draw) {
			continue;
		}

		if (obd->type == OB_MBALL) {
			continue;
		}

		data->dupli_object_current = dob;

		/* Temporary object to evaluate. */
		data->temp_dupli_object = *dob->ob;
		data->temp_dupli_object.select_color = data->dupli_parent->select_color;
		copy_m4_m4(data->temp_dupli_object.obmat, dob->mat);

		deg_flush_base_flags_and_settings(data,
		                                  &data->temp_dupli_object,
		                                  data->dupli_parent,
		                                  true);
		iter->current = &data->temp_dupli_object;
		BLI_assert(DEG::deg_validate_copy_on_write_datablock(&data->temp_dupli_object.id));
		return true;
	}

	return false;
}

static void deg_objects_iterator_step(BLI_Iterator *iter, DEG::IDDepsNode *id_node)
{
	/* Reset the skip in case we are running from within a loop. */
	iter->skip = false;

	DEGObjectsIteratorData *data = (DEGObjectsIteratorData *)iter->data;
	const ID_Type id_type = GS(id_node->id_orig->name);

	if (id_type != ID_OB) {
		iter->skip = true;
		return;
	}

	switch (id_node->linked_state) {
		case DEG::DEG_ID_LINKED_DIRECTLY:
			break;
		case DEG::DEG_ID_LINKED_VIA_SET:
			if (data->flag & DEG_OBJECT_ITER_FLAG_SET) {
				break;
			}
			else {
				ATTR_FALLTHROUGH;
			}
		case DEG::DEG_ID_LINKED_INDIRECTLY:
			iter->skip = true;
			return;
	}

	Object *ob = (Object *)id_node->id_cow;
	BLI_assert(DEG::deg_validate_copy_on_write_datablock(&ob->id));

	if (deg_flush_base_flags_and_settings(data, ob, ob, false) == false) {
		iter->skip = true;
		return;
	}

	if ((data->flag & DEG_OBJECT_ITER_FLAG_DUPLI) && (ob->transflag & OB_DUPLI)) {
		data->dupli_parent = ob;
		data->dupli_list = object_duplilist(&data->eval_ctx, data->scene, ob);
		data->dupli_object_next = (DupliObject *)data->dupli_list->first;
	}

	iter->current = ob;
}

void DEG_objects_iterator_begin(BLI_Iterator *iter, DEGObjectsIteratorData *data)
{
	Depsgraph *depsgraph = data->graph;
	DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(depsgraph);
	const size_t num_id_nodes = deg_graph->id_nodes.size();

	if (num_id_nodes == 0) {
		iter->valid = false;
		return;
	}

	/* TODO(sergey): What evaluation type we want here? */
	DEG_evaluation_context_init(&data->eval_ctx, DAG_EVAL_RENDER);
	data->eval_ctx.scene_layer = DEG_get_evaluated_scene_layer(depsgraph);

	iter->data = data;
	data->dupli_parent = NULL;
	data->dupli_list = NULL;
	data->dupli_object_next = NULL;
	data->dupli_object_current = NULL;
	data->scene = DEG_get_evaluated_scene(depsgraph);
	data->id_node_index = 0;
	data->num_id_nodes = num_id_nodes;

	DEG::IDDepsNode *id_node = deg_graph->id_nodes[data->id_node_index];
	deg_objects_iterator_step(iter, id_node);

	if (iter->skip) {
		DEG_objects_iterator_next(iter);
	}
}

void DEG_objects_iterator_next(BLI_Iterator *iter)
{
	DEGObjectsIteratorData *data = (DEGObjectsIteratorData *)iter->data;
	Depsgraph *depsgraph = data->graph;
	DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(depsgraph);
	do {
		if (data->dupli_list) {
			if (deg_objects_dupli_iterator_next(iter)) {
				return;
			}
			else {
				free_object_duplilist(data->dupli_list);
				data->dupli_parent = NULL;
				data->dupli_list = NULL;
				data->dupli_object_next = NULL;
				data->dupli_object_current = NULL;
			}
		}

		++data->id_node_index;
		if (data->id_node_index == data->num_id_nodes) {
			iter->valid = false;
			return;
		}

		DEG::IDDepsNode *id_node = deg_graph->id_nodes[data->id_node_index];
		deg_objects_iterator_step(iter, id_node);
	} while (iter->skip);
}

void DEG_objects_iterator_end(BLI_Iterator *iter)
{
#ifndef NDEBUG
	DEGObjectsIteratorData *data = (DEGObjectsIteratorData *)iter->data;
	/* Force crash in case the iterator data is referenced and accessed down the line. (T51718) */
	memset(&data->temp_dupli_object, 0xff, sizeof(data->temp_dupli_object));
#else
	(void) iter;
#endif
}