synfig-studio/trunk/src/synfigapp/actions/layerlower.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file layerlower.cpp
   3 **      \brief Template File
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **
  10 **      This package is free software; you can redistribute it and/or
  11 **      modify it under the terms of the GNU General Public License as
  12 **      published by the Free Software Foundation; either version 2 of
  13 **      the License, or (at your option) any later version.
  14 **
  15 **      This package is distributed in the hope that it will be useful,
  16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 **      General Public License for more details.
  19 **      \endlegal
  20 */
  21 /* ========================================================================= */
  22
  23 /* === H E A D E R S ======================================================= */
  24
  25 #ifdef USING_PCH
  26 #       include "pch.h"
  27 #else
  28 #ifdef HAVE_CONFIG_H
  29 #       include <config.h>
  30 #endif
  31
  32 #include "layerlower.h"
  33 #include "layermove.h"
  34 #include <synfigapp/canvasinterface.h>
  35
  36 #include <synfigapp/general.h>
  37
  38 #endif
  39
  40 using namespace std;
  41 using namespace etl;
  42 using namespace synfig;
  43 using namespace synfigapp;
  44 using namespace Action;
  45
  46 /* === M A C R O S ========================================================= */
  47
  48 ACTION_INIT_NO_GET_LOCAL_NAME(Action::LayerLower);
  49 ACTION_SET_NAME(Action::LayerLower,"layer_lower");
  50 ACTION_SET_LOCAL_NAME(Action::LayerLower,N_("Lower Layer"));
  51 ACTION_SET_TASK(Action::LayerLower,"lower");
  52 ACTION_SET_CATEGORY(Action::LayerLower,Action::CATEGORY_LAYER);
  53 ACTION_SET_PRIORITY(Action::LayerLower,10);
  54 ACTION_SET_VERSION(Action::LayerLower,"0.0");
  55 ACTION_SET_CVS_ID(Action::LayerLower,"$Id$");
  56
  57 /* === G L O B A L S ======================================================= */
  58
  59 /* === P R O C E D U R E S ================================================= */
  60
  61 /* === M E T H O D S ======================================================= */
  62
  63 Action::LayerLower::LayerLower()
  64 {
  65 }
  66
  67 synfig::String
  68 Action::LayerLower::get_local_name()const
  69 {
  70         String ret;
  71
  72         if (layers.empty())
  73                 return _("Lower Layer");
  74
  75         ret = strprintf("%s '%s'",
  76                                         (layers.size() == 1
  77                                          ? _("Lower Layer")
  78                                          : _("Lower Layers")),
  79                                         (*layers.begin())->get_non_empty_description().c_str());
  80
  81         for(std::list<synfig::Layer::Handle>::const_iterator iter=++layers.begin(); iter!=layers.end(); ++iter)
  82                 ret += strprintf(", '%s'", ((*iter)->get_non_empty_description().c_str()));
  83         return ret;
  84 }
  85
  86 Action::ParamVocab
  87 Action::LayerLower::get_param_vocab()
  88 {
  89         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  90
  91         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
  92                 .set_local_name(_("Layer"))
  93                 .set_desc(_("Layer to be lowered"))
  94                 .set_supports_multiple()
  95         );
  96
  97         return ret;
  98 }
  99
 100 bool
 101 Action::LayerLower::is_candidate(const ParamList &x)
 102 {
 103         if(!candidate_check(get_param_vocab(),x))
 104                 return false;
 105
 106         Layer::Handle layer(x.find("layer")->second.get_layer());
 107         //synfig::info("layer->get_depth()= %d ; layer->get_canvas()->size()=%d ;",layer->get_depth(),layer->get_canvas()->size());
 108         if(layer->get_depth()+1>=layer->get_canvas()->size())
 109                 return false;
 110         return true;
 111 }
 112
 113 bool
 114 Action::LayerLower::set_param(const synfig::String& name, const Action::Param &param)
 115 {
 116         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
 117         {
 118                 layers.push_back(param.get_layer());
 119
 120                 return true;
 121         }
 122
 123         return Action::CanvasSpecific::set_param(name,param);
 124 }
 125
 126 bool
 127 Action::LayerLower::is_ready()const
 128 {
 129         if(layers.empty())
 130                 return false;
 131         return Action::CanvasSpecific::is_ready();
 132 }
 133
 134 void
 135 Action::LayerLower::prepare()
 136 {
 137         std::list<synfig::Layer::Handle>::const_iterator iter;
 138
 139         clear();
 140
 141         for(iter=layers.begin();iter!=layers.end();++iter)
 142         {
 143                 Layer::Handle layer(*iter);
 144
 145                 Canvas::Handle subcanvas(layer->get_canvas());
 146
 147                 // Find the iterator for the layer
 148                 Canvas::iterator iter=find(subcanvas->begin(),subcanvas->end(),layer);
 149
 150                 // If we couldn't find the layer in the canvas, then bail
 151                 if(*iter!=layer)
 152                         throw Error(_("This layer doesn't exist anymore."));
 153
 154                 // If the subcanvas isn't the same as the canvas,
 155                 // then it had better be an inline canvas. If not,
 156                 // bail
 157                 //if(get_canvas()!=subcanvas && !subcanvas->is_inline())
 158                 //      throw Error(_("This layer doesn't belong to this canvas anymore"));
 159
 160                 int new_index=iter-subcanvas->begin();
 161
 162                 new_index++;
 163
 164                 // If this lowers the layer past the bottom then don't bother
 165                 if(new_index==subcanvas->size())
 166                         continue;
 167
 168                 Action::Handle layer_move(LayerMove::create());
 169
 170                 layer_move->set_param("canvas",get_canvas());
 171                 layer_move->set_param("canvas_interface",get_canvas_interface());
 172                 layer_move->set_param("layer",layer);
 173                 layer_move->set_param("new_index",new_index);
 174
 175                 add_action_front(layer_move);
 176         }
 177 }