Commands to create new plugins, Grob class names, Tool, Commands and Shader. More...

#include <OGF/devel/commands/scene_graph_devel_commands.h>

Inheritance diagram for OGF::SceneGraphDevelCommands:

Public Member Functions
	SceneGraphDevelCommands ()
	SceneGraphDevelCommands constructor.

	~SceneGraphDevelCommands () override
	SceneGraphDevelCommands destructor.

void	create_plugin (const std::string &plugin_name, const std::string &author="Nicolas Bourbaki", const std::string &contact="", bool autoload=true)
	Creates C++ skeleton sources for a new plugin.

void	create_commands (const DynamicModuleName &plugin_name, const GrobClassName &type, const std::string &name)
	Creates a new Commands class in a plugin.

void	create_scene_graph_commands (const DynamicModuleName &plugin_name, const std::string &name)
	Creates a new Commands class for the SceneGraph in a plugin.

void	create_shader (const DynamicModuleName &plugin_name, const GrobClassName &type, const std::string &name, const std::string &base_class_name="")
	Creates a new Shader class in a plugin.

void	create_tool (const DynamicModuleName &plugin_name, const GrobClassName &type, const std::string &name, const std::string &base_class_name="")
	Creates a new tool in a plugin.

void	create_grob (const DynamicModuleName &plugin_name, const std::string &grob_name, const std::string &file_extension="", const std::string &base_class_name="")
	Creates a new Grob class in a plugin.

void	create_class (const DynamicModuleName &plugin_name, const std::string &subdirectory, const std::string &class_name)
	Creates a new class in a plugin.

void	create_file (const DynamicModuleName &plugin_name, const std::string &subdirectory, const std::string &name)
	Creates a new file in a plugin.

Public Member Functions inherited from OGF::SceneGraphCommands
	SceneGraphCommands ()
	SceneGraphCommands constructor.

	~SceneGraphCommands () override
	SceneGraphCommands destructor.

SceneGraph *	scene_graph () const
	Gets the SceneGraph.

Public Member Functions inherited from OGF::Commands
	Commands ()
	Commands constructor.

	~Commands () override
	Commands destructor.

bool	invoke_method (const std::string &method_name, const ArgList &args, Any &ret_val) override
	Invokes a method by method name and argument list, and gets the return value.

Interpreter *	interpreter ()
	Gets the main Interpreter.

void	set_chrono (bool value)
	Sets whether timings are reported.

Public Member Functions inherited from OGF::Interface
	Interface ()
	Interface constructor.

	~Interface () override
	Interface destructor.

Grob *	grob () const
	Gets the Grob.

SceneGraph *	scene_graph () const
	Gets the SceneGraph.

Grob *	get_grob () const
	Gets the current Grob.

Public Member Functions inherited from OGF::Object
	Object (bool transient=false)
	Object constructor.

	~Object () override
	Object destructor.

virtual MetaClass *	meta_class () const
	Gets the meta class.

virtual void	set_meta_class (MetaClass *mclass)
	Sets the meta class.

unsigned int	id () const
	Gets the identifier of this object.

std::string	string_id () const
	Gets the unique string identifier.

bool	has_method (const std::string &method_name) const
	Tests whether a method is defined.

bool	invoke_method (const std::string &method_name, const ArgList &args)
	Invokes a method by method name and argument list.

bool	invoke_method (const std::string &method_name)
	Invokes a method by method name.

bool	has_property (const std::string &prop_name) const
	Tests whether a property is defined.

virtual bool	get_property (const std::string &prop_name, std::string &prop_value) const
	Gets a property.

virtual Connection *	connect_signal_to_slot (const std::string &signal_name, Object *to, const std::string &slot_name)
	Connects a signal with a slot of another object.

virtual void	add_connection (Connection *connection)
	Adds a connection to this object.

virtual void	remove_connection (Connection *connection)
	Removes a connection to this object.

virtual void	get_element (index_t i, Any &value) const
	Gets an element by index.

virtual void	set_element (index_t i, const Any &value)
	Sets an element by index.

void	get_element (index_t item, index_t component, Any &value) const
	Gets an element by item and component.

void	set_element (index_t item, index_t component, const Any &value)
	Sets an element by item and component.

virtual void	search (const std::string &needle, const std::string &path="")
	Displays the names of all objects that contain a substring.

virtual index_t	get_dimension () const
	Gets the number of elements per item.

bool	get_signals_enabled () const
	Tests wheter signals are enabled.

void	set_signals_enabled (bool value)
	Enables or disables signals.

bool	get_slots_enabled () const
	Tests wheter slots are enabled.

void	set_slots_enabled (bool value)
	Enables or disables slots.

MetaClass *	get_meta_class () const
	Gets the meta class.

std::string	get_string_id () const
	Gets the unique string identifier.

virtual std::string	get_doc () const
	Gets the documentation.

virtual Sign	compare (const Object *other) const
	Compares this object with another one.

virtual bool	is_a (const MetaType *type) const
	Tests whether this object inherits a given type.

void	disconnect ()
	Removes all connections from signals of this objects.

void	enable_signals ()
	Enables signals.

void	disable_signals ()
	Disables signals.

void	enable_slots ()
	Enables slots.

void	disable_slots ()
	Disables slots.

void	set_properties (const ArgList &args)
	Sets several properties in a single call.

virtual bool	set_property (const std::string &name, const std::string &value)
	Sets an individual property.

void	help () const
	Displays some help about this object.

virtual bool	set_property (const std::string &name, const Any &value)
	Sets an individual property.

virtual bool	get_property (const std::string &prop_name, Any &prop_value) const
	Gets a property.

Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count.

void	unref () const
	Decrements the reference count.

bool	is_shared () const
	Check if the object is shared.

int	nb_refs () const
	Gets the number of references that point to this object.

Public Attributes
	: void load_plugin(const std::string& plugin_name)

Public Attributes inherited from OGF::Commands
	: bool get_chrono() const { return chrono_

Public Attributes inherited from OGF::Interface
	: virtual void set_grob(Grob* value)

Public Attributes inherited from OGF::Object
	: virtual index_t get_nb_elements() const

	: bool equals(const Object* other) const

Additional Inherited Members
Static Public Member Functions inherited from OGF::Commands
static bool	command_is_running ()
	Tests whether a command is currently running.

Static Public Member Functions inherited from OGF::Object
static Object *	id_to_object (unsigned int id)
	Gets an object from a unique object id.

Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count.

static void	unref (const Counted *counted)
	Decrements the reference count.

Protected Member Functions inherited from OGF::Object
virtual bool	emit_signal (const std::string &signal_name, const ArgList &args, bool called_from_slot=false)
	Emits a signal and calls the slots it is connected to.

Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.

virtual	~Counted ()
	Destroys a reference counted object.

Detailed Description

Commands to create new plugins, Grob class names, Tool, Commands and Shader.

Definition at line 58 of file scene_graph_devel_commands.h.

Member Function Documentation

◆ create_class()

void OGF::SceneGraphDevelCommands::create_class	(	const DynamicModuleName &	plugin_name,
		const std::string &	subdirectory,
		const std::string &	class_name
	)

Creates a new class in a plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	subdirectory	relative path to the subdirectory where the class files should be created
[in]	class_name	the name of the class to be created \menu /Devel

◆ create_commands()

void OGF::SceneGraphDevelCommands::create_commands	(	const DynamicModuleName &	plugin_name,
		const GrobClassName &	type,
		const std::string &	name
	)

Creates a new Commands class in a plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	type	the Grob class the commands should be attached to
[in]	name	for instance "FooBar" for "OGF::MeshGrobFooBarCommands" \menu /Devel

◆ create_file()

void OGF::SceneGraphDevelCommands::create_file	(	const DynamicModuleName &	plugin_name,
		const std::string &	subdirectory,
		const std::string &	name
	)

Creates a new file in a plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	subdirectory	relative path to the subdirectory where the class files should be created
[in]	name	the name of the file to be created, without extension \menu /Devel

◆ create_grob()

void OGF::SceneGraphDevelCommands::create_grob	(	const DynamicModuleName &	plugin_name,
		const std::string &	grob_name,
		const std::string &	file_extension = `""`,
		const std::string &	base_class_name = `""`
	)

Creates a new Grob class in a plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	grob_name	the name of the Grob class
[in]	file_extension	optional extension of the files used to save/load objects with this Grob class, without the "."
[in]	base_class_name	optional base class (with the "OGF::" prefix) \menu /Devel

◆ create_plugin()

void OGF::SceneGraphDevelCommands::create_plugin	(	const std::string &	plugin_name,
		const std::string &	author = `"Nicolas Bourbaki"`,
		const std::string &	contact = `""`,
		bool	autoload = `true`
	)

Creates C++ skeleton sources for a new plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	author	your name
[in]	contact	your contact info (only used to be included in the generated headers, you can leave blank if you wish)
[in]	autoload	if true, the plugin will be loaded next time Graphite is started (once the plugin is compiled) \menu /Devel

◆ create_scene_graph_commands()

void OGF::SceneGraphDevelCommands::create_scene_graph_commands	(	const DynamicModuleName &	plugin_name,
		const std::string &	name
	)

Creates a new Commands class for the SceneGraph in a plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	name	for instance "FooBar" for "OGF::SceneGraphFooBarCommands" \menu /Devel

◆ create_shader()

void OGF::SceneGraphDevelCommands::create_shader	(	const DynamicModuleName &	plugin_name,
		const GrobClassName &	type,
		const std::string &	name,
		const std::string &	base_class_name = `""`
	)

Creates a new Shader class in a plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	type	the Grob class the shader should be attached to
[in]	name	for instance "FooBar" for "OGF::MeshGrobFooBarShader"
[in]	base_class_name	optional base class for the shader (with the "OGF::" prefix) \menu /Devel

◆ create_tool()

void OGF::SceneGraphDevelCommands::create_tool	(	const DynamicModuleName &	plugin_name,
		const GrobClassName &	type,
		const std::string &	name,
		const std::string &	base_class_name = `""`
	)

Creates a new tool in a plugin.

Parameters

[in]	plugin_name	the name of the plugin
[in]	type	the Grob class the shader should be attached to
[in]	name	for instance "FooBar" for "OGF::MeshGrobFooBarTool"
[in]	base_class_name	optional base class for the shader (with the "OGF::" prefix) \menu /Devel

Member Data Documentation

◆ pad0

OGF::SceneGraphDevelCommands::__pad0__

Definition at line 68 of file scene_graph_devel_commands.h.

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

OGF/devel/commands/scene_graph_devel_commands.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create_class()

◆ create_commands()

◆ create_file()

◆ create_grob()

◆ create_plugin()

◆ create_scene_graph_commands()

◆ create_shader()

◆ create_tool()

Member Data Documentation

◆ __pad0__

◆ pad0