blender-archive/source/blender/blenkernel/intern/group.c

/*
 * ***** 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) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file blender/blenkernel/intern/group.c
 *  \ingroup bke
 */


#include <stdio.h>
#include <string.h>
#include <math.h>

#include "MEM_guardedalloc.h"

#include "DNA_group_types.h"
#include "DNA_material_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_particle_types.h"

#include "BLI_blenlib.h"
#include "BLI_utildefines.h"

#include "BKE_collection.h"
#include "BKE_global.h"
#include "BKE_group.h"
#include "BKE_icons.h"
#include "BKE_layer.h"
#include "BKE_library.h"
#include "BKE_main.h"
#include "BKE_object.h"
#include "BKE_scene.h"

#define DEBUG_PRINT if (G.debug & G_DEBUG_DEPSGRAPH) printf

/** Free (or release) any data used by this group (does not free the group itself). */
void BKE_group_free(Group *group)
{
	/* No animdata here. */
	BKE_previewimg_free(&group->preview);

	if (group->view_layer != NULL) {
		BKE_view_layer_free(group->view_layer);
		group->view_layer = NULL;
	}

	if (group->collection != NULL) {
		BKE_collection_master_free(&group->id, false);
		MEM_freeN(group->collection);
		group->collection = NULL;
	}
}

/**
 * Run when adding new groups or during doversion.
 */
void BKE_group_init(Group *group)
{
	group->collection = MEM_callocN(sizeof(SceneCollection), __func__);
	BLI_strncpy(group->collection->name, "Master Collection", sizeof(group->collection->name));
	group->view_layer = BKE_view_layer_group_add(group);

	/* Unlink the master collection. */
	BKE_collection_unlink(group->view_layer, group->view_layer->layer_collections.first);

	/* Create and link a new default collection. */
	SceneCollection *defaut_collection = BKE_collection_add(&group->id, NULL, COLLECTION_TYPE_GROUP_INTERNAL, NULL);
	BKE_collection_link(group->view_layer, defaut_collection);
}

Group *BKE_group_add(Main *bmain, const char *name)
{
	Group *group;
	
	group = BKE_libblock_alloc(bmain, ID_GR, name, 0);
	id_us_min(&group->id);
	id_us_ensure_real(&group->id);
	group->layer = (1 << 20) - 1;

	group->preview = NULL;
	BKE_group_init(group);
	return group;
}

/**
 * Only copy internal data of Group ID from source to already allocated/initialized destination.
 * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
 *
 * WARNING! This function will not handle ID user count!
 *
 * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
 */
void BKE_group_copy_data(Main *UNUSED(bmain), Group *group_dst, const Group *group_src, const int flag)
{
	/* We never handle usercount here for own data. */
	const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT;

	/* Do not copy group's preview (same behavior as for objects). */
	if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0 && false) {  /* XXX TODO temp hack */
		BKE_previewimg_id_copy(&group_dst->id, &group_src->id);
	}
	else {
		group_dst->preview = NULL;
	}

	group_dst->collection = MEM_dupallocN(group_src->collection);
	SceneCollection *master_collection_src = BKE_collection_master(&group_src->id);
	SceneCollection *master_collection_dst = BKE_collection_master(&group_dst->id);

	/* Recursively creates a new SceneCollection tree. */
	BKE_collection_copy_data(master_collection_dst, master_collection_src,
	                         flag_subdata);

	group_dst->view_layer = MEM_dupallocN(group_src->view_layer);
	BKE_view_layer_copy_data(group_dst->view_layer, group_src->view_layer,
	                         master_collection_dst, master_collection_src,
	                         flag_subdata);
}

Group *BKE_group_copy(Main *bmain, const Group *group)
{
	Group *group_copy;
	BKE_id_copy_ex(bmain, &group->id, (ID **)&group_copy, 0, false);
	return group_copy;
}

void BKE_group_make_local(Main *bmain, Group *group, const bool lib_local)
{
	BKE_id_make_local_generic(bmain, &group->id, true, lib_local);
}

/* external */
static bool group_object_add_internal(Group *group, Object *ob)
{
	if (group == NULL || ob == NULL) {
		return false;
	}

	/* For now always add to master collection of the group. */
	SceneCollection *scene_collection = GROUP_MASTER_COLLECTION(group);

	/* If the object has been added already it returns false. */
	if (BKE_collection_object_add(&group->id, scene_collection, ob) == false) {
		return false;
	}

	id_us_ensure_real(&ob->id);
	return true;
}

bool BKE_group_object_add(Group *group, Object *object)
{
	if (group_object_add_internal(group, object)) {
		if ((object->flag & OB_FROMGROUP) == 0) {
			object->flag |= OB_FROMGROUP;
		}
		return true;
	}
	else {
		return false;
	}
}

/* also used for (ob == NULL) */
static bool group_object_unlink_internal(Group *group, Object *ob)
{
	if (group == NULL) {
		return false;
	}

	if (BKE_collections_object_remove(NULL, &group->id, ob, false)) {
		return true;
	}

	return false;
}

static bool group_object_cyclic_check_internal(Object *object, Group *group)
{
	if (object->dup_group) {
		Group *dup_group = object->dup_group;
		if ((dup_group->id.tag & LIB_TAG_DOIT) == 0) {
			/* Cycle already exists in groups, let's prevent further crappyness */
			return true;
		}
		/* flag the object to identify cyclic dependencies in further dupli groups */
		dup_group->id.tag &= ~LIB_TAG_DOIT;

		if (dup_group == group)
			return true;
		else {
			FOREACH_GROUP_OBJECT(dup_group, group_object)
			{
				if (group_object_cyclic_check_internal(group_object, dup_group)) {
					return true;
				}
			}
			FOREACH_GROUP_OBJECT_END
		}

		/* un-flag the object, it's allowed to have the same group multiple times in parallel */
		dup_group->id.tag |= LIB_TAG_DOIT;
	}

	return false;
}

bool BKE_group_object_cyclic_check(Main *bmain, Object *object, Group *group)
{
	/* first flag all groups */
	BKE_main_id_tag_listbase(&bmain->group, LIB_TAG_DOIT, true);

	return group_object_cyclic_check_internal(object, group);
}

bool BKE_group_object_unlink(Group *group, Object *object)
{
	if (group_object_unlink_internal(group, object)) {
		/* object can be NULL */
		if (object && BKE_group_object_find(NULL, object) == NULL) {
			object->flag &= ~OB_FROMGROUP;
		}
		return true;
	}
	else {
		return false;
	}
}

bool BKE_group_object_exists(Group *group, Object *ob)
{
	if (group == NULL || ob == NULL) {
		return false;
	}
	else {
		return (BLI_findptr(&group->view_layer->object_bases, ob, offsetof(Base, object)));
	}
}

Group *BKE_group_object_find(Group *group, Object *ob)
{
	if (group)
		group = group->id.next;
	else
		group = G.main->group.first;
	
	while (group) {
		if (BKE_group_object_exists(group, ob))
			return group;
		group = group->id.next;
	}
	return NULL;
}

bool BKE_group_is_animated(Group *group, Object *UNUSED(parent))
{
	FOREACH_GROUP_OBJECT(group, object)
	{
		if (object->proxy) {
			return true;
		}
	}
	FOREACH_GROUP_OBJECT_END
	return false;
}

#if 0 // add back when timeoffset & animsys work again
/* only replaces object strips or action when parent nla instructs it */
/* keep checking nla.c though, in case internal structure of strip changes */
static void group_replaces_nla(Object *parent, Object *target, char mode)
{
	static ListBase nlastrips = {NULL, NULL};
	static bAction *action = NULL;
	static bool done = false;
	bActionStrip *strip, *nstrip;
	
	if (mode == 's') {
		
		for (strip = parent->nlastrips.first; strip; strip = strip->next) {
			if (strip->object == target) {
				if (done == 0) {
					/* clear nla & action from object */
					nlastrips = target->nlastrips;
					BLI_listbase_clear(&target->nlastrips);
					action = target->action;
					target->action = NULL;
					target->nlaflag |= OB_NLA_OVERRIDE;
					done = true;
				}
				nstrip = MEM_dupallocN(strip);
				BLI_addtail(&target->nlastrips, nstrip);
			}
		}
	}
	else if (mode == 'e') {
		if (done) {
			BLI_freelistN(&target->nlastrips);
			target->nlastrips = nlastrips;
			target->action = action;
			
			BLI_listbase_clear(&nlastrips);  /* not needed, but yah... :) */
			action = NULL;
			done = false;
		}
	}
}
#endif

/* puts all group members in local timing system, after this call
 * you can draw everything, leaves tags in objects to signal it needs further updating */

/* note: does not work for derivedmesh and render... it recreates all again in convertblender.c */
void BKE_group_handle_recalc_and_update(const struct EvaluationContext *eval_ctx, Scene *scene, Object *UNUSED(parent), Group *group)
{
#if 0 /* warning, isn't clearing the recalc flag on the object which causes it to run all the time,
	   * not just on frame change.
	   * This isn't working because the animation data is only re-evaluated on frame change so commenting for now
	   * but when its enabled at some point it will need to be changed so as not to update so much - campbell */

	/* if animated group... */
	if (parent->nlastrips.first) {
		int cfrao;
		
		/* switch to local time */
		cfrao = scene->r.cfra;
		
		/* we need a DAG per group... */
		for (go = group->gobject.first; go; go = go->next) {
			if (go->ob && go->recalc) {
				go->ob->recalc = go->recalc;
				
				group_replaces_nla(parent, go->ob, 's');
				BKE_object_handle_update(eval_ctx, scene, go->ob);
				group_replaces_nla(parent, go->ob, 'e');
				
				/* leave recalc tags in case group members are in normal scene */
				go->ob->recalc = go->recalc;
			}
		}
		
		/* restore */
		scene->r.cfra = cfrao;
	}
	else
#endif
	{
		/* only do existing tags, as set by regular depsgraph */
		FOREACH_GROUP_OBJECT(group, object)
		{
			if (object->id.recalc & ID_RECALC_ALL) {
				BKE_object_handle_update(eval_ctx, scene, object);
			}
		}
		FOREACH_GROUP_OBJECT_END
	}
}

/* ******** Dependency graph evaluation ******** */

static void group_eval_layer_collections(
        const struct EvaluationContext *eval_ctx,
        Group *group,
        ListBase *layer_collections,
        LayerCollection *parent_layer_collection)
{
	LISTBASE_FOREACH (LayerCollection *, layer_collection, layer_collections) {
		/* Evaluate layer collection itself. */
		BKE_layer_eval_layer_collection(eval_ctx,
		                                layer_collection,
		                                parent_layer_collection);
		/* Evaluate nested collections. */
		group_eval_layer_collections(eval_ctx,
		                             group,
		                             &layer_collection->layer_collections,
		                             layer_collection);
	}
}

void BKE_group_eval_view_layers(const struct EvaluationContext *eval_ctx,
                                Group *group)
{
	DEBUG_PRINT("%s on %s (%p)\n", __func__, group->id.name, group);
	BKE_layer_eval_layer_collection_pre(eval_ctx, &group->id, group->view_layer);
	group_eval_layer_collections(eval_ctx,
	                             group,
	                             &group->view_layer->layer_collections,
	                             NULL);
	BKE_layer_eval_layer_collection_post(eval_ctx, group->view_layer);
}