1 /* === S Y N F I G ========================================================= */
2 /*! \file valuenode_bline.cpp
3 ** \brief Implementation of the "BLine" valuenode conversion.
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007, 2008 Chris Moore
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.
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.
22 /* ========================================================================= */
24 /* === H E A D E R S ======================================================= */
33 #include "valuenode_bline.h"
34 #include "valuenode_const.h"
35 #include "valuenode_composite.h"
37 #include "exception.h"
38 #include "blinepoint.h"
42 #include <ETL/hermite>
43 #include <ETL/calculus>
48 /* === U S I N G =========================================================== */
52 using namespace synfig;
54 /* === M A C R O S ========================================================= */
56 #define EPSILON 0.0000001f
58 /* === G L O B A L S ======================================================= */
60 /* === P R O C E D U R E S ================================================= */
63 linear_interpolation(const float& a, const float& b, float c)
67 linear_interpolation(const Vector& a, const Vector& b, float c)
71 radial_interpolation(const Vector& a, const Vector& b, float c)
73 // if either extreme is zero then use linear interpolation instead
74 if (a.is_equal_to(Vector::zero()) || b.is_equal_to(Vector::zero()))
75 return linear_interpolation(a, b, c);
77 affine_combo<Real,float> mag_combo;
78 affine_combo<Angle,float> ang_combo;
80 Real mag(mag_combo(a.mag(),b.mag(),c));
81 Angle ang(ang_combo(Angle::tan(a[1],a[0]),Angle::tan(b[1],b[0]),c));
83 return Point( mag*Angle::cos(ang).get(),mag*Angle::sin(ang).get() );
87 transform_coords(Vector in, Vector& out, const Point& coord_origin, const Point *coord_sys)
90 out[0] = in * coord_sys[0];
91 out[1] = in * coord_sys[1];
95 untransform_coords(const Vector& in, Vector& out, const Point& coord_origin, const Point *coord_sys)
97 out[0] = in * coord_sys[0];
98 out[1] = in * coord_sys[1];
103 synfig::convert_bline_to_segment_list(const ValueBase& bline)
105 std::vector<Segment> ret;
107 // std::vector<BLinePoint> list(bline.operator std::vector<BLinePoint>());
108 //std::vector<BLinePoint> list(bline);
109 std::vector<BLinePoint> list(bline.get_list().begin(),bline.get_list().end());
110 std::vector<BLinePoint>::const_iterator iter;
112 BLinePoint prev,first;
114 //start with prev = first and iter on the second...
116 if(list.empty()) return ValueBase(ret,bline.get_loop());
117 first = prev = list.front();
119 for(iter=++list.begin();iter!=list.end();++iter)
142 return ValueBase(ret,bline.get_loop());
146 synfig::convert_bline_to_width_list(const ValueBase& bline)
148 std::vector<Real> ret;
149 // std::vector<BLinePoint> list(bline.operator std::vector<BLinePoint>());
150 //std::vector<BLinePoint> list(bline);
151 std::vector<BLinePoint> list(bline.get_list().begin(),bline.get_list().end());
152 std::vector<BLinePoint>::const_iterator iter;
155 return ValueBase(ValueBase::TYPE_LIST);
157 for(iter=list.begin();iter!=list.end();++iter)
158 ret.push_back(iter->get_width());
161 ret.push_back(list.front().get_width());
163 return ValueBase(ret,bline.get_loop());
167 /* === M E T H O D S ======================================================= */
170 ValueNode_BLine::ValueNode_BLine():
171 ValueNode_DynamicList(ValueBase::TYPE_BLINEPOINT)
175 ValueNode_BLine::~ValueNode_BLine()
180 ValueNode_BLine::create(const ValueBase &value)
182 if(value.get_type()!=ValueBase::TYPE_LIST)
185 ValueNode_BLine* value_node(new ValueNode_BLine());
189 switch(value.get_contained_type())
191 case ValueBase::TYPE_BLINEPOINT:
193 // std::vector<BLinePoint> bline_points(value.operator std::vector<BLinePoint>());
194 //std::vector<BLinePoint> bline_points(value);
195 std::vector<BLinePoint> bline_points(value.get_list().begin(),value.get_list().end());
196 std::vector<BLinePoint>::const_iterator iter;
198 for(iter=bline_points.begin();iter!=bline_points.end();iter++)
200 value_node->add(ValueNode::Handle(ValueNode_Composite::create(*iter)));
202 value_node->set_loop(value.get_loop());
205 case ValueBase::TYPE_SEGMENT:
207 // Here, we want to convert a list of segments
208 // into a list of BLinePoints. We make an assumption
209 // that the segment list is continuous(sp), but not necessarily
212 value_node->set_loop(false);
213 // std::vector<Segment> segments(value.operator std::vector<Segment>());
214 // std::vector<Segment> segments(value);
215 std::vector<Segment> segments(value.get_list().begin(),value.get_list().end());
216 std::vector<Segment>::const_iterator iter,last(segments.end());
218 ValueNode_Const::Handle prev,first;
220 for(iter=segments.begin();iter!=segments.end();iter++)
222 #define PREV_POINT prev->get_value().get(BLinePoint())
223 #define FIRST_POINT first->get_value().get(BLinePoint())
224 #define CURR_POINT curr->get_value().get(BLinePoint())
225 if(iter==segments.begin())
227 prev=ValueNode_Const::create(ValueBase::TYPE_BLINEPOINT);
229 BLinePoint prev_point(PREV_POINT);
230 prev_point.set_vertex(iter->p1);
231 prev_point.set_tangent1(iter->t1);
232 prev_point.set_width(0.01);
233 prev_point.set_origin(0.5);
234 prev_point.set_split_tangent_flag(false);
235 prev->set_value(prev_point);
238 value_node->add(ValueNode::Handle(prev));
241 if(iter==last && iter->p2.is_equal_to(FIRST_POINT.get_vertex()))
243 value_node->set_loop(true);
244 if(!iter->t2.is_equal_to(FIRST_POINT.get_tangent1()))
246 BLinePoint first_point(FIRST_POINT);
247 first_point.set_tangent1(iter->t2);
248 first->set_value(first_point);
253 ValueNode_Const::Handle curr;
254 curr=ValueNode_Const::create(ValueBase::TYPE_BLINEPOINT);
256 BLinePoint curr_point(CURR_POINT);
257 curr_point.set_vertex(iter->p2);
258 curr_point.set_tangent1(iter->t2);
259 curr_point.set_width(0.01);
260 curr_point.set_origin(0.5);
261 curr_point.set_split_tangent_flag(false);
262 curr->set_value(curr_point);
264 if(!PREV_POINT.get_tangent1().is_equal_to(iter->t1))
266 BLinePoint prev_point(PREV_POINT);
267 prev_point.set_split_tangent_flag(true);
268 prev_point.set_tangent2(iter->t1);
269 prev->set_value(prev_point);
271 value_node->add(ValueNode::Handle(curr));
278 // We got a list of who-knows-what. We don't have any idea
279 // what to do with it.
288 ValueNode_BLine::ListEntry
289 ValueNode_BLine::create_list_entry(int index, Time time, Real origin)
291 ValueNode_BLine::ListEntry ret;
293 synfig::BLinePoint prev,next;
297 index=index%link_count();
301 ret.set_parent_value_node(this);
303 if(!list[index].status_at_time(time))
304 next_i=find_next_valid_entry(index,time);
307 prev_i=find_prev_valid_entry(index,time);
309 //synfig::info("index=%d, next_i=%d, prev_i=%d",index,next_i,prev_i);
311 next=(*list[next_i].value_node)(time);
312 prev=(*list[prev_i].value_node)(time);
314 etl::hermite<Vector> curve(prev.get_vertex(),next.get_vertex(),prev.get_tangent2(),next.get_tangent1());
315 etl::derivative< etl::hermite<Vector> > deriv(curve);
317 synfig::BLinePoint bline_point;
318 bline_point.set_vertex(curve(origin));
319 bline_point.set_width((next.get_width()-prev.get_width())*origin+prev.get_width());
320 bline_point.set_tangent1(deriv(origin)*min(1.0-origin,origin));
321 bline_point.set_tangent2(bline_point.get_tangent1());
322 bline_point.set_split_tangent_flag(false);
323 bline_point.set_origin(origin);
325 ret.value_node=ValueNode_Composite::create(bline_point);
331 ValueNode_BLine::operator()(Time t)const
333 std::vector<BLinePoint> ret_list;
335 std::vector<ListEntry>::const_iterator iter,first_iter;
336 bool first_flag(true);
339 float next_scale(1.0f);
341 BLinePoint prev,first;
342 first.set_origin(100.0f);
344 // loop through all the list's entries
345 for(iter=list.begin();iter!=list.end();++iter,index++)
347 // how 'on' is this vertex?
348 float amount(iter->amount_at_time(t,&rising));
350 assert(amount>=0.0f);
351 assert(amount<=1.0f);
354 if (amount > 1.0f - EPSILON)
359 first=prev=(*iter->value_node)(t).get(prev);
361 ret_list.push_back(first);
366 curr=(*iter->value_node)(t).get(prev);
370 ret_list.back().set_split_tangent_flag(true);
371 ret_list.back().set_tangent2(prev.get_tangent2()*next_scale);
373 ret_list.push_back(curr);
375 ret_list.back().set_split_tangent_flag(true);
376 ret_list.back().set_tangent2(curr.get_tangent2());
377 ret_list.back().set_tangent1(curr.get_tangent1()*next_scale);
383 ret_list.push_back(curr);
391 std::vector<ListEntry>::const_iterator begin_iter,end_iter;
393 // This is where the interesting stuff happens
394 // We need to seek forward in the list to see what the next
397 BLinePoint blp_here_on; // the current vertex, when fully on
398 BLinePoint blp_here_off; // the current vertex, when fully off
399 BLinePoint blp_here_now; // the current vertex, right now (between on and off)
400 BLinePoint blp_prev_off; // the beginning of dynamic group when fully off
401 BLinePoint blp_next_off; // the end of the dynamic group when fully off
403 int dist_from_begin(0), dist_from_end(0);
404 Time off_time, on_time;
406 if(!rising) // if not rising, then we were fully on in the past, and will be fully off in the future
408 try{ on_time=iter->find_prev(t)->get_time(); }
409 catch(...) { on_time=Time::begin(); }
410 try{ off_time=iter->find_next(t)->get_time(); }
411 catch(...) { off_time=Time::end(); }
413 else // otherwise we were fully off in the past, and will be fully on in the future
415 try{ off_time=iter->find_prev(t)->get_time(); }
416 catch(...) { off_time=Time::begin(); }
417 try{ on_time=iter->find_next(t)->get_time(); }
418 catch(...) { on_time=Time::end(); }
421 blp_here_on=(*iter->value_node)(on_time).get(blp_here_on);
422 // blp_here_on=(*iter->value_node)(t).get(blp_here_on);
424 // Find "end" of dynamic group - ie. search forward along
425 // the bline from the current point until we find a point
426 // which is more 'on' than the current one
428 // for(++end_iter;begin_iter!=list.end();++end_iter)
429 for(++end_iter;end_iter!=list.end();++end_iter)
430 if(end_iter->amount_at_time(t)>amount)
433 // If we did not find an end of the dynamic group...
434 // Writeme! at least now it doesn't crash if first_iter
436 if(end_iter==list.end())
438 if(get_loop() && !first_flag)
441 end_iter=--list.end();
444 blp_next_off=(*end_iter->value_node)(off_time).get(prev);
446 // Find "begin" of dynamic group
448 blp_prev_off.set_origin(100.0f); // set the origin to 100 (which is crazy) so that we can check to see if it was found
451 if(begin_iter==list.begin())
454 begin_iter=list.end();
462 // if we've gone all around the loop, give up
466 if(begin_iter->amount_at_time(t)>amount)
468 blp_prev_off=(*begin_iter->value_node)(off_time).get(prev);
473 // If we did not find a begin
474 if(blp_prev_off.get_origin()==100.0f)
476 // Writeme! - this needs work, but at least now it
479 begin_iter=list.begin();
481 begin_iter=first_iter;
482 blp_prev_off=(*begin_iter->value_node)(off_time).get(prev);
485 // this is how the curve looks when we have completely vanished
486 etl::hermite<Vector> curve(blp_prev_off.get_vertex(), blp_next_off.get_vertex(),
487 blp_prev_off.get_tangent2(), blp_next_off.get_tangent1());
488 etl::derivative< etl::hermite<Vector> > deriv(curve);
490 // where would we be on this curve, how wide will we be, and
491 // where will our tangents point (all assuming that we hadn't vanished)
492 blp_here_off.set_vertex(curve(blp_here_on.get_origin()));
493 blp_here_off.set_width((blp_next_off.get_width()-blp_prev_off.get_width())*blp_here_on.get_origin()+blp_prev_off.get_width());
494 blp_here_off.set_tangent1(deriv(blp_here_on.get_origin()));
495 blp_here_off.set_tangent2(deriv(blp_here_on.get_origin()));
497 float prev_tangent_scalar(1.0f);
498 float next_tangent_scalar(1.0f);
500 //synfig::info("index_%d:dist_from_begin=%d",index,dist_from_begin);
501 //synfig::info("index_%d:dist_from_end=%d",index,dist_from_end);
503 // If we are the next to the begin
504 if(begin_iter==--std::vector<ListEntry>::const_iterator(iter) || dist_from_begin==1)
505 prev_tangent_scalar=linear_interpolation(blp_here_on.get_origin(), 1.0f, amount);
507 prev_tangent_scalar=linear_interpolation(blp_here_on.get_origin()-prev.get_origin(), 1.0f, amount);
509 // If we are the next to the end
510 if(end_iter==++std::vector<ListEntry>::const_iterator(iter) || dist_from_end==1)
511 next_tangent_scalar=linear_interpolation(1.0-blp_here_on.get_origin(), 1.0f, amount);
512 else if(list.end()!=++std::vector<ListEntry>::const_iterator(iter))
515 next=((*(++std::vector<ListEntry>::const_iterator(iter))->value_node)(t).get(prev));
516 next_tangent_scalar=linear_interpolation(next.get_origin()-blp_here_on.get_origin(), 1.0f, amount);
519 //! \todo this isn't quite right; we should handle looped blines identically no matter where the loop happens
520 //! and we currently don't. this at least makes it a lot better than it was before
521 next_tangent_scalar=linear_interpolation(blp_next_off.get_origin()-blp_here_on.get_origin(), 1.0f, amount);
522 next_scale=next_tangent_scalar;
524 //blp_here_now.set_vertex(linear_interpolation(blp_here_off.get_vertex(), blp_here_on.get_vertex(), amount));
528 // Point ref_point_begin(((*begin_iter->value_node)(off_time).get(prev).get_vertex() +
529 // (*end_iter->value_node)(off_time).get(prev).get_vertex()) * 0.5);
530 // Point ref_point_end(((*begin_iter->value_node)(on_time).get(prev).get_vertex() +
531 // (*end_iter->value_node)(on_time).get(prev).get_vertex()) * 0.5);
532 // Point ref_point_now(((*begin_iter->value_node)(t).get(prev).get_vertex() +
533 // (*end_iter->value_node)(t).get(prev).get_vertex()) * 0.5);
534 // Point ref_point_linear(linear_interpolation(ref_point_begin, ref_point_end, amount));
536 // blp_here_now.set_vertex(linear_interpolation(blp_here_off.get_vertex(), blp_here_on.get_vertex(), amount) +
537 // (ref_point_now-ref_point_linear));
538 // blp_here_now.set_tangent1(linear_interpolation(blp_here_off.get_tangent1(), blp_here_on.get_tangent1(), amount));
539 // blp_here_now.set_split_tangent_flag(blp_here_on.get_split_tangent_flag());
540 // if(blp_here_now.get_split_tangent_flag())
541 // blp_here_now.set_tangent2(linear_interpolation(blp_here_off.get_tangent2(), blp_here_on.get_tangent2(), amount));
547 // define 3 coordinate systems:
548 Point off_coord_sys[2], off_coord_origin; // when the current vertex is completely off
549 Point on_coord_sys[2] , on_coord_origin; // when the current vertex is completely on
550 Point curr_coord_sys[2], curr_coord_origin; // the current state - somewhere in between
552 // for each of the 3 systems, the origin is half way between the previous and next active point
553 // and the axes are based on a vector from the next active point to the previous
555 const Point end_pos_at_off_time(( *end_iter->value_node)(off_time).get(prev).get_vertex());
556 const Point begin_pos_at_off_time((*begin_iter->value_node)(off_time).get(prev).get_vertex());
557 off_coord_origin=(begin_pos_at_off_time + end_pos_at_off_time)/2;
558 off_coord_sys[0]=(begin_pos_at_off_time - end_pos_at_off_time).norm();
559 off_coord_sys[1]=off_coord_sys[0].perp();
561 const Point end_pos_at_on_time(( *end_iter->value_node)(on_time).get(prev).get_vertex());
562 const Point begin_pos_at_on_time((*begin_iter->value_node)(on_time).get(prev).get_vertex());
563 on_coord_origin=(begin_pos_at_on_time + end_pos_at_on_time)/2;
564 on_coord_sys[0]=(begin_pos_at_on_time - end_pos_at_on_time).norm();
565 on_coord_sys[1]=on_coord_sys[0].perp();
567 const Point end_pos_at_current_time(( *end_iter->value_node)(t).get(prev).get_vertex());
568 const Point begin_pos_at_current_time((*begin_iter->value_node)(t).get(prev).get_vertex());
569 curr_coord_origin=(begin_pos_at_current_time + end_pos_at_current_time)/2;
570 curr_coord_sys[0]=(begin_pos_at_current_time - end_pos_at_current_time).norm();
571 curr_coord_sys[1]=curr_coord_sys[0].perp();
573 // Invert (transpose) the last of these matrices, since we use it for transform back
574 swap(curr_coord_sys[0][1],curr_coord_sys[1][0]);
577 /* The code that was here before used just end_iter as the origin, rather than the mid-point */
579 // We know our location and tangent(s) when fully on and fully off
580 // Transform each of these into their corresponding coordinate system
581 Point trans_on_point, trans_off_point;
582 Vector trans_on_t1, trans_on_t2, trans_off_t1, trans_off_t2;
584 transform_coords(blp_here_on.get_vertex(), trans_on_point, on_coord_origin, on_coord_sys);
585 transform_coords(blp_here_off.get_vertex(), trans_off_point, off_coord_origin, off_coord_sys);
587 #define COORD_SYS_RADIAL_TAN_INTERP 1
589 #ifdef COORD_SYS_RADIAL_TAN_INTERP
590 transform_coords(blp_here_on.get_tangent1(), trans_on_t1, Point::zero(), on_coord_sys);
591 transform_coords(blp_here_off.get_tangent1(), trans_off_t1, Point::zero(), off_coord_sys);
593 if(blp_here_on.get_split_tangent_flag())
595 transform_coords(blp_here_on.get_tangent2(), trans_on_t2, Point::zero(), on_coord_sys);
596 transform_coords(blp_here_off.get_tangent2(), trans_off_t2, Point::zero(), off_coord_sys);
601 // Interpolate between the 'on' point and the 'off' point and untransform to get our point's location
603 untransform_coords(linear_interpolation(trans_off_point, trans_on_point, amount),
604 tmp, curr_coord_origin, curr_coord_sys);
605 blp_here_now.set_vertex(tmp);
608 #define INTERP_FUNCTION radial_interpolation
609 //#define INTERP_FUNCTION linear_interpolation
611 #ifdef COORD_SYS_RADIAL_TAN_INTERP
614 untransform_coords(INTERP_FUNCTION(trans_off_t1,trans_on_t1,amount), tmp, Point::zero(), curr_coord_sys);
615 blp_here_now.set_tangent1(tmp);
618 blp_here_now.set_tangent1(radial_interpolation(blp_here_off.get_tangent1(),blp_here_on.get_tangent1(),amount));
621 if (blp_here_on.get_split_tangent_flag())
623 blp_here_now.set_split_tangent_flag(true);
624 #ifdef COORD_SYS_RADIAL_TAN_INTERP
627 untransform_coords(INTERP_FUNCTION(trans_off_t2,trans_on_t2,amount), tmp, Point::zero(), curr_coord_sys);
628 blp_here_now.set_tangent2(tmp);
631 blp_here_now.set_tangent2(radial_interpolation(blp_here_off.get_tangent2(),blp_here_on.get_tangent2(),amount));
635 blp_here_now.set_split_tangent_flag(false);
638 blp_here_now.set_origin(blp_here_on.get_origin());
639 blp_here_now.set_width(linear_interpolation(blp_here_off.get_width(), blp_here_on.get_width(), amount));
641 // Handle the case where we are the first vertex
644 blp_here_now.set_tangent1(blp_here_now.get_tangent1()*prev_tangent_scalar);
646 first=prev=blp_here_now;
648 ret_list.push_back(blp_here_now);
652 ret_list.back().set_split_tangent_flag(true);
653 ret_list.back().set_tangent2(prev.get_tangent2()*prev_tangent_scalar);
654 ret_list.push_back(blp_here_now);
655 ret_list.back().set_split_tangent_flag(true);
656 //ret_list.back().set_tangent2(blp_here_now.get_tangent1());
657 ret_list.back().set_tangent1(blp_here_now.get_tangent1()*prev_tangent_scalar);
665 ret_list.back().set_split_tangent_flag(true);
666 ret_list.back().set_tangent2(prev.get_tangent2()*next_scale);
670 if(get_loop() && !first_flag)
684 synfig::warning(string("ValueNode_BLine::operator()():")+_("No entries in list"));
687 synfig::warning(string("ValueNode_BLine::operator()():")+_("No entries in ret_list"));
689 return ValueBase(ret_list,get_loop());
693 ValueNode_BLine::link_local_name(int i)const
695 assert(i>=0 && (unsigned)i<list.size());
696 return etl::strprintf(_("Vertex %03d"),i+1);
700 ValueNode_BLine::clone(const GUID& deriv_guid)const
702 { ValueNode* x(find_value_node(get_guid()^deriv_guid).get()); if(x)return x; }
704 ValueNode_BLine* ret=new ValueNode_BLine();
705 ret->set_guid(get_guid()^deriv_guid);
707 std::vector<ListEntry>::const_iterator iter;
709 for(iter=list.begin();iter!=list.end();++iter)
711 if(iter->value_node->is_exported())
715 ListEntry list_entry(*iter);
716 //list_entry.value_node=find_value_node(iter->value_node->get_guid()^deriv_guid).get();
717 //if(!list_entry.value_node)
718 list_entry.value_node=iter->value_node->clone(deriv_guid);
719 ret->add(list_entry);
720 //ret->list.back().value_node=iter->value_node.clone();
723 ret->set_loop(get_loop());
729 ValueNode_BLine::get_name()const
735 ValueNode_BLine::get_local_name()const
741 ValueNode_BLine::create_new()const
748 ValueNode_BLine::check_type(ValueBase::Type type)
750 return type==ValueBase::TYPE_LIST;