Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / depsgraph / intern / node / deg_node_factory.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2019 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup depsgraph
21  */
22
23 #pragma once
24
25 #include "MEM_guardedalloc.h"
26
27 #include "intern/node/deg_node.h"
28 #include "intern/depsgraph_type.h"
29
30 struct ID;
31
32 namespace DEG {
33
34 struct DepsNodeFactory {
35         virtual NodeType type() const = 0;
36         virtual const char *type_name() const = 0;
37
38         virtual int id_recalc_tag() const = 0;
39
40         virtual Node *create_node(const ID *id,
41                                   const char *subdata,
42                                   const char *name) const = 0;
43 };
44
45 template <class ModeObjectType>
46 struct DepsNodeFactoryImpl : public DepsNodeFactory {
47         virtual NodeType type() const override;
48         virtual const char *type_name() const override;
49
50         virtual int id_recalc_tag() const override;
51
52         virtual Node *create_node(const ID *id,
53                                   const char *subdata,
54                                   const char *name) const override;
55 };
56
57 /* Register typeinfo */
58 void register_node_typeinfo(DepsNodeFactory *factory);
59
60 /* Get typeinfo for specified type */
61 DepsNodeFactory *type_get_factory(const NodeType type);
62
63 }  // namespace DEG
64
65 #include "intern/node/deg_node_factory_impl.h"