/* === S Y N F I G ========================================================= */
/*! \file valuenodedynamiclistinsertsmart.cpp
** \brief Template File
**
** $Id$
**
** \legal
** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
** Copyright (c) 2007 Chris Moore
**
** This package is free software; you can redistribute it and/or
** modify it under the terms of the GNU General Public License as
** published by the Free Software Foundation; either version 2 of
** the License, or (at your option) any later version.
**
** This package is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
** General Public License for more details.
** \endlegal
*/
/* ========================================================================= */
/* === H E A D E R S ======================================================= */
#ifdef USING_PCH
# include "pch.h"
#else
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <synfig/general.h>
#include "valuenodedynamiclistinsertsmart.h"
#include "valuenodedynamiclistinsert.h"
#include <synfigapp/canvasinterface.h>
#include <synfigapp/localization.h>
#endif
using namespace std;
using namespace etl;
using namespace synfig;
using namespace synfigapp;
using namespace Action;
/* === M A C R O S ========================================================= */
ACTION_INIT(Action::ValueNodeDynamicListInsertSmart);
ACTION_SET_NAME(Action::ValueNodeDynamicListInsertSmart,"ValueNodeDynamicListInsertSmart");
ACTION_SET_LOCAL_NAME(Action::ValueNodeDynamicListInsertSmart,N_("Insert Item"));
ACTION_SET_TASK(Action::ValueNodeDynamicListInsertSmart,"insert");
ACTION_SET_CATEGORY(Action::ValueNodeDynamicListInsertSmart,Action::CATEGORY_VALUEDESC|Action::CATEGORY_VALUENODE);
ACTION_SET_PRIORITY(Action::ValueNodeDynamicListInsertSmart,-20);
ACTION_SET_VERSION(Action::ValueNodeDynamicListInsertSmart,"0.0");
ACTION_SET_CVS_ID(Action::ValueNodeDynamicListInsertSmart,"$Id$");
ACTION_INIT(Action::ValueNodeDynamicListInsertSmartKeepShape);
ACTION_SET_NAME(Action::ValueNodeDynamicListInsertSmartKeepShape,"ValueNodeDynamicListInsertSmartKeepShape");
ACTION_SET_LOCAL_NAME(Action::ValueNodeDynamicListInsertSmartKeepShape,N_("Insert Item & Keep Shape"));
ACTION_SET_TASK(Action::ValueNodeDynamicListInsertSmartKeepShape,"insert");
ACTION_SET_CATEGORY(Action::ValueNodeDynamicListInsertSmartKeepShape,Action::CATEGORY_VALUEDESC|Action::CATEGORY_VALUENODE);
ACTION_SET_PRIORITY(Action::ValueNodeDynamicListInsertSmartKeepShape,-21);
ACTION_SET_VERSION(Action::ValueNodeDynamicListInsertSmartKeepShape,"0.0");
ACTION_SET_CVS_ID(Action::ValueNodeDynamicListInsertSmartKeepShape,"$Id$");
/* === G L O B A L S ======================================================= */
/* === P R O C E D U R E S ================================================= */
/* === M E T H O D S ======================================================= */
///////////// VALUENODEDYNAMICLISTINSERTITEMSMART
Action::ValueNodeDynamicListInsertSmart::ValueNodeDynamicListInsertSmart() :
keep_shape(false)
{
index=0;
time=0;
origin=0.5f;
set_dirty(true);
}
Action::ParamVocab
Action::ValueNodeDynamicListInsertSmart::get_param_vocab()
{
ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
.set_local_name(_("ValueDesc"))
);
ret.push_back(ParamDesc("time",Param::TYPE_TIME)
.set_local_name(_("Time"))
.set_optional()
);
ret.push_back(ParamDesc("origin",Param::TYPE_REAL)
.set_local_name(_("Origin"))
.set_optional()
);
return ret;
}
bool
Action::ValueNodeDynamicListInsertSmart::is_candidate(const ParamList &x)
{
if (!candidate_check(get_param_vocab(),x))
return false;
ValueDesc value_desc(x.find("value_desc")->second.get_value_desc());
return ( (value_desc.parent_is_value_node() &&
// We need a Dynamic List parent.
ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node()))
||
// Or a Dynamic List value node
(value_desc.is_value_node() &&
ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_value_node())) );
}
bool
Action::ValueNodeDynamicListInsertSmart::set_param(const synfig::String& name, const Action::Param ¶m)
{
if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
{
ValueDesc value_desc(param.get_value_desc());
if(!value_desc.parent_is_value_node())
{
if(value_desc.is_value_node())
{
value_node=ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_value_node());
index=0;
}
else
return false;
}
else
{
value_node=ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node());
index=value_desc.get_index();
}
if(!value_node)
return false;
return true;
}
if(name=="time" && param.get_type()==Param::TYPE_TIME)
{
time=param.get_time();
return true;
}
if(name=="origin" && param.get_type()==Param::TYPE_REAL)
{
origin=param.get_real();
return true;
}
return Action::CanvasSpecific::set_param(name,param);
}
bool
Action::ValueNodeDynamicListInsertSmart::is_ready()const
{
if(!value_node)
return false;
return Action::CanvasSpecific::is_ready();
}
void
Action::ValueNodeDynamicListInsertSmart::prepare()
{
//clear();
// HACK
if(!first_time())
return;
// If we are in animate editing mode
if(get_edit_mode()&MODE_ANIMATE)
{
int index(ValueNodeDynamicListInsertSmart::index);
// In this case we need to first determine if there is
// a currently disabled item in the list that we can
// turn on. If not, then we need to go ahead and create one.
synfig::info("ValueNodeDynamicListInsertSmart: index=%d",index);
synfig::info("ValueNodeDynamicListInsertSmart: value_node->list.size()=%d",value_node->list.size());
if(int(value_node->list.size())<=index && index>0)
synfig::info("ValueNodeDynamicListInsertSmart: value_node->list[index-1].status_at_time(time)=%d",value_node->list[index-1].status_at_time(time));
if(int(value_node->list.size())>=index && index>0 && !value_node->list[index-1].status_at_time(time))
{
// Ok, we do not have to create a new
// entry in the dynamic list after all.
// However, we do need to set the
// position and tangent of this point.
ValueNode_DynamicList::ListEntry list_entry(value_node->create_list_entry(index,time,origin));
ValueBase value((*list_entry.value_node)(time));
index--;
ValueDesc item_value_desc(value_node,index);
Action::Handle action(Action::create("ValueDescSet"));
if(!action)
throw Error(_("Unable to find action ValueDescSet (bug)"));
action->set_param("edit_mode",get_edit_mode());
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("new_value",value);
action->set_param("value_desc",ValueDesc(value_node,index));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
}
else
{
// Ok, not a big deal, we just need to
// add a new item
Action::Handle action(Action::create("ValueNodeDynamicListInsert"));
if(!action)
throw Error(_("Unable to find action (bug)"));
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("origin",origin);
if (!keep_shape) action->set_param("force_link_radius",true);
action->set_param("value_desc",ValueDesc(value_node,index));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
// This commented code creates a 'off' Active Point at time.begin()
// that produces bugs like
action=Action::create("ActivepointSetOff");
if(!action)
throw Error(_("Unable to find action \"ActivepointSetOff\""));
action->set_param("edit_mode",MODE_ANIMATE);
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",Time::begin());
action->set_param("origin",origin);
action->set_param("value_desc",ValueDesc(value_node,index));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
// If we are inserting the first element, or don't want to
// keep the shape, there is nothing more to do
if(value_node->list.size() > 0 && keep_shape)
{
// If we are inserting on a BLine,
// once we add a new item, we need to update the tangent's radius
// of the previous and next entries from the index to keep the
// shape of the curve
if(value_node->get_contained_type() == type_bline_point)
{
int prev, next, after, before;
if(!value_node->list[index].status_at_time(time))
next=value_node->find_next_valid_entry(index,time);
else
next=index;
after=next+1;
prev=value_node->find_prev_valid_entry(index,time);
before=prev;
if(next==0)
before++;
assert(prev>=0);
assert(next>=0);
ValueNode_DynamicList::ListEntry next_list_entry(value_node->list[next]);
ValueNode_DynamicList::ListEntry prev_list_entry(value_node->list[prev]);
BLinePoint bpn((*next_list_entry.value_node)(time).get(synfig::BLinePoint()));
BLinePoint bpp((*prev_list_entry.value_node)(time).get(synfig::BLinePoint()));
// Update previous BLinePoint's tangent's radius
// Do not add new way-points to the split radius if already split
if(!bpp.get_split_tangent_radius())
bpp.set_split_tangent_radius();
bpp.set_tangent2(Vector(bpp.get_tangent2().mag()*origin, bpp.get_tangent2().angle()));
// Update next BLinePoint's tangent's radius
// Do not add new way-points to the split radius if already split
if(!bpn.get_split_tangent_radius())
bpn.set_split_tangent_radius();
bpn.set_tangent1(Vector(bpn.get_tangent1().mag()*(1.0-origin), bpn.get_tangent1().angle()));
// Now add the actions to modify the value descs
{
// BEFORE
Action::Handle action(Action::create("ValueDescSet"));
if(!action)
throw Error(_("Unable to find action ValueDescSet (bug)"));
action->set_param("edit_mode",get_edit_mode());
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("new_value",ValueBase(bpp));
action->set_param("value_desc",ValueDesc(value_node,before));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
}
{
// AFTER
Action::Handle action(Action::create("ValueDescSet"));
if(!action)
throw Error(_("Unable to find action ValueDescSet (bug)"));
action->set_param("edit_mode",get_edit_mode());
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("new_value",ValueBase(bpn));
action->set_param("value_desc",ValueDesc(value_node,after));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
}
}
}
}
// Now we set the activepoint up and then we'll be done
Action::Handle action(Action::create("ActivepointSetOn"));
if(!action)
throw Error(_("Unable to find action \"ActivepointSetOn\""));
action->set_param("edit_mode",get_edit_mode());
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("origin",origin);
action->set_param("value_desc",ValueDesc(value_node,index));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
}
else
{
Action::Handle action(Action::create("ValueNodeDynamicListInsert"));
if(!action)
throw Error(_("Unable to find action (bug)"));
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("origin",origin);
if (!keep_shape) action->set_param("force_link_radius",true);
action->set_param("value_desc",ValueDesc(value_node,index));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
// If we are inserting the first element, or don't want to
// keep the shape, there is nothing more to do
if(value_node->list.size() > 0 && keep_shape)
{
// If we are inserting on a BLine,
// once we add a new item, we need to update the tangent's radius
// of the previous and next entries from the index to keep the
// shape of the curve
if(value_node->get_contained_type() == type_bline_point)
{
int prev, next, after, before;
if(!value_node->list[index].status_at_time(time))
next=value_node->find_next_valid_entry(index,time);
else
next=index;
after=next+1;
prev=value_node->find_prev_valid_entry(index,time);
before=prev;
if(next==0)
before++;
assert(prev>=0);
assert(next>=0);
ValueNode_DynamicList::ListEntry next_list_entry(value_node->list[next]);
ValueNode_DynamicList::ListEntry prev_list_entry(value_node->list[prev]);
BLinePoint bpn((*next_list_entry.value_node)(time).get(synfig::BLinePoint()));
BLinePoint bpp((*prev_list_entry.value_node)(time).get(synfig::BLinePoint()));
// Update previous BLinePoint's tangent's radius
// Do not add new way-points to the split radius if already split
if(!bpp.get_split_tangent_radius())
bpp.set_split_tangent_radius();
bpp.set_tangent2(Vector(bpp.get_tangent2().mag()*origin, bpp.get_tangent2().angle()));
// Update next BLinePoint's tangent's radius
// Do not add new way-points to the split radius if already split
if(!bpn.get_split_tangent_radius())
bpn.set_split_tangent_radius();
bpn.set_tangent1(Vector(bpn.get_tangent1().mag()*(1.0-origin), bpn.get_tangent1().angle()));
// Now add the actions to modify the value descs
{
// BEFORE
Action::Handle action(Action::create("ValueDescSet"));
if(!action)
throw Error(_("Unable to find action ValueDescSet (bug)"));
action->set_param("edit_mode",get_edit_mode());
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("new_value",ValueBase(bpp));
action->set_param("value_desc",ValueDesc(value_node,before));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
}
{
// AFTER
Action::Handle action(Action::create("ValueDescSet"));
if(!action)
throw Error(_("Unable to find action ValueDescSet (bug)"));
action->set_param("edit_mode",get_edit_mode());
action->set_param("canvas",get_canvas());
action->set_param("canvas_interface",get_canvas_interface());
action->set_param("time",time);
action->set_param("new_value",ValueBase(bpn));
action->set_param("value_desc",ValueDesc(value_node,after));
if(!action->is_ready())
throw Error(Error::TYPE_NOTREADY);
add_action(action);
}
}
}
}
}
///////////// VALUENODEDYNAMICLISTINSERTITEMSMARTKEEPSHAPE
Action::ValueNodeDynamicListInsertSmartKeepShape::ValueNodeDynamicListInsertSmartKeepShape()
{
keep_shape=true;
}