synfig-core/trunk/src/modules/lyr_std/timeloop.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file timeloop.cpp
   3 **      \brief Implementation of the "Time Loop" layer
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 **
  22 ** === N O T E S ===========================================================
  23 **
  24 ** ========================================================================= */
  25
  26 /* === H E A D E R S ======================================================= */
  27
  28 #ifdef USING_PCH
  29 #       include "pch.h"
  30 #else
  31 #ifdef HAVE_CONFIG_H
  32 #       include <config.h>
  33 #endif
  34
  35 #include "timeloop.h"
  36 #include <synfig/valuenode.h>
  37 #include <synfig/valuenode_const.h>
  38 #include <synfig/valuenode_subtract.h>
  39 #include <synfig/time.h>
  40 #include <synfig/context.h>
  41 #include <synfig/paramdesc.h>
  42 #include <synfig/renddesc.h>
  43 #include <synfig/value.h>
  44
  45 #endif
  46
  47 using namespace synfig;
  48 using namespace std;
  49 using namespace etl;
  50
  51 /* === M A C R O S ========================================================= */
  52
  53 /* === G L O B A L S ======================================================= */
  54
  55 SYNFIG_LAYER_INIT(Layer_TimeLoop);
  56 SYNFIG_LAYER_SET_NAME(Layer_TimeLoop,"timeloop");
  57 SYNFIG_LAYER_SET_LOCAL_NAME(Layer_TimeLoop,N_("Time Loop"));
  58 SYNFIG_LAYER_SET_CATEGORY(Layer_TimeLoop,N_("Other"));
  59 SYNFIG_LAYER_SET_VERSION(Layer_TimeLoop,"0.2");
  60 SYNFIG_LAYER_SET_CVS_ID(Layer_TimeLoop,"$Id$");
  61
  62 /* === P R O C E D U R E S ================================================= */
  63
  64 /* === M E T H O D S ======================================================= */
  65
  66 Layer_TimeLoop::Layer_TimeLoop()
  67 {
  68         old_version=false;
  69         link_time=0;
  70         local_time=0;
  71         duration=1;
  72 }
  73
  74 Layer_TimeLoop::~Layer_TimeLoop()
  75 {
  76 }
  77
  78 bool
  79 Layer_TimeLoop::set_param(const String & param, const ValueBase &value)
  80 {
  81         if(old_version)
  82         {
  83                 IMPORT(start_time);
  84                 IMPORT(end_time);
  85         }
  86         else
  87         {
  88                 IMPORT(local_time);
  89                 IMPORT(link_time);
  90                 IMPORT(duration);
  91         }
  92
  93         return Layer::set_param(param,value);
  94 }
  95
  96 ValueBase
  97 Layer_TimeLoop::get_param(const String & param)const
  98 {
  99         EXPORT(link_time);
 100         EXPORT(local_time);
 101         EXPORT(duration);
 102         EXPORT_NAME();
 103         EXPORT_VERSION();
 104
 105         return Layer::get_param(param);
 106 }
 107
 108 Layer::Vocab
 109 Layer_TimeLoop::get_param_vocab()const
 110 {
 111         Layer::Vocab ret(Layer::get_param_vocab());
 112
 113         ret.push_back(ParamDesc("link_time")
 114                 .set_local_name(_("Link Time"))
 115         );
 116
 117         ret.push_back(ParamDesc("local_time")
 118                 .set_local_name(_("Local Time"))
 119         );
 120
 121         ret.push_back(ParamDesc("duration")
 122                 .set_local_name(_("Duration"))
 123         );
 124
 125         return ret;
 126 }
 127
 128 bool
 129 Layer_TimeLoop::set_version(const String &ver)
 130 {
 131         if (ver=="0.1")
 132                 old_version = true;
 133
 134         return true;
 135 }
 136
 137 void
 138 Layer_TimeLoop::reset_version()
 139 {
 140         // if we're not converting from an old version of the layer, there's nothing to do
 141         if (!old_version)
 142                 return;
 143
 144         old_version = false;
 145
 146         // these are the conversions to go from 0.1 to 0.2:
 147         //
 148         //       local_time = start_time
 149         //       duration = end_time - start_time
 150         //       if (time < start_time)
 151         //         link_time = -duration : if we want to reproduce the old behaviour - do we?
 152         //       else
 153         //               link_time = 0
 154
 155         // convert the static parameters
 156         local_time = start_time;
 157         duration = end_time - start_time;
 158         //! \todo layer version 0.1 acted differently before start_time was reached - possibly due to a bug
 159         link_time = 0;
 160
 161         // convert the dynamic parameters
 162         const DynamicParamList &dpl = dynamic_param_list();
 163
 164         // if neither start_time nor end_time are dynamic, there's nothing more to do
 165         if (dpl.count("start_time") == 0 && dpl.count("end_time") == 0)
 166                 return;
 167
 168         etl::rhandle<ValueNode> start_time_value_node, end_time_value_node;
 169         LinkableValueNode* duration_value_node;
 170
 171         if (dpl.count("start_time"))
 172         {
 173                 start_time_value_node = dpl.find("start_time")->second;
 174                 disconnect_dynamic_param("start_time");
 175         }
 176         else
 177                 start_time_value_node = ValueNode_Const::create(start_time);
 178
 179         if (dpl.count("end_time"))
 180         {
 181                 end_time_value_node = dpl.find("end_time")->second;
 182                 disconnect_dynamic_param("end_time");
 183         }
 184         else
 185                 end_time_value_node = ValueNode_Const::create(end_time);
 186
 187         duration_value_node = ValueNode_Subtract::create(Time(0));
 188         duration_value_node->set_link("lhs", end_time_value_node);
 189         duration_value_node->set_link("rhs", start_time_value_node);
 190
 191         connect_dynamic_param("local_time", start_time_value_node);
 192         connect_dynamic_param("duration",   duration_value_node);
 193         connect_dynamic_param("link_time",  ValueNode_Const::create(Time(0)));
 194 }
 195
 196 void
 197 Layer_TimeLoop::set_time(Context context, Time t)const
 198 {
 199         if (duration == 0)
 200                 t = link_time;
 201         else if (duration > 0)
 202         {
 203                 t -= local_time;
 204                 t -= floor(t / duration) * duration;
 205                 t  = link_time + t;
 206         }
 207         else
 208         {
 209                 t -= local_time;
 210                 t -= floor(t / -duration) * -duration;
 211                 t  = link_time - t;
 212         }
 213
 214         context.set_time(t);
 215 }
 216
 217 Color
 218 Layer_TimeLoop::get_color(Context context, const Point &pos)const
 219 {
 220         return context.get_color(pos);
 221 }
 222
 223 bool
 224 Layer_TimeLoop::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
 225 {
 226         return context.accelerated_render(surface,quality,renddesc,cb);
 227 }