synfig-core  1.0.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
synfig::ValueNode_BLine Class Reference

#include <valuenode_bline.h>

Inheritance diagram for synfig::ValueNode_BLine:
synfig::ValueNode_DynamicList synfig::LinkableValueNode synfig::ValueNode synfig::Node

Public Types

typedef etl::handle
< ValueNode_BLine
Handle
typedef etl::handle< const
ValueNode_BLine
ConstHandle
- Public Types inherited from synfig::ValueNode_DynamicList
typedef etl::handle
< ValueNode_DynamicList
Handle
typedef etl::handle< const
ValueNode_DynamicList
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< ValueNodeHandle
typedef etl::loose_handle
< ValueNode
LooseHandle
typedef etl::handle< const
ValueNode
ConstHandle
typedef etl::rhandle< ValueNodeRHandle
- Public Types inherited from synfig::Node
typedef TimePointSet time_set

Public Member Functions

 ValueNode_BLine (etl::loose_handle< Canvas > canvas=0)
virtual ValueBase operator() (Time t) const
 Returns the value of the ValueNode at time t.
virtual ~ValueNode_BLine ()
virtual String link_local_name (int i) const
 Returns the local name of the 'i' linked Value Node.
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.
virtual ListEntry create_list_entry (int index, Time time=0, Real origin=0.5)
BLinePoint get_blinepoint (std::vector< ListEntry >::const_iterator current, Time t) const
virtual Vocab get_children_vocab_vfunc () const
 Pure Virtual member to get the children vocabulary.
- Public Member Functions inherited from synfig::ValueNode_DynamicList
void add (const ValueNode::Handle &value_node, int index=-1)
void add (const ListEntry &value_node, int index=-1)
void erase (const ValueNode::Handle &value_node)
void reindex ()
int find_next_valid_entry (int x, Time t) const
int find_prev_valid_entry (int x, Time t) const
virtual ValueNode::LooseHandle get_link_vfunc (int i) const
 Virtual member to get the linked Value Node Handle.
virtual int link_count () const
 Returns the number of linked Value Nodes.
virtual String link_name (int i) const
 Returns the name of the 'i' linked Value Node.
virtual ~ValueNode_DynamicList ()
virtual int get_link_index_from_name (const String &name) const
 Returns the child index Value Node based on the name.
bool get_loop () const
void set_loop (bool x)
void set_member_canvas (etl::loose_handle< Canvas >)
Typeget_contained_type () const
void insert_time (const Time &location, const Time &delta)
virtual ValueNode::Handle clone (etl::loose_handle< Canvas > canvas, const GUID &deriv_guid=GUID()) const
 Clones a Value Node.
- Public Member Functions inherited from synfig::LinkableValueNode
 LinkableValueNode (Type &type=type_nil)
 Member to store the children vocabulary.
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_BLinecreate (const ValueBase &x=type_list, etl::loose_handle< Canvas > canvas=0)
- Static Public Member Functions inherited from synfig::ValueNode_DynamicList
template<typename iterator >
static Handle create (iterator begin, iterator end)
static Handle create (Type &type=type_nil, etl::loose_handle< Canvas > canvas=0)
static ValueNode_DynamicListcreate_from (const ValueBase &x=type_gradient)
- Static Public Member Functions inherited from synfig::LinkableValueNode
static Bookbook ()
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

LinkableValueNodecreate_new () const
 Wrapper for new operator, used by clone()
- Protected Member Functions inherited from synfig::ValueNode_DynamicList
 ValueNode_DynamicList (Type &container_type=type_nil, etl::loose_handle< Canvas > canvas=0)
 ValueNode_DynamicList (Type &container_type, Type &type, etl::loose_handle< Canvas > canvas=0)
virtual bool set_link_vfunc (int i, ValueNode::Handle x)
virtual void get_times_vfunc (Node::time_set &set) const
 Returns the cached times values for all the children (linked Value Nodes)
- Protected Member Functions inherited from synfig::LinkableValueNode
void unlink_all ()
void set_type (Type &t)
 Sets the type of the ValueNode.
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::ValueNode_DynamicList
std::vector< ListEntrylist
- Protected Attributes inherited from synfig::ValueNode_DynamicList
Typecontainer_type
bool loop_

Detailed Description

Todo:
This needs to be documented further.

Member Typedef Documentation

Constructor & Destructor Documentation

ValueNode_BLine::ValueNode_BLine ( etl::loose_handle< Canvas canvas = 0)

Referenced by create(), and create_new().

ValueNode_BLine::~ValueNode_BLine ( )
virtual

Member Function Documentation

ValueBase ValueNode_BLine::operator() ( Time  ) const
virtual
String ValueNode_BLine::link_local_name ( int  i) const
virtual

Returns the local name of the 'i' linked Value Node.

Reimplemented from synfig::ValueNode_DynamicList.

References _, and synfig::ValueNode_DynamicList::list.

String ValueNode_BLine::get_name ( ) const
virtual

Returns the name of the ValueNode type.

Reimplemented from synfig::ValueNode_DynamicList.

String ValueNode_BLine::get_local_name ( ) const
virtual

Returns the localized name of the ValueNode type.

Reimplemented from synfig::ValueNode_DynamicList.

References _.

ValueNode_BLine::ListEntry ValueNode_BLine::create_list_entry ( int  index,
Time  time = 0,
Real  origin = 0.5 
)
virtual
LinkableValueNode * ValueNode_BLine::create_new ( ) const
protectedvirtual

Wrapper for new operator, used by clone()

Reimplemented from synfig::ValueNode_DynamicList.

References ValueNode_BLine().

bool ValueNode_BLine::check_type ( Type type)
static

Reimplemented from synfig::ValueNode_DynamicList.

References synfig::type_list.

ValueNode_BLine * ValueNode_BLine::create ( const ValueBase x = type_list,
etl::loose_handle< Canvas canvas = 0 
)
static
BLinePoint ValueNode_BLine::get_blinepoint ( std::vector< ListEntry >::const_iterator  current,
Time  t 
) const

Returns the BlinePoint at time t, with the tangents modified if the vertex is boned influenced, otherwise returns the Blinepoint at time t.

References synfig::Vector::angle(), synfig::BLinePoint::get_vertex(), synfig::BLinePoint::get_vertex_setup(), synfig::ValueNode_DynamicList::list, synfig::Vector::mag(), and zero().

Referenced by operator()().

LinkableValueNode::Vocab ValueNode_BLine::get_children_vocab_vfunc ( ) const
virtual

Pure Virtual member to get the children vocabulary.

Reimplemented from synfig::ValueNode_DynamicList.

References _, and synfig::ValueNode_DynamicList::list.


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