synfig-core/src/synfig/valuenode_range.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file valuenode_range.cpp
   3 **      \brief Implementation of the "Range" valuenode conversion.
   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 "general.h"
  34 #include "valuenode_range.h"
  35 #include "valuenode_const.h"
  36 #include <stdexcept>
  37 #include "vector.h"
  38 #include "angle.h"
  39 #include "real.h"
  40
  41 #endif
  42
  43 /* === U S I N G =========================================================== */
  44
  45 using namespace std;
  46 using namespace etl;
  47 using namespace synfig;
  48
  49 /* === M A C R O S ========================================================= */
  50
  51 /* === G L O B A L S ======================================================= */
  52
  53 /* === P R O C E D U R E S ================================================= */
  54
  55 /* === M E T H O D S ======================================================= */
  56
  57 synfig::ValueNode_Range::ValueNode_Range(const ValueBase &value):
  58         LinkableValueNode(value.get_type())
  59 {
  60         ValueBase::Type id(value.get_type());
  61
  62         switch(id)
  63         {
  64         case ValueBase::TYPE_ANGLE:
  65                 set_link("min",ValueNode_Const::create(value.get(Angle())));
  66                 set_link("max",ValueNode_Const::create(value.get(Angle())));
  67                 set_link("link",ValueNode_Const::create(value.get(Angle())));
  68                 break;
  69         case ValueBase::TYPE_INTEGER:
  70                 set_link("min",ValueNode_Const::create(value.get(int())));
  71                 set_link("max",ValueNode_Const::create(value.get(int())));
  72                 set_link("link",ValueNode_Const::create(value.get(int())));
  73                 break;
  74         case ValueBase::TYPE_REAL:
  75                 set_link("min",ValueNode_Const::create(value.get(Real())));
  76                 set_link("max",ValueNode_Const::create(value.get(Real())));
  77                 set_link("link",ValueNode_Const::create(value.get(Real())));
  78                 break;
  79         case ValueBase::TYPE_TIME:
  80                 set_link("min",ValueNode_Const::create(value.get(Time())));
  81                 set_link("max",ValueNode_Const::create(value.get(Time())));
  82                 set_link("link",ValueNode_Const::create(value.get(Time())));
  83                 break;
  84         default:
  85                 assert(0);
  86                 throw runtime_error(get_local_name()+_(":Bad type ")+ValueBase::type_local_name(id));
  87         }
  88
  89         assert(min_->get_type()==id);
  90         assert(max_->get_type()==id);
  91         assert(link_->get_type()==id);
  92         assert(get_type()==id);
  93
  94         DCAST_HACK_ENABLE();
  95 }
  96
  97 LinkableValueNode*
  98 ValueNode_Range::create_new()const
  99 {
 100         return new ValueNode_Range(get_type());
 101 }
 102
 103 ValueNode_Range*
 104 ValueNode_Range::create(const ValueBase& value)
 105 {
 106         return new ValueNode_Range(value);
 107 }
 108
 109 synfig::ValueNode_Range::~ValueNode_Range()
 110 {
 111         unlink_all();
 112 }
 113
 114 synfig::ValueBase
 115 synfig::ValueNode_Range::operator()(Time t)const
 116 {
 117         if (getenv("SYNFIG_DEBUG_VALUENODE_OPERATORS"))
 118                 printf("%s:%d operator()\n", __FILE__, __LINE__);
 119
 120         if(!min_ || !max_ || !link_)
 121                 throw runtime_error(strprintf("ValueNode_Range: %s",_("Some of my parameters aren't set!")));
 122
 123         switch(get_type())
 124         {
 125         case ValueBase::TYPE_ANGLE:
 126         {
 127                 Angle minimum = (* min_)(t).get(Angle());
 128                 Angle maximum = (* max_)(t).get(Angle());
 129                 Angle link    = (*link_)(t).get(Angle());
 130 // This code was removed because it didn't work with link < minimum
 131 // It is sane to completely delete it if the replacement code is fine.
 132 /* ***********************************************
 133                 // if link is between min and max, use it
 134                 if (Angle::deg((link-minimum).mod()).get() < Angle::deg((maximum-minimum).mod()).get())
 135                         return link;
 136                 // otherwise use whichever of min and max is closest to link
 137                 else if (link.dist(minimum).abs() < link.dist(maximum).abs())
 138                         return minimum;
 139                 else
 140                         return maximum;
 141 *********************************************** */
 142                 if(Angle::rad(maximum).get()>=Angle::rad(link).get() && Angle::rad(link).get()>=Angle::rad(minimum).get())
 143                         return link;
 144                 else if (Angle::rad(minimum).get()>Angle::rad(link).get())
 145                         return minimum;
 146                 else
 147                         return maximum;
 148         }
 149         case ValueBase::TYPE_INTEGER:
 150                 return std::max((*min_)(t).get(int()),  std::min((*max_)(t).get(int()),  (*link_)(t).get(int())));
 151         case ValueBase::TYPE_REAL:
 152                 return std::max((*min_)(t).get(Real()), std::min((*max_)(t).get(Real()), (*link_)(t).get(Real())));
 153         case ValueBase::TYPE_TIME:
 154                 return std::max((*min_)(t).get(Time()), std::min((*max_)(t).get(Time()), (*link_)(t).get(Time())));
 155         default:
 156                 assert(0);
 157                 break;
 158         }
 159         return ValueBase();
 160 }
 161
 162 synfig::ValueBase
 163 synfig::ValueNode_Range::get_inverse(Time t, const synfig::Vector &target_value) const
 164 {
 165         switch (get_type())
 166         {
 167                 case ValueBase::TYPE_INTEGER:
 168                         {
 169                         int max_value((*max_)(t).get(int()));
 170                         int min_value((*min_)(t).get(int()));
 171                         return std::max(min_value, std::min(max_value, int(target_value.mag())));
 172                         }
 173                 case ValueBase::TYPE_REAL:
 174                         {
 175                         Real max_value((*max_)(t).get(Real()));
 176                         Real min_value((*min_)(t).get(Real()));
 177                         return std::max(min_value, std::min(max_value, target_value.mag()));
 178                         }
 179                 case ValueBase::TYPE_ANGLE:
 180                         {
 181                         Angle max_value((*max_)(t).get(Angle()));
 182                         Angle min_value((*min_)(t).get(Angle()));
 183                         Angle target_angle(Angle::tan(target_value[1],target_value[0]));
 184                         return target_angle>max_value?max_value:target_angle<min_value?min_value:target_angle;
 185                         }
 186                 case ValueBase::TYPE_TIME:
 187                         {
 188                         Real max_value((*max_)(t).get(Time()));
 189                         Real min_value((*min_)(t).get(Time()));
 190                         return std::max(min_value, std::min(max_value, target_value.mag()));
 191                         }
 192                 default:
 193                         return target_value;
 194         }
 195         return ValueBase();
 196 }
 197
 198 synfig::ValueBase
 199 synfig::ValueNode_Range::get_inverse(Time t, const synfig::Angle &target_value) const
 200 {
 201         Angle minimum = (* min_)(t).get(Angle());
 202         Angle maximum = (* max_)(t).get(Angle());
 203         Angle link = (*link_)(t).get(Angle());
 204                 switch (get_type())
 205                 {
 206                         default:
 207                 // Notice that target_value is the rotation between the current
 208                 // 'link' value and the target angle in the canvas, so we need
 209                 // to add it to 'link'
 210                 if(Angle::rad(maximum).get()>=Angle::rad(link+target_value).get() && Angle::rad(link+target_value).get()>=Angle::rad(minimum).get())
 211                         return link + target_value;
 212                 else if (Angle::rad(minimum).get()>Angle::rad(target_value).get())
 213                         return minimum;
 214                 else
 215                         return maximum;
 216                 }
 217         return ValueBase();
 218 }
 219
 220
 221 bool
 222 ValueNode_Range::set_link_vfunc(int i,ValueNode::Handle value)
 223 {
 224         assert(i>=0 && i<link_count());
 225
 226         switch(i)
 227         {
 228         case 0: CHECK_TYPE_AND_SET_VALUE(min_,  get_type());
 229         case 1: CHECK_TYPE_AND_SET_VALUE(max_,  get_type());
 230         case 2: CHECK_TYPE_AND_SET_VALUE(link_, get_type());
 231         }
 232         return false;
 233 }
 234
 235 ValueNode::LooseHandle
 236 ValueNode_Range::get_link_vfunc(int i)const
 237 {
 238         assert(i>=0 && i<link_count());
 239
 240         switch(i)
 241         {
 242                 case 0: return min_;
 243                 case 1: return max_;
 244                 case 2: return link_;
 245                 default: return 0;
 246         }
 247 }
 248
 249 int
 250 ValueNode_Range::link_count()const
 251 {
 252         return 3;
 253 }
 254
 255 String
 256 ValueNode_Range::link_local_name(int i)const
 257 {
 258         assert(i>=0 && i<link_count());
 259
 260         switch(i)
 261         {
 262                 case 0: return _("Min");
 263                 case 1: return _("Max");
 264                 case 2: return _("Link");
 265                 default: return String();
 266         }
 267 }
 268
 269 String
 270 ValueNode_Range::link_name(int i)const
 271 {
 272         assert(i>=0 && i<link_count());
 273
 274         switch(i)
 275         {
 276                 case 0: return "min";
 277                 case 1: return "max";
 278                 case 2: return "link";
 279                 default: return String();
 280         }
 281 }
 282
 283 int
 284 ValueNode_Range::get_link_index_from_name(const String &name)const
 285 {
 286         if(name=="min") return 0;
 287         if(name=="max") return 1;
 288         if(name=="link") return 2;
 289         throw Exception::BadLinkName(name);
 290 }
 291
 292 String
 293 ValueNode_Range::get_name()const
 294 {
 295         return "range";
 296 }
 297
 298 String
 299 ValueNode_Range::get_local_name()const
 300 {
 301         return _("Range");
 302 }
 303
 304 bool
 305 ValueNode_Range::check_type(ValueBase::Type type)
 306 {
 307         return type==ValueBase::TYPE_ANGLE
 308                 || type==ValueBase::TYPE_INTEGER
 309                 || type==ValueBase::TYPE_REAL
 310                 || type==ValueBase::TYPE_TIME;
 311 }