source: synfigstudio/trunk/fuentes/src/synfigapp/actions/valuedesclink.cpp @ 481

Last change on this file since 481 was 481, checked in by jrpelegrina, 4 years ago

First release to xenial

File size: 19.9 KB
Line 
1/* === S Y N F I G ========================================================= */
2/*!     \file valuedesclink.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**      Copyright (c) 2010, 2011 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 "valuedesclink.h"
35
36#include <synfigapp/canvasinterface.h>
37#include <synfig/valuenodes/valuenode_const.h>
38#include <synfig/valuenodes/valuenode_scale.h>
39#include <synfig/valuenodes/valuenode_composite.h>
40
41#include <synfigapp/general.h>
42#include <zconf.h>
43
44#endif
45
46using namespace std;
47using namespace etl;
48using namespace synfig;
49using namespace synfigapp;
50using namespace Action;
51
52/* === M A C R O S ========================================================= */
53
54ACTION_INIT(Action::ValueDescLink);
55ACTION_SET_NAME(Action::ValueDescLink,"ValueDescLink");
56ACTION_SET_LOCAL_NAME(Action::ValueDescLink,N_("Link"));
57ACTION_SET_TASK(Action::ValueDescLink,"connect");
58ACTION_SET_CATEGORY(Action::ValueDescLink,Action::CATEGORY_VALUEDESC);
59ACTION_SET_PRIORITY(Action::ValueDescLink,0);
60ACTION_SET_VERSION(Action::ValueDescLink,"0.0");
61ACTION_SET_CVS_ID(Action::ValueDescLink,"$Id$");
62
63ACTION_INIT(Action::ValueDescLinkOpposite);
64ACTION_SET_NAME(Action::ValueDescLinkOpposite,"ValueDescLinkOpposite");
65ACTION_SET_LOCAL_NAME(Action::ValueDescLinkOpposite,N_("Link Opposite"));
66ACTION_SET_TASK(Action::ValueDescLinkOpposite,"connect");
67ACTION_SET_CATEGORY(Action::ValueDescLinkOpposite,Action::CATEGORY_VALUEDESC);
68ACTION_SET_PRIORITY(Action::ValueDescLinkOpposite,0);
69ACTION_SET_VERSION(Action::ValueDescLinkOpposite,"0.0");
70ACTION_SET_CVS_ID(Action::ValueDescLinkOpposite,"$Id$");
71
72/* === G L O B A L S ======================================================= */
73
74/* === P R O C E D U R E S ================================================= */
75
76/* === M E T H O D S ======================================================= */
77
78Action::ValueDescLink::ValueDescLink():
79poison(false), status_level(0), link_scalar(0.0), link_opposite(false)
80{
81}
82
83Action::ParamVocab
84Action::ValueDescLink::get_param_vocab()
85{
86        ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
87
88        ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
89                .set_local_name(_("ValueDesc to smart link"))
90                .set_requires_multiple()
91        );
92
93        return ret;
94}
95
96bool
97Action::ValueDescLink::is_candidate(const ParamList &x)
98{
99        return candidate_check(get_param_vocab(),x);
100}
101
102bool
103Action::ValueDescLink::set_param(const synfig::String& name, const Action::Param &param)
104{
105        if(name=="time" && param.get_type()==Param::TYPE_TIME)
106        {
107                time=param.get_time();
108                return true;
109        }
110
111        // don't bother looking for the best value to use if there's already been an error
112        if (poison==true) return false;
113
114        if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
115        {
116                ValueDesc value_desc(param.get_value_desc());
117                // If we are handling a Composite WidthPoint then use its position as param
118                if(value_desc.is_value_node() && value_desc.parent_is_linkable_value_node())
119                {
120                        synfig::ValueNode_Composite::Handle compo(synfig::ValueNode_Composite::Handle::cast_dynamic(value_desc.get_value_node()));
121                        if(compo)
122                        {
123                                String param_name;
124                                if (value_desc.parent_is_value_desc() && !value_desc.get_sub_name().empty())
125                                {
126                                        LinkableValueNode::Vocab vocab = compo->get_children_vocab();
127                                        for(LinkableValueNode::Vocab::const_iterator i = vocab.begin(); i != vocab.end(); ++i)
128                                                if (i->get_name() == value_desc.get_sub_name())
129                                                        param_name = value_desc.get_sub_name();
130                                }
131                               
132                                //! Test used for with point handle
133                                if (param_name.empty() && compo->get_type() == type_width_point)
134                                        param_name = "position";
135
136                                if (param_name.empty() && compo->get_type() == type_bline_point)
137                                        param_name = "point";
138                               
139                                if ( compo->get_type() == type_bline_point
140                                  && param_name == "t2"
141                                  && (*compo)(time).get(BLinePoint()).get_merge_tangent_both())
142                                {
143                                        param_name = "t1";
144                                }
145                               
146                                if (!param_name.empty())
147                                {
148                                        synfigapp::Action::Param param(synfigapp::ValueDesc(compo, compo->get_link_index_from_name(param_name)));
149                                        return set_param("value_desc", param);
150                                }
151                        }
152                }
153
154                if(value_desc.is_value_node() && value_desc.get_value_node()->is_exported())
155                {
156                        if(link_value_node==value_desc.get_value_node())
157                                return true;
158
159                        if(link_value_node && link_value_node->is_exported())
160                        {
161                                poison=true;
162                                status_message = (_("Cannot link two different exported values ('") +
163                                                                  value_desc.get_value_node()->get_id() + _("' and '") +
164                                                                  link_value_node->get_id()) + _("')");
165                                return false;
166                        }
167
168                        link_value_node=value_desc.get_value_node();
169                        link_scalar=value_desc.parent_is_linkable_value_node()?value_desc.get_scalar():1.0;
170                        status_message = _("Used exported ValueNode ('") + link_value_node->get_id() + _("').");
171                }
172                else if(value_desc.is_value_node())
173                {
174                        if(!link_value_node)
175                        {
176                                status_level = 1;
177                                status_message = _("Using the only available ValueNode.");
178                                link_value_node=value_desc.get_value_node();
179                                link_scalar=value_desc.parent_is_linkable_value_node()?value_desc.get_scalar():1.0;
180                        }
181                        else if(link_value_node->is_exported())
182                        {
183                                // we've already seen an exported value, so use that rather than the current value
184                        }
185                        // Use the one that is referenced more
186                        else if(link_value_node->rcount()!=value_desc.get_value_node()->rcount())
187                        {
188                                if(link_value_node->rcount()<value_desc.get_value_node()->rcount())
189                                {
190                                        status_level = 2;
191                                        status_message = _("Using the most referenced ValueNode.");
192                                        link_value_node=value_desc.get_value_node();
193                                        link_scalar=value_desc.parent_is_linkable_value_node()?value_desc.get_scalar():1.0;
194                                }
195                                else if (status_level <= 2)
196                                {
197                                        status_level = 2;
198                                        status_message = _("Using the most referenced ValueNode.");
199                                }
200                        }
201                        // If the current link value node is a constant and
202                        // this one isn't, then give preference to the exotic
203                        else if(ValueNode_Const::Handle::cast_dynamic(link_value_node) && !ValueNode_Const::Handle::cast_dynamic(value_desc.get_value_node()))
204                        {
205                                status_level = 3;
206                                status_message = _("There's a tie for most referenced; using the animated ValueNode.");
207                                link_value_node=value_desc.get_value_node();
208                                link_scalar=value_desc.parent_is_linkable_value_node()?value_desc.get_scalar():1.0;
209                        }
210                        else if(ValueNode_Const::Handle::cast_dynamic(value_desc.get_value_node()) && !ValueNode_Const::Handle::cast_dynamic(link_value_node))
211                        {
212                                if (status_level <= 3)
213                                {
214                                        status_level = 3;
215                                        status_message = _("There's a tie for most referenced; using the animated ValueNode.");
216                                }
217                        }
218                        // If both are animated, and this one has more waypoints, then use the one with more waypoints
219                        else if(ValueNode_Animated::Handle::cast_dynamic(link_value_node) &&
220                                        ValueNode_Animated::Handle::cast_dynamic(value_desc.get_value_node()) &&
221                                        ValueNode_Animated::Handle::cast_dynamic(link_value_node)->waypoint_list().size() !=
222                                        ValueNode_Animated::Handle::cast_dynamic(value_desc.get_value_node())->waypoint_list().size())
223                        {
224                                if (ValueNode_Animated::Handle::cast_dynamic(link_value_node)->waypoint_list().size() <
225                                        ValueNode_Animated::Handle::cast_dynamic(value_desc.get_value_node())->waypoint_list().size())
226                                {
227                                        status_level = 4;
228                                        status_message = _("There's a tie for most referenced, and both are animated; using the one with the most waypoints.");
229                                        link_value_node=value_desc.get_value_node();
230                                        link_scalar=value_desc.parent_is_linkable_value_node()?value_desc.get_scalar():1.0;
231                                }
232                                else if (status_level <= 4)
233                                {
234                                        status_level = 4;
235                                        status_message = _("There's a tie for most referenced, and both are animated; using the one with the most waypoints.");
236                                }
237                        }
238                        // If both are Linkable Value Nodes and has waypoint in its children, use the one with more waypoints
239                        else if(LinkableValueNode::Handle::cast_dynamic(link_value_node) &&
240                                        LinkableValueNode::Handle::cast_dynamic(value_desc.get_value_node()) &&
241                                        LinkableValueNode::Handle::cast_dynamic(link_value_node)->get_times().size() !=
242                                        LinkableValueNode::Handle::cast_dynamic(value_desc.get_value_node())->get_times().size())
243                        {
244                                if(LinkableValueNode::Handle::cast_dynamic(link_value_node)->get_times().size() <
245                                LinkableValueNode::Handle::cast_dynamic(value_desc.get_value_node())->get_times().size())
246                                {
247                                        status_level = 4;
248                                        status_message = _("There's a tie for most referenced, and both are linkable value node animated; using the one with the most waypoints.");
249                                        link_value_node=value_desc.get_value_node();
250                                        link_scalar=value_desc.parent_is_linkable_value_node()?value_desc.get_scalar():1.0;
251                                }
252                                else if (status_level <= 4)
253                                {
254                                        status_level = 4;
255                                        status_message = _("There's a tie for most referenced, and both are linkable value node animated; using the one with the most waypoints.");
256                                }
257                        }
258                        // Use the one that was least recently changed
259                        else if(link_value_node->get_time_last_changed()!=value_desc.get_value_node()->get_time_last_changed())
260                        {
261                                if(link_value_node->get_time_last_changed()>value_desc.get_value_node()->get_time_last_changed())
262                                {
263                                        status_level = 5;
264                                        status_message = _("Everything is tied; using the least recently modified value.");
265                                        link_value_node=value_desc.get_value_node();
266                                        link_scalar=value_desc.parent_is_linkable_value_node()?value_desc.get_scalar():1.0;
267                                }
268                                else if (status_level <= 5)
269                                {
270                                        status_level = 5;
271                                        status_message = _("Everything is tied; using the least recently modified value.");
272                                }
273                        }
274                        else
275                        {
276                                status_level = 6;
277                                status_message = _("Absolutely everything is tied.");
278                        }
279                }
280
281                if(value_desc_list.size() && value_desc.get_value_type()!=value_desc_list.front().get_value_type())
282                {
283                        // Everything must be of the same type
284                        poison=true;
285                        status_message = (strprintf(_("Cannot link two values of different types ('%s' and '%s')"),
286                                                                                value_desc.get_value_type().description.local_name.c_str(),
287                                                                                value_desc_list.front().get_value_type().description.local_name.c_str()));
288                        return false;
289                }
290
291                value_desc_list.push_back(value_desc);
292
293                return true;
294        }
295
296        return Action::CanvasSpecific::set_param(name,param);
297}
298
299bool
300Action::ValueDescLink::is_ready()const
301{
302        if(poison)
303                return true;
304        if(value_desc_list.size()<=1)
305                return false;
306        return Action::CanvasSpecific::is_ready();
307}
308
309void
310Action::ValueDescLink::prepare()
311{
312        if(poison)
313                throw Error(status_message.c_str());
314
315        if(value_desc_list.empty())
316                throw Error(Error::TYPE_NOTREADY);
317
318        clear();
319
320        if(!link_value_node)
321        {
322                status_message = _("No ValueNodes were available, so one was created.");
323                ValueDesc& value_desc(value_desc_list.back());
324
325                link_value_node=ValueNode_Const::create(value_desc.get_value(time));
326
327                Action::Handle action(Action::create("ValueDescConnect"));
328
329                action->set_param("canvas",get_canvas());
330                action->set_param("canvas_interface",get_canvas_interface());
331                action->set_param("src",link_value_node);
332                action->set_param("dest",value_desc);
333
334                assert(action->is_ready());
335                if(!action->is_ready())
336                        throw Error(Error::TYPE_NOTREADY);
337
338                add_action_front(action);
339        }
340
341        // Check if the selected  link value node is already a scale -1.0 Linkable Value Node
342        bool link_is_scaled(false);
343        if(synfig::ValueNode_Scale::Handle::cast_dynamic(link_value_node))
344                {
345                        synfig::ValueNode_Const::Handle scale_vn(
346                                        synfig::ValueNode_Const::Handle::cast_dynamic(
347                                                        synfig::ValueNode_Scale::Handle::cast_dynamic(link_value_node)->get_link(1)
348                                                        )
349                                                );
350                        if(scale_vn)
351                                if((*scale_vn)(synfig::Time(0))==synfig::ValueBase(Real(-1.0)))
352                                        link_is_scaled=true;
353                }
354
355        std::list<ValueDesc>::iterator iter;
356        // Gets the scalar value of the current value node
357        Real current_scalar(0);
358        if(value_desc_list.begin()->parent_is_linkable_value_node())
359                current_scalar=value_desc_list.begin()->get_scalar();
360        bool found_inverse(false);
361        // Check if we are dealing the case of linking differnt types of tangents
362        for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
363        {
364                ValueDesc& v_desc(*iter);
365                // If parent is linkable value node
366                if(v_desc.parent_is_linkable_value_node())
367                {
368                        // if the link describe to any tangent (index 4 or 5), continue
369                        if(v_desc.get_index() == 4 || v_desc.get_index() == 5)
370                        {
371                                synfig::Real iter_scalar=v_desc.get_scalar();
372                                // Let's compare the sign  of scalar of the value node witht the current one
373                                // and remember if a change of sign is seen.
374                                if(iter_scalar*current_scalar < 0) // if they have different signs
375                                {
376                                        found_inverse=true;
377                                        current_scalar=iter_scalar;
378                                }
379                        }
380                        else // link doesn't describe a tangent
381                        {
382                                found_inverse=false;
383                                break;
384                        }
385                }
386                else // parent is not a linkable value node
387                {
388                        found_inverse=false;
389                        break;
390                }
391        }
392        // found_inverse =  true only if all they are tangents and some are inversed tangents
393        //Noe let's loop throug all the value desc
394        for(iter=value_desc_list.begin();iter!=value_desc_list.end();++iter)
395        {
396                ValueDesc& value_desc(*iter);
397
398                // only one of the selected items can be exported - that's the one we're linking to
399                // don't link it to itself
400                if (value_desc.is_exported())
401                        continue;
402                // Don't link the selected to itself (maybe it is redundant with the previous check)
403                if(value_desc.get_value_node() == link_value_node)
404                        continue;
405                // found_inverse xor link_opposite
406                // If     found_inverse and not link_opposite then scale by -1 first (smart link)
407                // If     found inverse and     link_opposite then do a direct link instead
408                // If not found_inverse and not link_opposite then do a direct link instead
409                // If not found_inverse and     link_opposite then scale by -1 first (smart link)
410                if((found_inverse && !link_opposite) || (!found_inverse && link_opposite))
411                {
412                        //Check if the current value node has opposite scalar than the link
413                        // value node to convert to scale -1.0 before connect.
414                        // Check also if the link value node is NOT also a scale -1
415                        // And check also if we are linking opposite
416                        if( (value_desc.get_scalar()*link_scalar<0 || link_opposite) && (link_is_scaled==false))
417                        {
418                                //Let's create a Scale Value Node
419                                synfig::ValueNode::Handle scale_value_node=synfig::LinkableValueNode::create("scale",iter->get_value(time),get_canvas());
420                                if(!scale_value_node)
421                                        throw Error(Error::TYPE_BUG);
422                                scale_value_node->set_parent_canvas(get_canvas());
423                                //Let's connect the new Scale Value Node to the value node
424                                Action::Handle action1(Action::create("ValueDescConnect"));
425                                if(!action1)
426                                        throw Error(Error::TYPE_CRITICAL);
427                                action1->set_param("canvas",get_canvas());
428                                action1->set_param("canvas_interface",get_canvas_interface());
429                                action1->set_param("dest",value_desc);
430                                action1->set_param("src",scale_value_node);
431                                assert(action1->is_ready());
432                                if(!action1->is_ready())
433                                        throw Error(Error::TYPE_NOTREADY);
434                                add_action_front(action1);
435
436                                //Let's Connect the link value node to the scale value node link subparam
437                                Action::Handle action2(Action::create("ValueNodeLinkConnect"));
438                                if(!action2)
439                                        throw Error(Error::TYPE_CRITICAL);
440
441                                action2->set_param("canvas",get_canvas());
442                                action2->set_param("canvas_interface",get_canvas_interface());
443                                action2->set_param("parent_value_node",scale_value_node);
444                                action2->set_param("index",0);
445                                action2->set_param("value_node",link_value_node);
446                                assert(action2->is_ready());
447                                if(!action2->is_ready())
448                                        throw Error(Error::TYPE_NOTREADY);
449                                add_action_front(action2);
450
451                                //Let's Set the scale to -1
452                                Action::Handle action3(Action::create("ValueNodeConstSet"));
453                                if(!action3)
454                                        throw Error(Error::TYPE_CRITICAL);
455
456                                action3->set_param("canvas",get_canvas());
457                                action3->set_param("canvas_interface",get_canvas_interface());
458                                action3->set_param("value_node",synfig::LinkableValueNode::Handle::cast_dynamic(scale_value_node)->get_link(1));
459                                action3->set_param("new_value",synfig::ValueBase(Real(-1.0)));
460                                assert(action3->is_ready());
461                                if(!action3->is_ready())
462                                        throw Error(Error::TYPE_NOTREADY);
463                                add_action_front(action3);
464                        }
465                        else if((iter->get_scalar()*link_scalar<0 || link_opposite) && (link_is_scaled==true))
466                        {
467                                //Let's connect the link value node -> link to the value node
468                                // There is not needed conversion to scale of the value node
469                                // because the link value node is already a scale -1
470                                Action::Handle action4(Action::create("ValueDescConnect"));
471                                if(!action4)
472                                        throw Error(Error::TYPE_CRITICAL);
473                                action4->set_param("canvas",get_canvas());
474                                action4->set_param("canvas_interface",get_canvas_interface());
475                                action4->set_param("dest",value_desc);
476                                action4->set_param("src",synfig::ValueNode_Scale::Handle::cast_dynamic(link_value_node)->get_link(0));
477                                assert(action4->is_ready());
478                                if(!action4->is_ready())
479                                        throw Error(Error::TYPE_NOTREADY);
480                                add_action_front(action4);
481                        }
482                        else
483                        {
484                                //Let's connect the link value node to the value node
485                                Action::Handle action(Action::create("ValueDescConnect"));
486
487                                action->set_param("canvas",get_canvas());
488                                action->set_param("canvas_interface",get_canvas_interface());
489                                action->set_param("src",link_value_node);
490                                action->set_param("dest",value_desc);
491
492                                assert(action->is_ready());
493                                if(!action->is_ready())
494                                        throw Error(Error::TYPE_NOTREADY);
495
496                                add_action_front(action);
497                        }
498                } // found inverse
499                else // Not found inverse so do a regualr link
500                {
501                        //Let's connect the link value node to the value node
502                        Action::Handle action(Action::create("ValueDescConnect"));
503
504                        action->set_param("canvas",get_canvas());
505                        action->set_param("canvas_interface",get_canvas_interface());
506                        action->set_param("src",link_value_node);
507                        action->set_param("dest",value_desc);
508
509                        assert(action->is_ready());
510                        if(!action->is_ready())
511                                throw Error(Error::TYPE_NOTREADY);
512
513                        add_action_front(action);
514                }
515        }
516
517        synfig::info("http://synfig.org/Linking#Tier_%d : %s", status_level, status_message.c_str());
518}
519
520
521Action::ValueDescLinkOpposite::ValueDescLinkOpposite()
522{
523}
524
525Action::ParamVocab
526Action::ValueDescLinkOpposite::get_param_vocab()
527{
528        return Action::ValueDescLink::get_param_vocab();
529}
530
531bool
532Action::ValueDescLinkOpposite::is_candidate(const ParamList &x)
533{
534        // If action parameters are not Value Desc
535        if(!candidate_check(get_param_vocab(),x))
536                return false;
537
538        int total_tangents=0;
539        ParamList::const_iterator iter;
540        //Search thru all the Param and pick up the value descriptions
541        for(iter=x.begin(); iter!=x.end(); iter++)
542        {
543                if(iter->first == "value_desc")
544                {
545                        ValueDesc v_desc(iter->second.get_value_desc());
546                        // if the value description parent is linkable value node, continue
547                        if(!v_desc.parent_is_linkable_value_node())
548                                return false;
549                        // if the link describe to any tangent (index 4 or 5), continue
550                        if(v_desc.get_index() != 4 && v_desc.get_index() != 5)
551                                return false;
552                        total_tangents++;
553                }
554        }
555        // If we found two tangents then continue
556        if(total_tangents!=2)
557                return false;
558        // We have reached exactly two tangents
559        return true;
560}
561
562bool
563Action::ValueDescLinkOpposite::set_param(const synfig::String& name, const Action::Param &param)
564{
565        return Action::ValueDescLink::set_param(name,param);
566}
567
568bool
569Action::ValueDescLinkOpposite::is_ready()const
570{
571        return Action::ValueDescLink::is_ready();
572}
573
574void
575Action::ValueDescLinkOpposite::prepare()
576{
577        // prepare to do a opposite link and reuse the code from ValueDescLink
578        link_opposite=true;
579        ValueDescLink::prepare();
580}
Note: See TracBrowser for help on using the repository browser.