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

#include <valuenode_join.h>

Inheritance diagram for synfig::ValueNode_Join:
synfig::LinkableValueNode synfig::ValueNode synfig::Node

Public Types

typedef etl::handle
< ValueNode_Join
Handle
typedef etl::handle< const
ValueNode_Join
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

virtual ValueBase operator() (Time t) const
 Returns the value of the ValueNode at time t.
virtual ~ValueNode_Join ()
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 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_Joincreate (const ValueBase &x)
- 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()
virtual bool set_link_vfunc (int i, ValueNode::Handle x)
- 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

Constructor & Destructor Documentation

ValueNode_Join::~ValueNode_Join ( )
virtual

Member Function Documentation

ValueBase ValueNode_Join::operator() ( Time  ) const
virtual

Returns the value of the ValueNode at time t.

Reimplemented from synfig::ValueNode.

References synfig::ValueNode::get_type(), and synfig::type_string.

String ValueNode_Join::get_name ( ) const
virtual

Returns the name of the ValueNode type.

Implements synfig::ValueNode.

String ValueNode_Join::get_local_name ( ) const
virtual

Returns the localized name of the ValueNode type.

Implements synfig::ValueNode.

References _.

ValueNode::LooseHandle ValueNode_Join::get_link_vfunc ( int  i) const
virtual

Virtual member to get the linked Value Node Handle.

Implements synfig::LinkableValueNode.

References synfig::LinkableValueNode::link_count().

LinkableValueNode * ValueNode_Join::create_new ( ) const
protectedvirtual

Wrapper for new operator, used by clone()

Implements synfig::LinkableValueNode.

References synfig::ValueNode::get_type().

bool ValueNode_Join::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::LinkableValueNode::link_count(), synfig::type_list, and synfig::type_string.

bool ValueNode_Join::check_type ( Type type)
static

References synfig::type_string.

ValueNode_Join * ValueNode_Join::create ( const ValueBase x)
static
LinkableValueNode::Vocab ValueNode_Join::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: