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