synfig-core/src/modules/mod_noise/valuenode_random.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file valuenode_random.cpp
   3 **      \brief Template File
   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 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include "valuenode_random.h"
  34 #include "synfig/valuenode_const.h"
  35 #include "synfig/general.h"
  36 #include "synfig/color.h"
  37 #include <ETL/misc>
  38
  39 #endif
  40
  41 /* === U S I N G =========================================================== */
  42
  43 using namespace std;
  44 using namespace etl;
  45 using namespace synfig;
  46
  47 /* === M A C R O S ========================================================= */
  48
  49 /* === G L O B A L S ======================================================= */
  50
  51 /* === P R O C E D U R E S ================================================= */
  52
  53 /* === M E T H O D S ======================================================= */
  54
  55 ValueNode_Random::ValueNode_Random(const ValueBase &value):
  56         LinkableValueNode(value.get_type())
  57 {
  58         Vocab ret(get_children_vocab());
  59         set_children_vocab(ret);
  60         random.set_seed(time(NULL));
  61
  62         set_link("radius",ValueNode_Const::create(Real(1)));
  63         set_link("seed",ValueNode_Const::create(random.get_seed()));
  64         set_link("speed",ValueNode_Const::create(Real(1)));
  65         set_link("smooth",ValueNode_Const::create(int(RandomNoise::SMOOTH_CUBIC)));
  66         set_link("loop",ValueNode_Const::create(Real(0)));
  67
  68         switch(get_type())
  69         {
  70         case ValueBase::TYPE_ANGLE:
  71                 set_link("link",ValueNode_Const::create(value.get(Angle())));
  72                 break;
  73         case ValueBase::TYPE_BOOL:
  74                 set_link("link",ValueNode_Const::create(value.get(bool())));
  75                 break;
  76         case ValueBase::TYPE_COLOR:
  77                 set_link("link",ValueNode_Const::create(value.get(Color())));
  78                 break;
  79         case ValueBase::TYPE_INTEGER:
  80                 set_link("link",ValueNode_Const::create(value.get(int())));
  81                 break;
  82         case ValueBase::TYPE_REAL:
  83                 set_link("link",ValueNode_Const::create(value.get(Real())));
  84                 break;
  85         case ValueBase::TYPE_TIME:
  86                 set_link("link",ValueNode_Const::create(value.get(Time())));
  87                 break;
  88         case ValueBase::TYPE_VECTOR:
  89                 set_link("link",ValueNode_Const::create(value.get(Vector())));
  90                 break;
  91         default:
  92                 throw Exception::BadType(ValueBase::type_local_name(get_type()));
  93         }
  94 }
  95
  96 LinkableValueNode*
  97 ValueNode_Random::create_new()const
  98 {
  99         return new ValueNode_Random(get_type());
 100 }
 101
 102 ValueNode_Random*
 103 ValueNode_Random::create(const ValueBase &x)
 104 {
 105         return new ValueNode_Random(x);
 106 }
 107
 108 ValueNode_Random::~ValueNode_Random()
 109 {
 110         unlink_all();
 111 }
 112
 113 ValueBase
 114 ValueNode_Random::operator()(Time t)const
 115 {
 116         typedef const RandomNoise::SmoothType Smooth;
 117
 118         Real    radius  = (*radius_)(t).get(Real());
 119         int             seed    = (*seed_)(t).get(int());
 120         int             smooth  = (*smooth_)(t).get(int());
 121         float   speed   = (*speed_ )(t).get(Real());
 122         int             loop    = int((((*loop_ )(t).get(Real())) * speed) + 0.5);
 123         speed *= t;
 124
 125         random.set_seed(seed);
 126
 127         switch(get_type())
 128         {
 129         case ValueBase::TYPE_ANGLE:
 130                 return ((*link_)(t).get( Angle()) +
 131                                 Angle::deg(random(Smooth(smooth), 0, 0, 0, speed, loop) * radius));
 132
 133         case ValueBase::TYPE_BOOL:
 134                 return round_to_int((*link_)(t).get(  bool()) +
 135                                                         random(Smooth(smooth), 0, 0, 0, speed, loop) * radius) > 0;
 136
 137         case ValueBase::TYPE_COLOR:
 138                 return (((*link_)(t).get( Color()) +
 139                                  Color(random(Smooth(smooth), 0, 0, 0, speed, loop),
 140                                            random(Smooth(smooth), 1, 0, 0, speed, loop),
 141                                            random(Smooth(smooth), 2, 0, 0, speed, loop), 0) * radius).clamped());
 142
 143         case ValueBase::TYPE_INTEGER:
 144                 return round_to_int((*link_)(t).get(   int()) +
 145                                                         random(Smooth(smooth), 0, 0, 0, speed, loop) * radius);
 146
 147         case ValueBase::TYPE_REAL:
 148                 return ((*link_)(t).get(  Real()) +
 149                                 random(Smooth(smooth), 0, 0, 0, speed, loop) * radius);
 150
 151         case ValueBase::TYPE_TIME:
 152                 return ((*link_)(t).get(  Time()) +
 153                                 random(Smooth(smooth), 0, 0, 0, speed, loop) * radius);
 154
 155         case ValueBase::TYPE_VECTOR:
 156         {
 157                 float length(random(Smooth(smooth), 0, 0, 0, speed, loop) * radius);
 158                 Angle::rad angle(random(Smooth(smooth), 1, 0, 0, speed, loop) * PI);
 159
 160                 return ((*link_)(t).get(Vector()) +
 161                                 Vector(Angle::cos(angle).get(), Angle::sin(angle).get()) * length);
 162         }
 163
 164         default:
 165                 assert(0);
 166                 break;
 167         }
 168
 169         return ValueBase();
 170 }
 171
 172
 173 String
 174 ValueNode_Random::get_name()const
 175 {
 176         return "random";
 177 }
 178
 179 String
 180 ValueNode_Random::get_local_name()const
 181 {
 182         return _("Random");
 183 }
 184
 185 bool
 186 ValueNode_Random::set_link_vfunc(int i,ValueNode::Handle value)
 187 {
 188         assert(i>=0 && i<link_count());
 189
 190         switch(i)
 191         {
 192         case 0: CHECK_TYPE_AND_SET_VALUE(link_,   get_type());
 193         case 1: CHECK_TYPE_AND_SET_VALUE(radius_, ValueBase::TYPE_REAL);
 194         case 2: CHECK_TYPE_AND_SET_VALUE(seed_,   ValueBase::TYPE_INTEGER);
 195         case 3: CHECK_TYPE_AND_SET_VALUE(speed_,  ValueBase::TYPE_REAL);
 196         case 4: CHECK_TYPE_AND_SET_VALUE(smooth_, ValueBase::TYPE_INTEGER);
 197         case 5: CHECK_TYPE_AND_SET_VALUE(loop_,  ValueBase::TYPE_REAL);
 198         }
 199         return false;
 200 }
 201
 202 ValueNode::LooseHandle
 203 ValueNode_Random::get_link_vfunc(int i)const
 204 {
 205         assert(i>=0 && i<link_count());
 206
 207         switch(i)
 208         {
 209         case 0: return link_;
 210         case 1: return radius_;
 211         case 2: return seed_;
 212         case 3: return speed_;
 213         case 4: return smooth_;
 214         case 5: return loop_;
 215         }
 216         return 0;
 217 }
 218
 219 int
 220 ValueNode_Random::link_count()const
 221 {
 222         return 6;
 223 }
 224
 225 String
 226 ValueNode_Random::link_name(int i)const
 227 {
 228         assert(i>=0 && i<link_count());
 229
 230         switch(i)
 231         {
 232         case 0: return "link";
 233         case 1: return "radius";
 234         case 2: return "seed";
 235         case 3: return "speed";
 236         case 4: return "smooth";
 237         case 5: return "loop";
 238         }
 239         return String();
 240 }
 241
 242 String
 243 ValueNode_Random::link_local_name(int i)const
 244 {
 245         assert(i>=0 && i<link_count());
 246
 247         switch(i)
 248         {
 249         case 0: return _("Link");
 250         case 1: return _("Radius");
 251         case 2: return _("Seed");
 252         case 3: return _("Animation Speed");
 253         case 4: return _("Interpolation");
 254         case 5: return _("Loop Time");
 255         }
 256         return String();
 257 }
 258
 259 int
 260 ValueNode_Random::get_link_index_from_name(const String &name)const
 261 {
 262         if(name=="link"  ) return 0;
 263         if(name=="radius") return 1;
 264         if(name=="seed"  ) return 2;
 265         if(name=="speed" ) return 3;
 266         if(name=="smooth") return 4;
 267         if(name=="loop"  ) return 5;
 268         throw Exception::BadLinkName(name);
 269 }
 270
 271 bool
 272 ValueNode_Random::check_type(ValueBase::Type type)
 273 {
 274         return
 275                 type==ValueBase::TYPE_ANGLE             ||
 276                 type==ValueBase::TYPE_BOOL              ||
 277                 type==ValueBase::TYPE_COLOR             ||
 278                 type==ValueBase::TYPE_INTEGER   ||
 279                 type==ValueBase::TYPE_REAL              ||
 280                 type==ValueBase::TYPE_TIME              ||
 281                 type==ValueBase::TYPE_VECTOR    ;
 282 }
 283
 284 ValueNode*
 285 ValueNode_Random::clone(const GUID& deriv_guid)const
 286 {
 287         ValueNode_Random* ret = (ValueNode_Random*)LinkableValueNode::clone(deriv_guid);
 288         ret->randomize_seed();
 289         return ret;
 290 }
 291
 292 void
 293 ValueNode_Random::randomize_seed()
 294 {
 295         int i = get_link_index_from_name("seed");
 296         ValueNode::Handle link = get_link_vfunc(i);
 297         if(!link->is_exported() && link->get_name() == "constant")
 298         {
 299                 int seed = time(NULL) + rand();
 300                 if (seed < 0) seed = -seed;
 301                 random.set_seed(seed);
 302                 set_link(i, ValueNode_Const::create(seed));
 303         }
 304 }
 305
 306 LinkableValueNode::Vocab
 307 ValueNode_Random::get_children_vocab_vfunc()const
 308 {
 309         if(children_vocab.size())
 310                 return children_vocab;
 311
 312         LinkableValueNode::Vocab ret;
 313
 314         ret.push_back(ParamDesc(ValueBase(),"link")
 315                 .set_local_name(_("Link"))
 316                 .set_description(_("The value node source that provides the central value"))
 317         );
 318
 319         ret.push_back(ParamDesc(ValueBase(),"radius")
 320                 .set_local_name(_("Radius"))
 321                 .set_description(_("The value of the maximum random difference"))
 322         );
 323
 324         ret.push_back(ParamDesc(ValueBase(),"seed")
 325                 .set_local_name(_("Seed"))
 326                 .set_description(_("Seeds the random number generator"))
 327         );
 328
 329         ret.push_back(ParamDesc(ValueBase(),"speed")
 330                 .set_local_name(_("Speed"))
 331                 .set_description(_("Defines how often a new random value is chosen (in choices per second) "))
 332         );
 333
 334         ret.push_back(ParamDesc(ValueBase(),"smooth")
 335                 .set_local_name(_("Interpolation"))
 336                 .set_description(_("Determines how the value is interpolated from one random choice to the next"))
 337                 .set_hint("enum")
 338                 .add_enum_value(RandomNoise::SMOOTH_DEFAULT,"default",_("No interpolation"))
 339                 .add_enum_value(RandomNoise::SMOOTH_LINEAR,"linear",_("Linear"))
 340                 .add_enum_value(RandomNoise::SMOOTH_COSINE,"cosine",_("Cosine"))
 341                 .add_enum_value(RandomNoise::SMOOTH_SPLINE,"spline",_("Spline"))
 342                 .add_enum_value(RandomNoise::SMOOTH_CUBIC,"cubic",_("Cubic"))
 343         );
 344
 345
 346         ret.push_back(ParamDesc(ValueBase(),"loop")
 347                 .set_local_name(_("Loop Time"))
 348                 .set_description(_("Makes the random value repeat after the given time"))
 349         );
 350         return ret;
 351 }