Registry class used to declare and register a plug-in node. More...

#include <Registry.h>

Public Types
using	Factory = std::function< std::shared_ptr< NodePlugin >(Node *node)>
	The factory function prototype. More...

Public Member Functions
virtual	~Registry ()

virtual void	register_node (const char class_name, const char base_class_name, Factory factory, const std::vector< PlugDescriptor > &plug_desc, const char *ui_descriptor="")=0
	Declare a plug-in node. More...

virtual void	register_node (const char class_name, const char base_class_name, const std::vector< PlugDescriptor > &plug_desc, const char *ui_descriptor="")=0
	Declare a plug-in node. More...

virtual void	register_node_loader (const std::shared_ptr< NodeLoaderPlugin > &node_loader)=0
	Declare a node loader plug-in. More...

Detailed Description

Registry class used to declare and register a plug-in node.

Member Typedef Documentation

using maquina::Registry::Factory = std::function<std::shared_ptr<NodePlugin>( Node *node )>

The factory function prototype.

virtual maquina::Registry::~Registry ( )

inlinevirtual

virtual void maquina::Registry::register_node	(	const char *	class_name,
		const char *	base_class_name,
		Factory	factory,
		const std::vector< PlugDescriptor > &	plug_desc,
		const char *	ui_descriptor = `""`
	)

pure virtual

Declare a plug-in node.

The plug-in must declare the plug-in nodes using this method.

Parameters

class_name	in The new class name
base_class_name	in The parent class name, "Node" is the base class
factory	in The factory function to allocate a node, provided by the plug-in
plug_desc	in The plugs descriptor
ui_descriptor	in A json string to describe the node user interface

virtual void maquina::Registry::register_node	(	const char *	class_name,
		const char *	base_class_name,
		const std::vector< PlugDescriptor > &	plug_desc,
		const char *	ui_descriptor = `""`
	)

pure virtual

Declare a plug-in node.

The plug-in must declare the plug-in nodes using this method.

Parameters

class_name	in The new class name
base_class_name	in The parent class name, "Node" is the base class
plug_desc	in The plugs descriptor
ui_descriptor	in A json string to describe the node user interface

virtual void maquina::Registry::register_node_loader ( const std::shared_ptr< NodeLoaderPlugin > & node_loader )

pure virtual

Declare a node loader plug-in.

Parameters

node_loader The node loader plug-in

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