synfig-core/src/synfig/valuenode_log.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file valuenode_log.cpp
   3 **      \brief Implementation of the "Natural Logarithm" 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 **  Copyright (c) 2008 Carlos López
  11 **
  12 **      This package is free software; you can redistribute it and/or
  13 **      modify it under the terms of the GNU General Public License as
  14 **      published by the Free Software Foundation; either version 2 of
  15 **      the License, or (at your option) any later version.
  16 **
  17 **      This package is distributed in the hope that it will be useful,
  18 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20 **      General Public License for more details.
  21 **      \endlegal
  22 */
  23 /* ========================================================================= */
  24
  25 /* === H E A D E R S ======================================================= */
  26
  27 #ifdef USING_PCH
  28 #       include "pch.h"
  29 #else
  30 #ifdef HAVE_CONFIG_H
  31 #       include <config.h>
  32 #endif
  33
  34 #include "valuenode_log.h"
  35 #include "valuenode_const.h"
  36 #include "general.h"
  37
  38 #endif
  39
  40 /* === U S I N G =========================================================== */
  41
  42 using namespace std;
  43 using namespace etl;
  44 using namespace synfig;
  45
  46 /* === M A C R O S ========================================================= */
  47
  48 /* === G L O B A L S ======================================================= */
  49
  50 /* === P R O C E D U R E S ================================================= */
  51
  52 /* === M E T H O D S ======================================================= */
  53
  54 ValueNode_Logarithm::ValueNode_Logarithm(const ValueBase &x):
  55         LinkableValueNode(x.get_type())
  56 {
  57         Real value(x.get(Real()));
  58         Real infinity(999999.0);
  59         Real epsilon(0.000001);
  60
  61         value = exp(value);
  62
  63         set_link("link",     ValueNode_Const::create(Real(value)));
  64         set_link("epsilon",  ValueNode_Const::create(Real(epsilon)));
  65         set_link("infinite", ValueNode_Const::create(Real(infinity)));
  66 }
  67
  68 ValueNode_Logarithm*
  69 ValueNode_Logarithm::create(const ValueBase &x)
  70 {
  71         return new ValueNode_Logarithm(x);
  72 }
  73
  74 LinkableValueNode*
  75 ValueNode_Logarithm::create_new()const
  76 {
  77         return new ValueNode_Logarithm(get_type());
  78 }
  79
  80 ValueNode_Logarithm::~ValueNode_Logarithm()
  81 {
  82         unlink_all();
  83 }
  84
  85 bool
  86 ValueNode_Logarithm::set_link_vfunc(int i,ValueNode::Handle value)
  87 {
  88         assert(i>=0 && i<link_count());
  89
  90         switch(i)
  91         {
  92         case 0: CHECK_TYPE_AND_SET_VALUE(link_,     ValueBase::TYPE_REAL);
  93         case 1: CHECK_TYPE_AND_SET_VALUE(epsilon_,  ValueBase::TYPE_REAL);
  94         case 2: CHECK_TYPE_AND_SET_VALUE(infinite_, ValueBase::TYPE_REAL);
  95         }
  96         return false;
  97 }
  98
  99 ValueNode::LooseHandle
 100 ValueNode_Logarithm::get_link_vfunc(int i)const
 101 {
 102         assert(i>=0 && i<link_count());
 103
 104         if(i==0) return link_;
 105         if(i==1) return epsilon_;
 106         if(i==2) return infinite_;
 107
 108         return 0;
 109 }
 110
 111 int
 112 ValueNode_Logarithm::link_count()const
 113 {
 114         return 3;
 115 }
 116
 117 String
 118 ValueNode_Logarithm::link_local_name(int i)const
 119 {
 120         assert(i>=0 && i<link_count());
 121
 122         if(i==0) return _("Link");
 123         if(i==1) return _("Epsilon");
 124         if(i==2) return _("Infinite");
 125         return String();
 126 }
 127
 128 String
 129 ValueNode_Logarithm::link_name(int i)const
 130 {
 131         assert(i>=0 && i<link_count());
 132
 133         if(i==0) return "link";
 134         if(i==1) return "epsilon";
 135         if(i==2) return "infinite";
 136         return String();
 137 }
 138
 139 int
 140 ValueNode_Logarithm::get_link_index_from_name(const String &name)const
 141 {
 142         if(name=="link")     return 0;
 143         if(name=="epsilon")  return 1;
 144         if(name=="infinite") return 2;
 145
 146         throw Exception::BadLinkName(name);
 147 }
 148
 149 ValueBase
 150 ValueNode_Logarithm::operator()(Time t)const
 151 {
 152         if (getenv("SYNFIG_DEBUG_VALUENODE_OPERATORS"))
 153                 printf("%s:%d operator()\n", __FILE__, __LINE__);
 154
 155         Real link     = (*link_)    (t).get(Real());
 156         Real epsilon  = (*epsilon_) (t).get(Real());
 157         Real infinite = (*infinite_)(t).get(Real());
 158
 159         if (epsilon < 0.00000001)
 160                 epsilon = 0.00000001;
 161
 162         if (link < epsilon)
 163                         return -infinite;
 164         else
 165                 return log(link);
 166 }
 167
 168 String
 169 ValueNode_Logarithm::get_name()const
 170 {
 171         return "logarithm";
 172 }
 173
 174 String
 175 ValueNode_Logarithm::get_local_name()const
 176 {
 177         return _("Logarithm");
 178 }
 179
 180 bool
 181 ValueNode_Logarithm::check_type(ValueBase::Type type)
 182 {
 183         return type==ValueBase::TYPE_REAL;
 184 }
 185
 186 LinkableValueNode::Vocab
 187 ValueNode_Logarithm::get_children_vocab_vfunc()const
 188 {
 189         LinkableValueNode::Vocab ret;
 190
 191         ret.push_back(ParamDesc(ValueBase(),"link")
 192                 .set_local_name(_("Link"))
 193                 .set_description(_("Value node used to calculate the Neperian logarithm"))
 194         );
 195
 196                 ret.push_back(ParamDesc(ValueBase(),"epsilon")
 197                 .set_local_name(_("Epsilon"))
 198                 .set_description(_("Value used to compare 'link' with zero "))
 199         );
 200
 201                 ret.push_back(ParamDesc(ValueBase(),"infinite")
 202                 .set_local_name(_("Infinite"))
 203                 .set_description(_("Returned value when result tends to infinite"))
 204         );
 205
 206         return ret;
 207 }
 208