synfig-studio/trunk/src/synfigapp/value_desc.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file value_desc.h
   3 **      \brief Template Header
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **
  10 **      This package is free software; you can redistribute it and/or
  11 **      modify it under the terms of the GNU General Public License as
  12 **      published by the Free Software Foundation; either version 2 of
  13 **      the License, or (at your option) any later version.
  14 **
  15 **      This package is distributed in the hope that it will be useful,
  16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 **      General Public License for more details.
  19 **      \endlegal
  20 */
  21 /* ========================================================================= */
  22
  23 /* === S T A R T =========================================================== */
  24
  25 #ifndef __SYNFIG_APP_VALUE_DESC_H
  26 #define __SYNFIG_APP_VALUE_DESC_H
  27
  28 /* === H E A D E R S ======================================================= */
  29
  30 #include <synfig/valuenode.h>
  31 #include <synfig/string.h>
  32 #include <synfig/layer.h>
  33 #include <synfig/value.h>
  34 #include <synfig/valuenode_const.h>
  35 #include <synfig/canvas.h>
  36
  37 /* === M A C R O S ========================================================= */
  38
  39 /* === T Y P E D E F S ===================================================== */
  40
  41 /* === C L A S S E S & S T R U C T S ======================================= */
  42
  43 namespace synfigapp {
  44
  45 class ValueDesc
  46 {
  47         // Info for Layer parent
  48         synfig::Layer::Handle layer;
  49         synfig::String name;
  50
  51         // Info for ValueNode parent
  52         synfig::ValueNode::Handle parent_value_node;
  53         int index;
  54
  55         // Info for exported ValueNode
  56         synfig::Canvas::Handle canvas;
  57
  58 public:
  59         bool operator==(const ValueDesc &rhs)const
  60         {
  61                 if((layer||rhs.layer) && layer!=rhs.layer)
  62                         return false;
  63                 if((!name.empty()||!rhs.name.empty()) && name!=rhs.name)
  64                         return false;
  65                 if(layer)
  66                         return true;
  67                 if((canvas||rhs.canvas) && canvas!=rhs.canvas)
  68                         return false;
  69                 if((parent_value_node||rhs.parent_value_node) && parent_value_node!=rhs.parent_value_node)
  70                         return false;
  71                 if((index>-1||rhs.index>-1) && index!=rhs.index)
  72                         return false;
  73                 return true;
  74         }
  75         bool operator!=(const ValueDesc &rhs)const
  76         {
  77                 return !operator==(rhs);
  78         }
  79
  80
  81         ValueDesc(synfig::Layer::Handle layer,const synfig::String& param_name):
  82                 layer(layer),
  83                 name(param_name) { }
  84
  85         ValueDesc(synfig::Layer::LooseHandle layer,const synfig::String& param_name):
  86                 layer(layer),
  87                 name(param_name) { }
  88
  89         ValueDesc(synfig::LinkableValueNode::Handle parent_value_node,int index):
  90                 parent_value_node(parent_value_node),
  91                 index(index) { }
  92
  93 //      ValueDesc(synfig::LinkableValueNode::Handle parent_value_node,const synfig::String& param_name):
  94 //              parent_value_node(parent_value_node),
  95 //              index(parent_value_node->get_link_index_from_name(param_name)) { }
  96
  97         ValueDesc(synfig::Canvas::Handle canvas,const synfig::String& name):
  98                 name(name),
  99                 canvas(canvas) { }
 100
 101         ValueDesc(synfig::ValueNode_Const::Handle parent_value_node):
 102                 parent_value_node(parent_value_node),
 103                 index(-1) { }
 104
 105         ValueDesc() { }
 106
 107         bool is_valid()const { return layer || parent_value_node || canvas; }
 108         operator bool()const { return is_valid(); }
 109
 110         bool parent_is_layer_param()const { return (bool)layer; }
 111         bool parent_is_value_node()const { return (bool)parent_value_node; }
 112         bool parent_is_linkable_value_node()const { return parent_is_value_node() && index>=0; }
 113         bool parent_is_value_node_const()const { return parent_is_value_node() && index==-1; }
 114         bool parent_is_canvas()const { return (bool)canvas; }
 115
 116         bool is_value_node()const { return parent_is_value_node() || parent_is_canvas() || (parent_is_layer_param() && (bool)layer->dynamic_param_list().count(name)); }
 117         bool is_const()const { return (parent_is_layer_param() && !layer->dynamic_param_list().count(name)) || parent_is_value_node_const(); }
 118
 119         synfig::Layer::Handle get_layer()const { assert(parent_is_layer_param()); return layer; }
 120         const synfig::String& get_param_name()const { assert(parent_is_layer_param()); return name; }
 121
 122         synfig::ValueNode::Handle get_parent_value_node()const { assert(parent_is_value_node()); return parent_value_node; }
 123         int get_index()const { assert(parent_is_linkable_value_node()); return index; }
 124
 125         const synfig::String& get_value_node_id()const { assert(parent_is_canvas()); return name; }
 126
 127         synfig::Canvas::Handle get_canvas()const
 128         {
 129                 if(canvas)
 130                         return canvas;
 131                 if(layer)
 132                         return layer->get_canvas();
 133                 if(parent_value_node)
 134                         return parent_value_node->get_root_canvas();
 135                 return 0;
 136         }
 137
 138         synfig::ValueNode::Handle
 139         get_value_node()const
 140         {
 141                 if(parent_is_canvas())
 142                         return canvas->find_value_node(name);
 143                 if(parent_is_layer_param() && layer->dynamic_param_list().count(name))
 144                         return layer->dynamic_param_list().find(name)->second;
 145                 if(parent_is_linkable_value_node())
 146                         return synfig::LinkableValueNode::Handle::cast_reinterpret(parent_value_node)->get_link(index);
 147 //                      return reinterpret_cast<synfig::LinkableValueNode*>(parent_value_node.get())->get_link(index);
 148                 return 0;
 149         }
 150
 151         synfig::ValueBase
 152         get_value(synfig::Time time=0)const
 153         {
 154                 if(parent_is_value_node_const() && parent_value_node)
 155                         // \todo "(*parent_value_node)(0)"?  shouldn't that be "(*parent_value_node)(time)"?
 156                         return (*parent_value_node)(0);
 157                 if(is_value_node() && get_value_node())
 158                         return (*get_value_node())(time);
 159                 if(parent_is_layer_param() && layer)
 160                         return layer->get_param(name);
 161                 return synfig::ValueBase();
 162         }
 163
 164         synfig::ValueBase::Type
 165         get_value_type()const
 166         {
 167                 synfig::ValueNode::Handle value_node=get_value_node();
 168                 if(value_node)
 169                         return value_node->get_type();
 170                 return get_value().get_type();
 171         }
 172
 173         bool
 174         is_exported()const
 175         {
 176                 return is_value_node() && get_value_node()->is_exported();
 177         }
 178
 179         synfig::String
 180         get_description(bool show_exported_name = true)const;
 181 }; // END of class ValueDesc
 182
 183 }; // END of namespace synfigapp_instance
 184
 185 /* === E N D =============================================================== */
 186
 187 #endif