synfigapp::ValueDesc Class Reference

#include <value_desc.h>

Public Member Functions
bool	operator== (const ValueDesc &rhs) const
bool	operator!= (const ValueDesc &rhs) const
ValueDesc &	operator= (const ValueDesc &other)
	ValueDesc (synfig::Layer::Handle layer, const synfig::String &param_name, const ValueDesc &parent=blank)
	ValueDesc (synfig::Layer::LooseHandle layer, const synfig::String &param_name, const ValueDesc &parent=blank)
	ValueDesc (synfig::LinkableValueNode::Handle parent_value_node, int index, const ValueDesc &parent=blank)
	ValueDesc (synfig::LinkableValueNode::Handle parent_value_node, int index, synfig::Real s, const ValueDesc &parent=blank)
	ValueDesc (synfig::ValueNode_Animated::Handle parent_value_node, synfig::Time waypoint_time, const ValueDesc &parent=blank)
	ValueDesc (synfig::Canvas::Handle canvas, const synfig::String &name, const ValueDesc &parent=blank)
	ValueDesc (synfig::ValueNode_Const::Handle parent_value_node, const ValueDesc &parent=blank)
	ValueDesc (const ValueDesc &parent, const synfig::String &sub_name)
	ValueDesc (const ValueDesc &other)
	ValueDesc ()
	~ValueDesc ()
bool	is_valid () const
	operator bool () const
bool	parent_is_layer () const
bool	parent_is_value_node () const
bool	parent_is_linkable_value_node () const
bool	parent_is_value_node_const () const
bool	parent_is_waypoint () const
bool	parent_is_canvas () const
bool	parent_is_value_desc () const
bool	is_value_node () const
bool	is_const () const
bool	is_animated () const
bool	is_parent_desc_declared () const
const ValueDesc &	get_sub_parent_desc () const
const ValueDesc &	get_origin_desc () const
const ValueDesc &	get_parent_desc () const
synfig::Layer::Handle	get_layer () const
const synfig::String &	get_param_name () const
bool	find_param_desc (synfig::ParamDesc &out_param_desc) const
synfig::ValueNode::Handle	get_parent_value_node () const
int	get_index () const
synfig::Real	get_scalar () const
synfig::String	get_name () const
const std::vector < synfig::String > &	get_sub_names () const
const synfig::String &	get_sub_name () const
synfig::Time	get_waypoint_time () const
const synfig::String &	get_value_node_id () const
synfig::Canvas::Handle	get_canvas () const
synfig::ValueNode::Handle	get_value_node () const
synfig::ValueBase	get_value (synfig::Time time=0) const
synfig::Type &	get_value_type () const
bool	is_exported () const
synfig::String	get_description (bool show_exported_name=true) const
synfig::Interpolation	get_interpolation () const
bool	get_static () const
synfig::GUID	get_guid () const
synfig::String	get_guid_string () const
ValueDesc	create_sub_value (const synfig::String &sub_name) const
	sub_name should be NOT empty
ValueDesc	get_sub_value (const synfig::String &sub_name) const

Constructor & Destructor Documentation

synfigapp::ValueDesc::ValueDesc ( synfig::Layer::Handle  layer, const synfig::String &  param_name, const ValueDesc &  parent = blank  )

inline

synfigapp::ValueDesc::ValueDesc ( synfig::Layer::LooseHandle  layer, const synfig::String &  param_name, const ValueDesc &  parent = blank  )

inline

synfigapp::ValueDesc::ValueDesc ( synfig::LinkableValueNode::Handle  parent_value_node, int  index, const ValueDesc &  parent = blank  )

inline

synfigapp::ValueDesc::ValueDesc ( synfig::LinkableValueNode::Handle  parent_value_node, int  index, synfig::Real  s, const ValueDesc &  parent = blank  )

inline

synfigapp::ValueDesc::ValueDesc ( synfig::ValueNode_Animated::Handle  parent_value_node, synfig::Time  waypoint_time, const ValueDesc &  parent = blank  )

inline

synfigapp::ValueDesc::ValueDesc ( synfig::Canvas::Handle  canvas, const synfig::String &  name, const ValueDesc &  parent = blank  )

inline

synfigapp::ValueDesc::ValueDesc ( synfig::ValueNode_Const::Handle  parent_value_node, const ValueDesc &  parent = blank  )

inline

synfigapp::ValueDesc::ValueDesc ( const ValueDesc &  parent, const synfig::String &  sub_name  )

inline

synfigapp::ValueDesc::ValueDesc ( const ValueDesc &  other )

inline

synfigapp::ValueDesc::ValueDesc ( )

inline

Referenced by create_sub_value(), and get_sub_value().

synfigapp::ValueDesc::~ValueDesc ( )

inline

Member Function Documentation

bool synfigapp::ValueDesc::operator== ( const ValueDesc &  rhs ) const

inline

Referenced by operator!=().

bool synfigapp::ValueDesc::operator!= ( const ValueDesc &  rhs ) const

inline

References operator==().

ValueDesc& synfigapp::ValueDesc::operator= ( const ValueDesc &  other )

inline

bool synfigapp::ValueDesc::is_valid ( ) const

inline

Referenced by edit_several_waypoints(), studio::Duck::get_editable(), get_guid(), studio::Instance::make_param_menu(), studio::Duckmatic::on_duck_changed(), studio::CanvasView::on_waypoint_clicked_canvasview(), and operator bool().

synfigapp::ValueDesc::operator bool ( ) const

inline

References is_valid().

bool synfigapp::ValueDesc::parent_is_layer ( ) const

inline

Referenced by studio::Duckmatic::add_to_ducks(), find_param_desc(), synfigapp::CanvasInterface::generate_param_list(), get_guid(), get_interpolation(), get_layer(), get_param_name(), get_time_dilation_from_vdesc(), get_time_offset_from_vdesc(), get_value(), get_value_node(), is_animated(), is_const(), is_value_node(), studio::Instance::make_param_menu(), studio::Duckmatic::on_duck_changed(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::prepare(), and synfigapp::Action::ValueDescBLineLink::prepare().

bool synfigapp::ValueDesc::parent_is_value_node ( ) const

inline

Referenced by studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::generate_param_list(), get_parent_value_node(), get_times_from_vdesc(), synfigapp::Action::ValueDescResetPose::is_candidate(), synfigapp::Action::ValueDescSkeletonLink::is_candidate(), synfigapp::Action::ValueDescBoneLink::is_candidate(), synfigapp::Action::ValueDescCreateChildBone::is_candidate(), is_value_node(), studio::Instance::make_param_menu(), studio::Duckmatic::on_duck_changed(), parent_is_linkable_value_node(), parent_is_value_node_const(), parent_is_waypoint(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::set_param(), synfigapp::Action::ValueDescSkeletonLink::set_param(), synfigapp::Action::ValueDescResetPose::set_param(), synfigapp::Action::ValueDescCreateChildBone::set_param(), and studio::Duck::set_sub_trans_point().

bool synfigapp::ValueDesc::parent_is_linkable_value_node ( ) const

inline

References parent_is_value_node().

Referenced by studio::Duckmatic::add_to_ducks(), edit_several_waypoints(), get_index(), get_name(), get_scalar(), get_value_node(), synfigapp::Action::ValueDescConvert::is_candidate(), synfigapp::Action::ValueDescExport::is_candidate(), is_const(), synfigapp::Action::ValueDescBLineLink::prepare(), and synfigapp::Action::ValueDescLink::prepare().

bool synfigapp::ValueDesc::parent_is_value_node_const ( ) const

inline

References parent_is_value_node().

Referenced by get_value(), get_value_node(), and is_const().

bool synfigapp::ValueDesc::parent_is_waypoint ( ) const

inline

References parent_is_value_node().

Referenced by get_value_node(), and get_waypoint_time().

bool synfigapp::ValueDesc::parent_is_canvas ( ) const

inline

Referenced by studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::generate_param_list(), get_value_node(), get_value_node_id(), is_animated(), synfigapp::Action::ValueDescExport::is_candidate(), is_value_node(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), and studio::CanvasTreeStore::set_row().

bool synfigapp::ValueDesc::parent_is_value_desc ( ) const

inline

Referenced by get_guid(), get_origin_desc(), get_sub_name(), and get_sub_names().

bool synfigapp::ValueDesc::is_value_node ( ) const

inline

References parent_is_canvas(), parent_is_layer(), and parent_is_value_node().

Referenced by _process_value_desc(), studio::Duckmatic::add_ducks_layers(), studio::Duckmatic::add_to_ducks(), studio::Dialog_Gradient::edit(), edit_several_waypoints(), synfigapp::CanvasInterface::generate_param_list(), studio::Duck::get_data_guid(), get_guid(), get_value(), studio::LayerParamTreeStore::get_value_vfunc(), studio::CanvasTreeStore::get_value_vfunc(), synfigapp::Action::ValueDescExport::is_candidate(), is_exported(), studio::Instance::make_param_menu(), synfigapp::Action::ValueDescBLineLink::prepare(), studio::CanvasTreeStore::refresh_row(), and studio::CanvasTreeStore::set_row().

bool synfigapp::ValueDesc::is_const ( ) const

inline

References get_value_node(), parent_is_layer(), parent_is_linkable_value_node(), and parent_is_value_node_const().

Referenced by studio::Dialog_Gradient::edit(), synfigapp::CanvasInterface::generate_param_list(), get_interpolation(), get_static(), studio::CanvasTreeStore::get_value_vfunc(), and studio::Instance::make_param_menu().

bool synfigapp::ValueDesc::is_animated ( ) const

inline

References get_value_node(), parent_is_canvas(), and parent_is_layer().

Referenced by studio::Instance::make_param_menu().

bool synfigapp::ValueDesc::is_parent_desc_declared ( ) const

inline

const ValueDesc& synfigapp::ValueDesc::get_sub_parent_desc ( ) const

inline

Referenced by get_guid(), get_origin_desc(), and get_parent_desc().

const ValueDesc& synfigapp::ValueDesc::get_origin_desc ( ) const

inline

References get_origin_desc(), get_sub_parent_desc(), and parent_is_value_desc().

Referenced by get_origin_desc(), and get_parent_desc().

const ValueDesc& synfigapp::ValueDesc::get_parent_desc ( ) const

inline

References get_origin_desc(), and get_sub_parent_desc().

Referenced by studio::Duckmatic::on_duck_changed(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescCreateChildBone::prepare(), synfigapp::Action::ValueDescResetPose::set_param(), and synfigapp::Action::ValueDescSkeletonLink::set_param().

synfig::Layer::Handle synfigapp::ValueDesc::get_layer ( ) const

inline

References parent_is_layer().

Referenced by studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::generate_param_list(), get_guid(), get_time_dilation_from_vdesc(), get_time_offset_from_vdesc(), studio::Instance::make_param_menu(), studio::Duckmatic::on_duck_changed(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), and studio::Widget_Sublayer::set_value_desc().

const synfig::String& synfigapp::ValueDesc::get_param_name ( ) const

inline

References parent_is_layer().

Referenced by synfigapp::CanvasInterface::generate_param_list(), get_guid(), studio::Instance::make_param_menu(), studio::Duckmatic::on_duck_changed(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::LayerParamUnSetStatic::set_param(), and synfigapp::Action::LayerParamSetStatic::set_param().

bool synfigapp::ValueDesc::find_param_desc ( synfig::ParamDesc &  out_param_desc ) const

inline

References parent_is_layer().

synfig::ValueNode::Handle synfigapp::ValueDesc::get_parent_value_node ( ) const

inline

References parent_is_value_node().

Referenced by studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::generate_param_list(), get_times_from_vdesc(), synfigapp::Action::ValueDescConvert::is_candidate(), synfigapp::Action::ValueNodeStaticListLoop::is_candidate(), synfigapp::Action::ValueNodeStaticListUnLoop::is_candidate(), synfigapp::Action::ValueDescExport::is_candidate(), synfigapp::Action::ValueNodeDynamicListUnLoop::is_candidate(), synfigapp::Action::ValueNodeDynamicListLoop::is_candidate(), studio::Duckmatic::on_duck_changed(), synfigapp::ActiveTimeInfo::operator<(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::ValueDescResetPose::set_param(), synfigapp::Action::ValueDescSkeletonLink::set_param(), synfigapp::Action::ValueDescBoneLink::set_param(), and synfigapp::Action::ValueDescCreateChildBone::set_param().

int synfigapp::ValueDesc::get_index ( ) const

inline

References parent_is_linkable_value_node().

Referenced by studio::Duckmatic::add_to_ducks(), get_times_from_vdesc(), synfigapp::Action::ValueDescConvert::is_candidate(), synfigapp::Action::ValueDescExport::is_candidate(), studio::Duckmatic::on_duck_changed(), synfigapp::ActiveTimeInfo::operator<(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::ValueDescLink::prepare(), synfigapp::Action::ValueNodeStaticListRotateOrder::set_param(), synfigapp::Action::ActivepointRemove::set_param(), synfigapp::Action::ValueNodeDynamicListRotateOrder::set_param(), synfigapp::Action::ValueNodeDynamicListRemove::set_param(), synfigapp::Action::ValueDescBLineLink::set_param(), synfigapp::Action::ValueNodeStaticListInsertSmart::set_param(), synfigapp::Action::ValueNodeStaticListRemove::set_param(), synfigapp::Action::ValueNodeDynamicListRemoveSmart::set_param(), synfigapp::Action::ActivepointSet::set_param(), synfigapp::Action::ActivepointSetOff::set_param(), synfigapp::Action::ActivepointSimpleAdd::set_param(), synfigapp::Action::ActivepointAdd::set_param(), synfigapp::Action::ActivepointSetOn::set_param(), synfigapp::Action::ValueNodeStaticListInsert::set_param(), synfigapp::Action::ValueNodeStaticListRemoveSmart::set_param(), synfigapp::Action::ValueNodeDynamicListInsertSmart::set_param(), synfigapp::Action::ValueNodeDynamicListInsert::set_param(), and synfigapp::Action::ActivepointSetSmart::set_param().

synfig::Real synfigapp::ValueDesc::get_scalar ( ) const

inline

References parent_is_linkable_value_node().

Referenced by synfigapp::Action::ValueDescLink::prepare().

synfig::String synfigapp::ValueDesc::get_name ( ) const

inline

References parent_is_linkable_value_node().

const std::vector<synfig::String>& synfigapp::ValueDesc::get_sub_names ( ) const

inline

References parent_is_value_desc().

Referenced by get_guid().

const synfig::String& synfigapp::ValueDesc::get_sub_name ( ) const

inline

References parent_is_value_desc().

Referenced by synfigapp::Action::ValueDescBLineLink::prepare().

synfig::Time synfigapp::ValueDesc::get_waypoint_time ( ) const

inline

References parent_is_waypoint().

const synfig::String& synfigapp::ValueDesc::get_value_node_id ( ) const

inline

References parent_is_canvas().

synfig::Canvas::Handle synfigapp::ValueDesc::get_canvas ( ) const

inline

Referenced by synfigapp::CanvasInterface::change_value(), and studio::CanvasTreeStore::set_row().

synfig::ValueNode::Handle synfigapp::ValueDesc::get_value_node ( ) const

inline

References parent_is_canvas(), parent_is_layer(), parent_is_linkable_value_node(), parent_is_value_node_const(), and parent_is_waypoint().

Referenced by _process_value_desc(), studio::CellRenderer_TimeTrack::activate_vfunc(), studio::Duckmatic::add_ducks_layers(), studio::Duckmatic::add_to_ducks(), studio::Dialog_Gradient::edit(), edit_several_waypoints(), synfigapp::CanvasInterface::generate_param_list(), studio::Duck::get_data_guid(), get_guid(), get_interpolation(), get_times_from_vdesc(), get_value(), get_value_type(), studio::LayerParamTreeStore::get_value_vfunc(), studio::CanvasTreeStore::get_value_vfunc(), is_animated(), synfigapp::Action::ValueNodeConstSetStatic::is_candidate(), synfigapp::Action::ValueNodeConstUnSetStatic::is_candidate(), synfigapp::Action::ValueDescExport::is_candidate(), is_const(), is_exported(), studio::Instance::make_param_menu(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::ValueDescLink::prepare(), studio::CanvasTreeStore::rebuild_row(), studio::CanvasTreeStore::refresh_row(), studio::CellRenderer_TimeTrack::render_vfunc(), studio::CanvasTreeStore::set_row(), studio::Dialog_Waypoint::set_value_desc(), synfigapp::CanvasInterface::waypoint_duplicate(), and synfigapp::CanvasInterface::waypoint_remove().

synfig::ValueBase synfigapp::ValueDesc::get_value ( synfig::Time  time = 0 ) const

inline

References get_value_node(), is_value_node(), parent_is_layer(), and parent_is_value_node_const().

Referenced by _process_value_desc(), studio::CellRenderer_TimeTrack::activate_vfunc(), studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::change_value(), studio::Dialog_Gradient::edit(), edit_several_waypoints(), synfigapp::CanvasInterface::generate_param_list(), get_interpolation(), get_static(), get_time_dilation_from_vdesc(), get_time_offset_from_vdesc(), get_times_from_vdesc(), get_value_type(), studio::CanvasTreeStore::get_value_vfunc(), synfigapp::Action::ValueDescExport::is_candidate(), studio::Duckmatic::on_duck_changed(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::prepare(), and synfigapp::Action::ValueDescBLineLink::prepare().

synfig::Type& synfigapp::ValueDesc::get_value_type ( ) const

inline

References get_value(), and get_value_node().

Referenced by _process_value_desc(), studio::CellRenderer_TimeTrack::activate_vfunc(), studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::generate_param_list(), get_time_dilation_from_vdesc(), get_time_offset_from_vdesc(), get_times_from_vdesc(), studio::CanvasTreeStore::get_value_vfunc(), synfigapp::Action::ValueDescExport::is_candidate(), studio::Instance::make_param_menu(), studio::Duckmatic::on_duck_changed(), synfigapp::Action::ValueDescSkeletonLink::prepare(), synfigapp::Action::ValueDescBoneLink::prepare(), synfigapp::Action::ValueDescCreateChildBone::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), and synfigapp::Action::ColorSet::set_param().

bool synfigapp::ValueDesc::is_exported ( ) const

inline

References get_value_node(), and is_value_node().

Referenced by synfigapp::Action::ValueDescLink::prepare().

String ValueDesc::get_description

(

bool

show_exported_name = true

)

const

References _.

synfig::Interpolation synfigapp::ValueDesc::get_interpolation ( ) const

inline

References get_value(), get_value_node(), is_const(), and parent_is_layer().

Referenced by studio::CanvasTreeStore::get_value_vfunc().

bool synfigapp::ValueDesc::get_static ( ) const

inline

References get_value(), and is_const().

Referenced by studio::CanvasTreeStore::get_value_vfunc(), and studio::Instance::make_param_menu().

synfig::GUID synfigapp::ValueDesc::get_guid ( ) const

inline

References get_guid(), get_layer(), get_param_name(), get_sub_names(), get_sub_parent_desc(), get_value_node(), is_valid(), is_value_node(), parent_is_layer(), and parent_is_value_desc().

Referenced by calc_duck_guid(), get_guid(), and get_guid_string().

synfig::String synfigapp::ValueDesc::get_guid_string ( ) const

inline

References get_guid().

Referenced by studio::Duckmatic::add_to_ducks(), and set_duck_value_desc().

ValueDesc synfigapp::ValueDesc::create_sub_value ( const synfig::String &  sub_name ) const

inline

sub_name should be NOT empty

References ValueDesc().

ValueDesc synfigapp::ValueDesc::get_sub_value ( const synfig::String &  sub_name ) const

inline

Returns

copy of it self when sum_name is empty string

References ValueDesc().

Referenced by studio::Duckmatic::add_to_ducks(), and set_duck_value_desc().

---

The documentation for this class was generated from the following files:

• value_desc.h
• value_desc.cpp