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

StaticList ValueNode. More...

#include <valuenode_staticlist.h>

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

Public Types

typedef etl::handle
< ValueNode_StaticList
Handle
typedef etl::handle< const
ValueNode_StaticList
ConstHandle
typedef ValueNode::Handle ListEntry
typedef ValueNode::RHandle ReplaceableListEntry
- 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

void add (const ValueNode::Handle &value_node, int index=-1)
void erase (const ListEntry &value_node)
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 ValueBase operator() (Time t) const
 Returns the value of the ValueNode at time t.
virtual String link_local_name (int i) const
 Returns the local 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 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.
bool get_loop () const
void set_loop (bool x)
void set_member_canvas (etl::loose_handle< Canvas >)
Typeget_contained_type () const
virtual ValueNode::Handle clone (etl::loose_handle< Canvas > canvas, const GUID &deriv_guid=GUID()) const
 Clones a Value Node.
virtual ListEntry create_list_entry (int index, Time time=0, Real origin=0.5)
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.
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

template<typename iterator >
static Handle create (iterator begin, iterator end)
static Handle create (Type &type=type_nil, etl::loose_handle< Canvas > canvas=0)
static bool check_type (Type &type)
static ValueNode_StaticListcreate_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 ()

Public Attributes

std::vector< ReplaceableListEntrylist

Protected Member Functions

 ValueNode_StaticList (Type &container_type=type_nil, etl::loose_handle< Canvas > canvas=0)
virtual ~ValueNode_StaticList ()
virtual bool set_link_vfunc (int i, ValueNode::Handle x)
LinkableValueNodecreate_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.

Protected Attributes

Typecontainer_type
bool loop_
- Protected Attributes inherited from synfig::LinkableValueNode
Vocab children_vocab
 Member to store the children vocabulary.

Detailed Description

StaticList ValueNode.

This ValueNode is set up to have a list of ValueNodes.

Member Typedef Documentation

Constructor & Destructor Documentation

ValueNode_StaticList::ValueNode_StaticList ( Type container_type = type_nil,
etl::loose_handle< Canvas canvas = 0 
)
protected
ValueNode_StaticList::~ValueNode_StaticList ( )
protectedvirtual

Member Function Documentation

void ValueNode_StaticList::add ( const ValueNode::Handle value_node,
int  index = -1 
)

Referenced by clone().

void ValueNode_StaticList::erase ( const ListEntry value_node)
ValueNode::LooseHandle ValueNode_StaticList::get_link_vfunc ( int  i) const
virtual

Virtual member to get the linked Value Node Handle.

Implements synfig::LinkableValueNode.

int ValueNode_StaticList::link_count ( ) const
virtual

Returns the number of linked Value Nodes.

Reimplemented from synfig::LinkableValueNode.

References list.

String ValueNode_StaticList::link_name ( int  i) const
virtual

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

Reimplemented from synfig::LinkableValueNode.

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

Returns the value of the ValueNode at time t.

Reimplemented from synfig::ValueNode.

References _, synfig::type_nil, and synfig::warning().

String ValueNode_StaticList::link_local_name ( int  i) const
virtual

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

Reimplemented from synfig::LinkableValueNode.

References _.

int ValueNode_StaticList::get_link_index_from_name ( const String name) const
virtual

Returns the child index Value Node based on the name.

Reimplemented from synfig::LinkableValueNode.

String ValueNode_StaticList::get_name ( ) const
virtual

Returns the name of the ValueNode type.

Implements synfig::ValueNode.

String ValueNode_StaticList::get_local_name ( ) const
virtual

Returns the localized name of the ValueNode type.

Implements synfig::ValueNode.

References _.

bool synfig::ValueNode_StaticList::get_loop ( ) const
inline

References loop_.

Referenced by clone().

void synfig::ValueNode_StaticList::set_loop ( bool  x)
inline

References loop_.

Referenced by clone().

void ValueNode_StaticList::set_member_canvas ( etl::loose_handle< Canvas canvas)

References list.

Type & ValueNode_StaticList::get_contained_type ( ) const

References container_type.

template<typename iterator >
static Handle synfig::ValueNode_StaticList::create ( iterator  begin,
iterator  end 
)
inlinestatic
ValueNode::Handle ValueNode_StaticList::clone ( etl::loose_handle< Canvas canvas,
const GUID deriv_guid = GUID() 
) const
virtual
ValueNode_StaticList::ListEntry ValueNode_StaticList::create_list_entry ( int  index,
Time  time = 0,
Real  origin = 0.5 
)
virtual
bool ValueNode_StaticList::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 container_type, and list.

LinkableValueNode * ValueNode_StaticList::create_new ( ) const
protectedvirtual

Wrapper for new operator, used by clone()

Implements synfig::LinkableValueNode.

References container_type, and ValueNode_StaticList().

Referenced by clone().

static Handle synfig::ValueNode_StaticList::create ( Type type = type_nil,
etl::loose_handle< Canvas canvas = 0 
)
static
Note
The construction parameter (id) is the type that the list contains, rather than the type that it will yield (which is type_list)
bool ValueNode_StaticList::check_type ( Type type)
static

References synfig::type_list.

ValueNode_StaticList * ValueNode_StaticList::create_from ( const ValueBase x = type_gradient)
static
LinkableValueNode::Vocab ValueNode_StaticList::get_children_vocab_vfunc ( ) const
virtual

Pure Virtual member to get the children vocabulary.

Implements synfig::LinkableValueNode.

References _, and list.

Member Data Documentation

Type* synfig::ValueNode_StaticList::container_type
protected
bool synfig::ValueNode_StaticList::loop_
protected

Referenced by get_loop(), and set_loop().

std::vector<ReplaceableListEntry> synfig::ValueNode_StaticList::list

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