Rename get_param_vocab to get_children_vocab and use a wrapper for the pure virtual...
[synfig.git] / synfig-core / src / modules / mod_noise / valuenode_random.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuenode_random.h
3 **      \brief Template Header
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 2007 Chris Moore
10 **
11 **      This package is free software; you can redistribute it and/or
12 **      modify it under the terms of the GNU General Public License as
13 **      published by the Free Software Foundation; either version 2 of
14 **      the License, or (at your option) any later version.
15 **
16 **      This package is distributed in the hope that it will be useful,
17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 **      General Public License for more details.
20 **      \endlegal
21 */
22 /* ========================================================================= */
23
24 /* === S T A R T =========================================================== */
25
26 #ifndef __SYNFIG_VALUENODE_INTERPOLATION_RANDOM_H
27 #define __SYNFIG_VALUENODE_INTERPOLATION_RANDOM_H
28
29 /* === H E A D E R S ======================================================= */
30
31 #include "synfig/valuenode.h"
32 #include "random_noise.h"
33
34 /* === M A C R O S ========================================================= */
35
36 /* === C L A S S E S & S T R U C T S ======================================= */
37
38 namespace synfig {
39
40 class ValueNode_Random : public LinkableValueNode
41 {
42         ValueNode::RHandle link_;
43         ValueNode::RHandle radius_;
44         ValueNode::RHandle seed_;
45         ValueNode::RHandle speed_;
46         ValueNode::RHandle smooth_;
47         ValueNode::RHandle loop_;
48
49         mutable RandomNoise random;
50         RandomNoise::SmoothType smooth;
51         ValueNode_Random(const ValueBase &value);
52
53 public:
54
55         typedef etl::handle<ValueNode_Random> Handle;
56         typedef etl::handle<const ValueNode_Random> ConstHandle;
57
58         virtual ValueBase operator()(Time t)const;
59
60         virtual ~ValueNode_Random();
61
62         virtual String get_name()const;
63         virtual String get_local_name()const;
64
65         virtual ValueNode::LooseHandle get_link_vfunc(int i)const;
66         virtual int link_count()const;
67         virtual String link_name(int i)const;
68
69         virtual String link_local_name(int i)const;
70         virtual int get_link_index_from_name(const String &name)const;
71
72         virtual ValueNode* clone(const GUID& deriv_guid=GUID())const;
73
74         void randomize_seed();
75
76 protected:
77         LinkableValueNode* create_new()const;
78         virtual bool set_link_vfunc(int i,ValueNode::Handle x);
79
80 public:
81         using synfig::LinkableValueNode::get_link_vfunc;
82         using synfig::LinkableValueNode::set_link_vfunc;
83         static bool check_type(ValueBase::Type type);
84         static ValueNode_Random* create(const ValueBase &x);
85         virtual Vocab get_children_vocab_vfunc()const;
86 }; // END of class ValueNode_Random
87
88 }; // END of namespace synfig
89
90 /* === E N D =============================================================== */
91
92 #endif