Blame synfig-studio/src/synfigapp/actions/layermove.cpp

Carlos Lopez a09598
/* === S Y N F I G ========================================================= */
Carlos Lopez a09598
/*!	\file layermove.cpp
Carlos Lopez a09598
**	\brief Template File
Carlos Lopez a09598
**
Carlos Lopez a09598
**	$Id$
Carlos Lopez a09598
**
Carlos Lopez a09598
**	\legal
Carlos Lopez a09598
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
Carlos Lopez a09598
**	Copyright (c) 2008 Chris Moore
Carlos Lopez a09598
**
Carlos Lopez a09598
**	This package is free software; you can redistribute it and/or
Carlos Lopez a09598
**	modify it under the terms of the GNU General Public License as
Carlos Lopez a09598
**	published by the Free Software Foundation; either version 2 of
Carlos Lopez a09598
**	the License, or (at your option) any later version.
Carlos Lopez a09598
**
Carlos Lopez a09598
**	This package is distributed in the hope that it will be useful,
Carlos Lopez a09598
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
Carlos Lopez a09598
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Carlos Lopez a09598
**	General Public License for more details.
Carlos Lopez a09598
**	\endlegal
Carlos Lopez a09598
*/
Carlos Lopez a09598
/* ========================================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
/* === H E A D E R S ======================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
#ifdef USING_PCH
Carlos Lopez a09598
#	include "pch.h"
Carlos Lopez a09598
#else
Carlos Lopez a09598
#ifdef HAVE_CONFIG_H
Carlos Lopez a09598
#	include <config.h></config.h>
Carlos Lopez a09598
#endif
Carlos Lopez a09598
bw 94d8a6
#include <synfig general.h=""></synfig>
bw 94d8a6
Carlos Lopez a09598
#include "layermove.h"
Carlos Lopez a09598
#include <synfigapp canvasinterface.h=""></synfigapp>
Carlos Lopez a09598
abdbf2
#include <synfigapp localization.h=""></synfigapp>
Carlos Lopez a09598
Carlos Lopez a09598
#endif
Carlos Lopez a09598
Carlos Lopez a09598
using namespace std;
Carlos Lopez a09598
using namespace etl;
Carlos Lopez a09598
using namespace synfig;
Carlos Lopez a09598
using namespace synfigapp;
Carlos Lopez a09598
using namespace Action;
Carlos Lopez a09598
Carlos Lopez a09598
/* === M A C R O S ========================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
ACTION_INIT_NO_GET_LOCAL_NAME(Action::LayerMove);
Carlos Lopez a09598
ACTION_SET_NAME(Action::LayerMove,"LayerMove");
Carlos Lopez a09598
ACTION_SET_LOCAL_NAME(Action::LayerMove,N_("Move Layer"));
Carlos Lopez a09598
ACTION_SET_TASK(Action::LayerMove,"move");
Carlos Lopez a09598
ACTION_SET_CATEGORY(Action::LayerMove,Action::CATEGORY_LAYER);
Carlos Lopez a09598
ACTION_SET_PRIORITY(Action::LayerMove,0);
Carlos Lopez a09598
ACTION_SET_VERSION(Action::LayerMove,"0.0");
Carlos Lopez a09598
ACTION_SET_CVS_ID(Action::LayerMove,"$Id$");
Carlos Lopez a09598
Carlos Lopez a09598
/* === G L O B A L S ======================================================= */
Carlos Lopez a09598
Carlos Lopez b6b0a7
// static const int nindex=-1;
Carlos Lopez a09598
Carlos Lopez a09598
/* === P R O C E D U R E S ================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
/* === M E T H O D S ======================================================= */
Carlos Lopez a09598
Carlos Lopez a09598
Action::LayerMove::LayerMove():
6320b8
	old_index(),
Carlos Lopez b6b0a7
	new_index(0xdeadbeef) // Dead beef? LOL
6320b8
{ }
Carlos Lopez a09598
Carlos Lopez a09598
synfig::String
Carlos Lopez a09598
Action::LayerMove::get_local_name()const
Carlos Lopez a09598
{
Carlos Lopez a09598
	if (layer)
Carlos Lopez a09598
		return strprintf("%s '%s'", _("Move Layer"), layer->get_non_empty_description().c_str());
Carlos Lopez a09598
	else
Carlos Lopez a09598
		return _("Move Layer");
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
Action::ParamVocab
Carlos Lopez a09598
Action::LayerMove::get_param_vocab()
Carlos Lopez a09598
{
Carlos Lopez a09598
	ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
Carlos Lopez a09598
Carlos Lopez a09598
	ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
Carlos Lopez a09598
		.set_local_name(_("Layer"))
Carlos Lopez a09598
		.set_desc(_("Layer to be moved"))
Carlos Lopez a09598
	);
Carlos Lopez a09598
Carlos Lopez a09598
	ret.push_back(ParamDesc("new_index",Param::TYPE_INTEGER)
Carlos Lopez a09598
		.set_local_name(_("New Index"))
Carlos Lopez a09598
		.set_desc(_("Where the layer is to be moved to"))
Carlos Lopez a09598
	);
Carlos Lopez a09598
Carlos Lopez a09598
	ret.push_back(ParamDesc("dest_canvas",Param::TYPE_CANVAS)
Carlos Lopez a09598
		.set_local_name(_("Destination Canvas"))
Carlos Lopez a09598
		.set_desc(_("The canvas the layer is to be moved to"))
Carlos Lopez a09598
		.set_optional()
Carlos Lopez a09598
	);
Carlos Lopez a09598
Carlos Lopez a09598
	return ret;
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
bool
Carlos Lopez a09598
Action::LayerMove::is_candidate(const ParamList &x)
Carlos Lopez a09598
{
Carlos Lopez a09598
	return candidate_check(get_param_vocab(),x);
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
bool
Carlos Lopez a09598
Action::LayerMove::set_param(const synfig::String& name, const Action::Param ¶m)
Carlos Lopez a09598
{
Carlos Lopez a09598
	if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
Carlos Lopez a09598
	{
Carlos Lopez a09598
Carlos Lopez a09598
		layer=param.get_layer();
Carlos Lopez a09598
Carlos Lopez a09598
		return true;
Carlos Lopez a09598
	}
Carlos Lopez a09598
Carlos Lopez a09598
	if(name=="new_index" && param.get_type()==Param::TYPE_INTEGER)
Carlos Lopez a09598
	{
Carlos Lopez a09598
		new_index=param.get_integer();
Carlos Lopez a09598
Carlos Lopez a09598
		return true;
Carlos Lopez a09598
	}
Carlos Lopez a09598
Carlos Lopez a09598
	if(name=="dest_canvas" && param.get_type()==Param::TYPE_CANVAS)
Carlos Lopez a09598
	{
Carlos Lopez a09598
		dest_canvas=param.get_canvas();
Carlos Lopez a09598
Carlos Lopez a09598
		return true;
Carlos Lopez a09598
	}
Carlos Lopez a09598
Carlos Lopez a09598
	return Action::CanvasSpecific::set_param(name,param);
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
bool
Carlos Lopez a09598
Action::LayerMove::is_ready()const
Carlos Lopez a09598
{
Carlos Lopez a09598
	// synfig::info(__FILE__":%d: layer->count()=%d",__LINE__,layer.count());
Carlos Lopez a09598
	if(!layer || (unsigned)new_index==0xdeadbeef)
Carlos Lopez a09598
		return false;
Carlos Lopez a09598
	return Action::CanvasSpecific::is_ready();
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
void
Carlos Lopez a09598
Action::LayerMove::perform()
Carlos Lopez a09598
{
Carlos Lopez a09598
	// synfig::info(__FILE__":%d: layer->count()=%d",__LINE__,layer.count());
Carlos Lopez a09598
Carlos Lopez a09598
	Canvas::Handle subcanvas(layer->get_canvas());
Carlos Lopez a09598
	src_canvas=subcanvas;
Carlos Lopez a09598
	if(!dest_canvas)
Carlos Lopez a09598
		dest_canvas=subcanvas;
Carlos Lopez a09598
Carlos Lopez a09598
	// Find the iterator for the layer
952b9b
	Canvas::iterator iter = src_canvas->find_index(layer, old_index);
b98a79
	if (*iter != layer)
Carlos Lopez a09598
		throw Error(_("This layer doesn't exist anymore."));
Carlos Lopez a09598
Carlos Lopez a09598
	// synfig::info(__FILE__":%d: layer->count()=%d",__LINE__,layer.count());
Carlos Lopez a09598
952b9b
	// If the src_canvas isn't the same as the canvas,
Carlos Lopez a09598
	// then it had better be an inline canvas. If not,
Carlos Lopez a09598
	// bail
952b9b
	//if(get_canvas()!=src_canvas && !src_canvas->is_inline())
Carlos Lopez a09598
	if(get_canvas()->get_root()!=dest_canvas->get_root() || get_canvas()->get_root()!=src_canvas->get_root())
Carlos Lopez a09598
		throw Error(_("You cannot directly move layers across compositions"));
Carlos Lopez a09598
b98a79
	int depth = new_index < 0
b98a79
		      ? dest_canvas->size() + new_index + 1
b98a79
		      : new_index;
Carlos Lopez a09598
Carlos Lopez a09598
	set_dirty(layer->active());
Carlos Lopez a09598
Carlos Lopez a09598
	// synfig::info(__FILE__":%d: layer->count()=%d",__LINE__,layer.count());
Carlos Lopez a09598
Carlos Lopez a09598
	// If we were to move it to where it is
Carlos Lopez a09598
	if(old_index==depth && src_canvas==dest_canvas)
Carlos Lopez a09598
		return;
Carlos Lopez a09598
Carlos Lopez a09598
	if(depth>dest_canvas->size())
Carlos Lopez a09598
		depth=dest_canvas->size();
Carlos Lopez a09598
	if(depth<0)
Carlos Lopez a09598
		depth=0;
Carlos Lopez a09598
Carlos Lopez a09598
	src_canvas->erase(iter);
b98a79
	dest_canvas->insert(dest_canvas->byindex(depth), layer);
Carlos Lopez a09598
	layer->set_canvas(dest_canvas);
Carlos Lopez a09598
Carlos Lopez a09598
	layer->changed();
Carlos Lopez a09598
	dest_canvas->changed(); if(dest_canvas!=src_canvas) src_canvas->changed();
Carlos Lopez a09598
Carlos Lopez a09598
	// synfig::info(__FILE__":%d: layer->count()=%d",__LINE__,layer.count());
Carlos Lopez a09598
Carlos Lopez a09598
	if(get_canvas_interface())
Carlos Lopez a09598
	{
Carlos Lopez a09598
		if(src_canvas==dest_canvas)
Carlos Lopez a09598
		{
Carlos Lopez a09598
			if(new_index==old_index-1)	// Raise
Carlos Lopez a09598
				get_canvas_interface()->signal_layer_raised()(layer);
Carlos Lopez a09598
			else if(new_index==old_index+1)	// Lower
Carlos Lopez a09598
				get_canvas_interface()->signal_layer_lowered()(layer);
Carlos Lopez a09598
			else		// Moved
Carlos Lopez a09598
			{
Carlos Lopez a09598
				get_canvas_interface()->signal_layer_moved()(layer,depth,dest_canvas);
Carlos Lopez a09598
			}
Carlos Lopez a09598
		}
Carlos Lopez a09598
		else
Carlos Lopez a09598
		{
Carlos Lopez a09598
			get_canvas_interface()->signal_layer_moved()(layer,depth,dest_canvas);
Carlos Lopez a09598
		}
Carlos Lopez a09598
	}
Carlos Lopez a09598
	else synfig::warning("CanvasInterface not set on action");
Carlos Lopez a09598
Carlos Lopez a09598
	// synfig::info(__FILE__":%d: layer->count()=%d",__LINE__,layer.count());
Carlos Lopez a09598
}
Carlos Lopez a09598
Carlos Lopez a09598
void
Carlos Lopez a09598
Action::LayerMove::undo()
Carlos Lopez a09598
{
Carlos Lopez a09598
	// Find the iterator for the layer
b98a79
	int index = -1;
b98a79
	Canvas::iterator iter=dest_canvas->find_index(layer, index);
Carlos Lopez a09598
Carlos Lopez a09598
	// If we couldn't find the layer in the canvas, then bail
Carlos Lopez a09598
	if(*iter!=layer || (get_canvas()!=dest_canvas && !dest_canvas->is_inline()))
Carlos Lopez a09598
		throw Error(_("This layer doesn't exist anymore."));
Carlos Lopez a09598
Carlos Lopez a09598
	// If we were to move it to where it is
Carlos Lopez a09598
	if(old_index==new_index && src_canvas==dest_canvas)
Carlos Lopez a09598
		return;
Carlos Lopez a09598
Carlos Lopez a09598
	// Mark ourselves as dirty if necessary
Carlos Lopez a09598
	set_dirty(layer->active());
Carlos Lopez a09598
Carlos Lopez a09598
	dest_canvas->erase(iter);
Carlos Lopez a09598
b98a79
	src_canvas->insert(src_canvas->byindex(old_index), layer);
Carlos Lopez a09598
	layer->set_canvas(src_canvas);
Carlos Lopez a09598
Carlos Lopez a09598
	layer->changed();
Carlos Lopez a09598
	dest_canvas->changed(); if(dest_canvas!=src_canvas) src_canvas->changed();
Carlos Lopez a09598
Carlos Lopez a09598
	// Execute any signals
Carlos Lopez a09598
	if(get_canvas_interface())
Carlos Lopez a09598
	{
Carlos Lopez a09598
		if(src_canvas==dest_canvas)
Carlos Lopez a09598
		{
Carlos Lopez a09598
			if(new_index==old_index+1)	// Raise
Carlos Lopez a09598
				get_canvas_interface()->signal_layer_raised()(layer);
Carlos Lopez a09598
			else if(new_index==old_index-1)	// Lower
Carlos Lopez a09598
				get_canvas_interface()->signal_layer_lowered()(layer);
Carlos Lopez a09598
			else		// Moved
Carlos Lopez a09598
			{
Carlos Lopez a09598
			get_canvas_interface()->signal_layer_moved()(layer,old_index,src_canvas);
Carlos Lopez a09598
			}
Carlos Lopez a09598
		}
Carlos Lopez a09598
		else
Carlos Lopez a09598
		{
Carlos Lopez a09598
			get_canvas_interface()->signal_layer_moved()(layer,old_index,src_canvas);
Carlos Lopez a09598
			//get_canvas_interface()->signal_layer_removed()(layer);
Carlos Lopez a09598
			//get_canvas_interface()->signal_layer_inserted()(layer,old_index);
Carlos Lopez a09598
		}
Carlos Lopez a09598
	}
Carlos Lopez a09598
	else synfig::warning("CanvasInterface not set on action");
Carlos Lopez a09598
}