synfig::ValueNode_Range Class Reference

#include <valuenode_range.h>

Inheritance diagram for synfig::ValueNode_Range:

Public Types
typedef etl::handle < ValueNode_Range >	Handle
typedef etl::handle< const ValueNode_Range >	ConstHandle
Public Types inherited from synfig::LinkableValueNode
typedef etl::handle < LinkableValueNode >	Handle
typedef etl::loose_handle < LinkableValueNode >	LooseHandle
typedef etl::handle< const LinkableValueNode >	ConstHandle
typedef etl::rhandle < LinkableValueNode >	RHandle
typedef LinkableValueNode *(*	Factory )(const ValueBase &, etl::loose_handle< Canvas > canvas)
	Type that represents a pointer to a ValueNode's constructor.
typedef bool(*	CheckType )(Type &type)
	This represents a pointer to a Type check member fucntion.
typedef std::map< String, BookEntry >	Book
	Book of types of linkable value nodes indexed by type name.
typedef ParamVocab	Vocab
	The vocabulary of the children.
Public Types inherited from synfig::ValueNode
typedef etl::handle< ValueNode >	Handle
typedef etl::loose_handle < ValueNode >	LooseHandle
typedef etl::handle< const ValueNode >	ConstHandle
typedef etl::rhandle< ValueNode >	RHandle
Public Types inherited from synfig::Node
typedef TimePointSet	time_set

Public Member Functions
virtual ValueBase	operator() (Time t) const
	Returns the value of the ValueNode at time t.
virtual	~ValueNode_Range ()
virtual String	get_name () const
	Returns the name of the ValueNode type.
virtual String	get_local_name () const
	Returns the localized name of the ValueNode type.
ValueBase	get_inverse (Time t, const synfig::Vector &target_value) const
	Returns the modified Link to match the target value at time t.
ValueBase	get_inverse (Time t, const synfig::Angle &target_value) const
virtual ValueNode::LooseHandle	get_link_vfunc (int i) const
	Virtual member to get the linked Value Node Handle.
virtual Vocab	get_children_vocab_vfunc () const
	Pure Virtual member to get the children vocabulary.
Public Member Functions inherited from synfig::LinkableValueNode
	LinkableValueNode (Type &type=type_nil)
	Member to store the children vocabulary.
virtual int	link_count () const
	Returns the number of linked Value Nodes.
virtual String	link_local_name (int i) const
	Returns the local name of the 'i' linked Value Node.
virtual String	link_name (int i) const
	Returns the name of the 'i' linked Value Node.
virtual int	get_link_index_from_name (const String &name) const
	Returns the child index Value Node based on the name.
virtual ValueNode::Handle	clone (etl::loose_handle< Canvas > canvas, const GUID &deriv_guid=GUID()) const
	Clones a Value Node.
bool	set_link (int i, ValueNode::Handle x)
	Sets a new Value Node link by its index.
bool	set_link (const String &name, ValueNode::Handle x)
	Sets a new Value Node link by its name.
ValueNode::LooseHandle	get_link (int i) const
	Returns a Loose Handle to the Value Node based on the link's index.
ValueNode::LooseHandle	get_link (const String &name) const
	Returns a Loose Handle to the Value Node based on the link's name.
String	get_description (int index=-1, bool show_exported_name=true) const
	Return a full description of the linked ValueNode given by the index.
String	get_description (bool show_exported_name=true) const
virtual Vocab	get_children_vocab () const
	Gets the children vocabulary for linkable value nodes.
virtual void	set_root_canvas (etl::loose_handle< Canvas > x)
	Member to store the children vocabulary.

Static Public Member Functions
static bool	check_type (Type &type)
static ValueNode_Range *	create (const ValueBase &value=ValueBase())
Static Public Member Functions inherited from synfig::LinkableValueNode
static Book &	book ()
static Handle	create (const String &name, const ValueBase &x, etl::loose_handle< Canvas > canvas)
static bool	check_type (const String &name, Type &x)
	Member to store the children vocabulary.
Static Public Member Functions inherited from synfig::ValueNode
static bool	subsys_init ()
	Instantiates the book of ValaueNodes and register all the valid valuenodes on it.
static bool	subsys_stop ()
	Deletes the book of ValueNodes.
static void	breakpoint ()

Protected Member Functions
virtual bool	set_link_vfunc (int i, ValueNode::Handle x)
LinkableValueNode *	create_new () const
	Wrapper for new operator, used by clone()
Protected Member Functions inherited from synfig::LinkableValueNode
void	unlink_all ()
void	set_type (Type &t)
	Sets the type of the ValueNode.
virtual void	get_times_vfunc (Node::time_set &set) const
	Returns the cached times values for all the children (linked Value Nodes)
virtual void	set_children_vocab (const Vocab &rvocab)
	Virtual memebr to set the children vocabulary to a given value.

Additional Inherited Members
Public Attributes inherited from synfig::Node
std::set< Node * >	parent_set
Protected Attributes inherited from synfig::LinkableValueNode
Vocab	children_vocab
	Member to store the children vocabulary.

Member Typedef Documentation

typedef etl::handle<ValueNode_Range> synfig::ValueNode_Range::Handle

typedef etl::handle<const ValueNode_Range> synfig::ValueNode_Range::ConstHandle

Constructor & Destructor Documentation

synfig::ValueNode_Range::~ValueNode_Range ( )

virtual

Member Function Documentation

synfig::ValueBase synfig::ValueNode_Range::operator() ( Time  ) const

virtual

Returns the value of the ValueNode at time t.

Reimplemented from synfig::ValueNode.

References _, synfig::type_angle, synfig::type_integer, synfig::type_real, and synfig::type_time.

String ValueNode_Range::get_name ( ) const

virtual

Returns the name of the ValueNode type.

Implements synfig::ValueNode.

String ValueNode_Range::get_local_name ( ) const

virtual

Returns the localized name of the ValueNode type.

Implements synfig::ValueNode.

References _.

synfig::ValueBase synfig::ValueNode_Range::get_inverse	(	Time	t,
		const synfig::Vector &	target_value
	)		const

Returns the modified Link to match the target value at time t.

References synfig::Vector::mag(), synfig::type_angle, synfig::type_integer, synfig::type_real, and synfig::type_time.

synfig::ValueBase synfig::ValueNode_Range::get_inverse	(	Time	t,
		const synfig::Angle &	target_value
	)		const

ValueNode::LooseHandle ValueNode_Range::get_link_vfunc ( int  i ) const

virtual

Virtual member to get the linked Value Node Handle.

Implements synfig::LinkableValueNode.

References synfig::LinkableValueNode::link_count().

bool ValueNode_Range::set_link_vfunc ( int  i, ValueNode::Handle  x  )

protectedvirtual

Stores the Value Node in the sub parameter i after check if the type is the same. It has to be defined by the derived class.

Implements synfig::LinkableValueNode.

References CHECK_TYPE_AND_SET_VALUE, synfig::ValueNode::get_type(), and synfig::LinkableValueNode::link_count().

LinkableValueNode * ValueNode_Range::create_new ( ) const

protectedvirtual

Wrapper for new operator, used by clone()

Implements synfig::LinkableValueNode.

References synfig::ValueNode::get_type().

bool ValueNode_Range::check_type ( Type &  type )

static

References synfig::type_angle, synfig::type_integer, synfig::type_real, and synfig::type_time.

ValueNode_Range * ValueNode_Range::create ( const ValueBase &  value = ValueBase() )

static

LinkableValueNode::Vocab ValueNode_Range::get_children_vocab_vfunc ( ) const

virtual

Pure Virtual member to get the children vocabulary.

Implements synfig::LinkableValueNode.

References _, and synfig::LinkableValueNode::children_vocab.

---

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

• valuenode_range.h
• valuenode_range.cpp