Represents a set of commands. More...

#include <OGF/scene_graph/commands/commands.h>

Inheritance diagram for OGF::Commands:

Public Member Functions
	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. More...

Interpreter *	interpreter ()
	Gets the main Interpreter. More...

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

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

	~Interface () override
	Interface destructor.

Grob *	grob () const
	Gets the Grob. More...

SceneGraph *	scene_graph () const
	Gets the SceneGraph. More...

Grob *	get_grob () const
	Gets the current Grob. More...

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

virtual	~Object ()
	Object destructor.

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

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

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

bool	get_signals_enabled () const
	Tests wheter signals are enabled. More...

void	set_signals_enabled (bool value)
	Enables or disables signals. More...

bool	get_slots_enabled () const
	Tests wheter slots are enabled. More...

void	set_slots_enabled (bool value)
	Enables or disables slots. More...

MetaClass *	get_meta_class () const
	Gets the meta class. More...

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

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

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

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

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

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. More...

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

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

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

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

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

void	unref () const
	Decrements the reference count. More...

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

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

Static Public Member Functions
static bool	command_is_running ()
	Tests whether a command is currently running. More...

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

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

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

Public Attributes
	__pad0__: bool get_chrono() const { return chrono_

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

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

	__pad1__: bool equals(const Object* other) const

Additional Inherited Members
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. More...

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

virtual	~Counted ()
	Destroys a reference counted object. More...

Detailed Description

Represents a set of commands.

Each member function declared as gom_slot will have a menun entry and a dialog, generated by AutoGUI. The Doxygen comments associated with each member function are interpreted by AutoGUI, the "brief" tag and the "param" tag are interpreted to generate tooltips. In addition, the following tags can be used:

"menu": indicate a menu relative to current menu, or an absolute menu (starting with a '/') to insert the command in existing menus (for instance /Surface/Remesh)
"advanced" all subsequent parameters are in the advanced section of the command (displayed when clicking on it)
Note
To be taken into account by the system, a Commands object has to satisfy the following requirements:
it is a gom_class derived from the Commands class
its functions are declared as gom_slot
it is declared in the initializer of the package using ogf_register_grob_commands. See OGF/mesh/common/mesh_common.cpp for an example. When using the "devel" plugin, a skeleton that satisfies these requirements is automatically created.

Definition at line 155 of file commands.h.

Member Function Documentation

◆ command_is_running()

static bool OGF::Commands::command_is_running ( )

inlinestatic

Tests whether a command is currently running.

Return values

true	if a command is currently running.
false	otherwise.

Definition at line 211 of file commands.h.

◆ interpreter()

Interpreter* OGF::Commands::interpreter ( )

Gets the main Interpreter.

Returns: a pointer to the main Interpreter.

◆ invoke_method()

bool OGF::Commands::invoke_method	(	const std::string &	method_name,
		const ArgList &	args,
		Any &	ret_val
	)

overridevirtual

Invokes a method by method name and argument list, and gets the return value.

Parameters

[in]	method_name	name of the method
[in]	args	a const reference to the ArgList
[out]	ret_val	the return value as an Any

Return values

true	if the method could be sucessfully invoked
false	otherwise

Overload of the invokation mechanism, that adds timings and history recording.

Reimplemented from OGF::Object.

◆ set_chrono()

void OGF::Commands::set_chrono ( bool value )

inline

Sets whether timings are reported.

Parameters

[in] value true if timings should be reported, false otherwise.

Definition at line 200 of file commands.h.

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

OGF/scene_graph/commands/commands.h

Public Member Functions

Static Public Member Functions