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, 2008 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         only_for_positive_duration=false;
  70         link_time=0;
  71         local_time=0;
  72         duration=1;
  73 }
  74
  75 Layer_TimeLoop::~Layer_TimeLoop()
  76 {
  77 }
  78
  79 bool
  80 Layer_TimeLoop::set_param(const String & param, const ValueBase &value)
  81 {
  82         if(old_version)
  83         {
  84                 IMPORT(start_time);
  85                 IMPORT(end_time);
  86         }
  87         else
  88         {
  89                 IMPORT(local_time);
  90                 IMPORT(link_time);
  91                 IMPORT(duration);
  92                 IMPORT(only_for_positive_duration);
  93         }
  94
  95         return Layer::set_param(param,value);
  96 }
  97
  98 ValueBase
  99 Layer_TimeLoop::get_param(const String & param)const
 100 {
 101         EXPORT(link_time);
 102         EXPORT(local_time);
 103         EXPORT(duration);
 104         EXPORT(only_for_positive_duration);
 105         EXPORT_NAME();
 106         EXPORT_VERSION();
 107
 108         return Layer::get_param(param);
 109 }
 110
 111 Layer::Vocab
 112 Layer_TimeLoop::get_param_vocab()const
 113 {
 114         Layer::Vocab ret(Layer::get_param_vocab());
 115
 116         ret.push_back(ParamDesc("link_time")
 117                 .set_local_name(_("Link Time"))
 118         );
 119
 120         ret.push_back(ParamDesc("local_time")
 121                 .set_local_name(_("Local Time"))
 122         );
 123
 124         ret.push_back(ParamDesc("duration")
 125                 .set_local_name(_("Duration"))
 126         );
 127
 128         ret.push_back(ParamDesc("only_for_positive_duration")
 129                 .set_local_name(_("Only For Positive Duration"))
 130         );
 131
 132         return ret;
 133 }
 134
 135 bool
 136 Layer_TimeLoop::set_version(const String &ver)
 137 {
 138         if (ver=="0.1")
 139                 old_version = true;
 140
 141         return true;
 142 }
 143
 144 void
 145 Layer_TimeLoop::reset_version()
 146 {
 147         // if we're not converting from an old version of the layer, there's nothing to do
 148         if (!old_version)
 149                 return;
 150
 151         old_version = false;
 152
 153         // these are the conversions to go from 0.1 to 0.2:
 154         //
 155         //       local_time = start_time
 156         //       duration = end_time - start_time
 157         //       if (time < start_time)
 158         //         link_time = -duration : if we want to reproduce the old behaviour - do we?
 159         //       else
 160         //               link_time = 0
 161
 162         // convert the static parameters
 163         local_time = start_time;
 164         duration = end_time - start_time;
 165         only_for_positive_duration = true;
 166
 167         //! \todo layer version 0.1 acted differently before start_time was reached - possibly due to a bug
 168         link_time = 0;
 169
 170         // convert the dynamic parameters
 171         const DynamicParamList &dpl = dynamic_param_list();
 172
 173         // if neither start_time nor end_time are dynamic, there's nothing more to do
 174         if (dpl.count("start_time") == 0 && dpl.count("end_time") == 0)
 175                 return;
 176
 177         etl::rhandle<ValueNode> start_time_value_node, end_time_value_node;
 178         LinkableValueNode* duration_value_node;
 179
 180         if (dpl.count("start_time"))
 181         {
 182                 start_time_value_node = dpl.find("start_time")->second;
 183                 disconnect_dynamic_param("start_time");
 184         }
 185         else
 186                 start_time_value_node = ValueNode_Const::create(start_time);
 187
 188         if (dpl.count("end_time"))
 189         {
 190                 end_time_value_node = dpl.find("end_time")->second;
 191                 disconnect_dynamic_param("end_time");
 192         }
 193         else
 194                 end_time_value_node = ValueNode_Const::create(end_time);
 195
 196         duration_value_node = ValueNode_Subtract::create(Time(0));
 197         duration_value_node->set_link("lhs", end_time_value_node);
 198         duration_value_node->set_link("rhs", start_time_value_node);
 199
 200         connect_dynamic_param("local_time", start_time_value_node);
 201         connect_dynamic_param("duration",   duration_value_node);
 202 }
 203
 204 void
 205 Layer_TimeLoop::set_time(Context context, Time t)const
 206 {
 207         if (only_for_positive_duration && duration <= 0)
 208                 ;                                               // don't change the time
 209         else if (duration == 0)
 210                 t = link_time;
 211         else if (duration > 0)
 212         {
 213                 t -= local_time;
 214                 t -= floor(t / duration) * duration;
 215                 t  = link_time + t;
 216         }
 217         else
 218         {
 219                 t -= local_time;
 220                 t -= floor(t / -duration) * -duration;
 221                 t  = link_time - t;
 222         }
 223
 224         context.set_time(t);
 225 }
 226
 227 Color
 228 Layer_TimeLoop::get_color(Context context, const Point &pos)const
 229 {
 230         return context.get_color(pos);
 231 }
 232
 233 bool
 234 Layer_TimeLoop::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
 235 {
 236         return context.accelerated_render(surface,quality,renddesc,cb);
 237 }