/* === S Y N F I G ========================================================= */
/*! \file layersetexcludefromrendering.cpp
** \brief Template File
**
** $Id$
**
** \legal
** ......... ... 2013 Ivan Mahonin
**
** This package 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 package 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.
** \endlegal
*/
/* ========================================================================= */
/* === H E A D E R S ======================================================= */
#ifdef USING_PCH
# include "pch.h"
#else
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <synfig/general.h>
#include "layersetexcludefromrendering.h"
#include <synfigapp/canvasinterface.h>
#include <synfigapp/localization.h>
#endif
using namespace std;
using namespace etl;
using namespace synfig;
using namespace synfigapp;
using namespace Action;
/* === M A C R O S ========================================================= */
#define ACTION_LAYERSETEXCLUDEFROMRENDERING_IMPLEMENT(class_name, local_name, task, ...) \
ACTION_INIT(Action::class_name); \
ACTION_SET_NAME(Action::class_name, #class_name); \
ACTION_SET_LOCAL_NAME(Action::class_name, local_name); \
ACTION_SET_TASK(Action::class_name,"setexcludefromrendering_" #task); \
ACTION_SET_CATEGORY(Action::class_name,Action::CATEGORY_LAYER); \
ACTION_SET_PRIORITY(Action::class_name,0); \
ACTION_SET_VERSION(Action::class_name,"0.0"); \
ACTION_SET_CVS_ID(Action::class_name,"$Id$"); \
bool Action::class_name::is_candidate(const ParamList &x) \
{ return is_candidate_for_exclude(x,task); }
ACTION_LAYERSETEXCLUDEFROMRENDERING_IMPLEMENT(
LayerSetExcludeFromRenderingOn, N_("Disable Layer Rendering"), true);
ACTION_LAYERSETEXCLUDEFROMRENDERING_IMPLEMENT(
LayerSetExcludeFromRenderingOff, N_("Enable Layer Rendering"), false);
/* === G L O B A L S ======================================================= */
/* === P R O C E D U R E S ================================================= */
/* === M E T H O D S ======================================================= */
Action::LayerSetExcludeFromRendering::LayerSetExcludeFromRendering():
new_state_set(false),
old_state(false),
new_state(false)
{
}
synfig::String
Action::LayerSetExcludeFromRendering::get_local_name()const
{
if(!layer)
return _("Toggle Exclude from Rendering");
return strprintf("%s '%s'",
new_state
? _("Disable layer rendering - ")
: _("Enable layer rendering - "),
layer->get_non_empty_description().c_str());
}
Action::ParamVocab
Action::LayerSetExcludeFromRendering::get_param_vocab()
{
ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
.set_local_name(_("Layer"))
);
ret.push_back(ParamDesc("new_state",Param::TYPE_BOOL)
.set_local_name(_("New State"))
.set_desc(_("The new state of the layer exclusion"))
.set_optional(true)
);
return ret;
}
bool
Action::LayerSetExcludeFromRendering::is_candidate_for_exclude(const ParamList &x, bool new_state)
{
if (!candidate_check(get_param_vocab(),x))
return false;
Layer::Handle l(x.find("layer")->second.get_layer());
if (l->get_exclude_from_rendering() == new_state)
return false;
else
return true;
}
bool
Action::LayerSetExcludeFromRendering::set_param(const synfig::String& name, const Action::Param ¶m)
{
if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
{
layer=param.get_layer();
if (layer && !new_state_set)
new_state=!layer->get_exclude_from_rendering();
return true;
}
if(name=="new_state" && param.get_type()==Param::TYPE_BOOL)
{
new_state=param.get_bool();
new_state_set=true;
return true;
}
return Action::CanvasSpecific::set_param(name,param);
}
bool
Action::LayerSetExcludeFromRendering::is_ready()const
{
if(!layer)
return false;
return Action::CanvasSpecific::is_ready();
}
void
Action::LayerSetExcludeFromRendering::perform()
{
Canvas::Handle subcanvas(layer->get_canvas());
// Find the iterator for the layer
Canvas::iterator iter=find(subcanvas->begin(),subcanvas->end(),layer);
// If we couldn't find the layer in the canvas, then bail
if(*iter!=layer)
throw Error(_("This layer doesn't exist anymore."));
// If the subcanvas isn't the same as the canvas,
// then it had better be an inline canvas. If not,
// bail
//if(get_canvas()!=subcanvas && !subcanvas->is_inline())
//if(get_canvas()->get_root()!=subcanvas->get_root())
// throw Error(_("This layer doesn't belong to this composition"));
old_state=layer->get_exclude_from_rendering();
// If we are changing the state to what it already is,
// the go ahead and return
if(new_state==old_state)
{
set_dirty(false);
return;
}
else
set_dirty();
layer->set_exclude_from_rendering(new_state);
if(get_canvas_interface())
{
get_canvas_interface()->signal_layer_exclude_from_rendering_changed()(layer,new_state);
}
else synfig::warning("CanvasInterface not set on action");
}
void
Action::LayerSetExcludeFromRendering::undo()
{
// If we are changing the state to what it already is,
// the go ahead and return
if(new_state==old_state)
{
set_dirty(false);
return;
}
else
set_dirty();
// restore the old state
layer->set_exclude_from_rendering(old_state);
if(get_canvas_interface())
{
get_canvas_interface()->signal_layer_exclude_from_rendering_changed()(layer,old_state);
}
else synfig::warning("CanvasInterface not set on action");
}