Graphite  Version 3
An experimental 3D geometry processing program
OGF::SceneGraphSceneCommands Class Reference

Some commands that act on the whole SceneGraph. More...

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

Inheritance diagram for OGF::SceneGraphSceneCommands:
OGF::SceneGraphCommands OGF::Commands OGF::Interface OGF::Object GEO::Counted

Public Member Functions

 SceneGraphSceneCommands ()
 SceneGraphSceneCommands constructor.
 
 ~SceneGraphSceneCommands ()
 SceneGraphSceneCommands destructor.
 
void rename_current (const std::string &new_name)
 Remanes the current object. More...
 
void duplicate_current ()
 Duplicates the current object.
 
void delete_current ()
 Deletes the current object.
 
void delete_all ()
 Deletes all the objects of the scene graph.
 
void display_current_dimensions ()
 Displays the bounding box and dimensions of the current object. More...
 
void display_current_attributes ()
 Displays the attributes of the current object. More...
 
void set_parameter (const std::string &name, const std::string &value)
 Sets a global parameter. More...
 
void list_parameters ()
 Lists all the parameters and their values. More...
 
void enable_verbose ()
 Enables logger messages. More...
 
void disable_verbose ()
 Disables logger messages. More...
 
- Public Member Functions inherited from OGF::SceneGraphCommands
 SceneGraphCommands ()
 SceneGraphCommands constructor.
 
 ~SceneGraphCommands () override
 SceneGraphCommands destructor.
 
SceneGraphscene_graph () const
 Gets the SceneGraph. More...
 
- 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. More...
 
Interpreterinterpreter ()
 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.
 
Grobgrob () const
 Gets the Grob. More...
 
SceneGraphscene_graph () const
 Gets the SceneGraph. More...
 
Grobget_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 MetaClassmeta_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 Connectionconnect_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...
 
MetaClassget_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...
 

Public Attributes

 __pad0__: void create_object( const GrobClassName& type = "OGF::MeshGrob"
 
const std::string & name
 
- Public Attributes inherited from OGF::Commands
 __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

- Static Public Member Functions inherited from OGF::Commands
static bool command_is_running ()
 Tests whether a command is currently running. More...
 
- Static Public Member Functions inherited from OGF::Object
static Objectid_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...
 
- 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

Some commands that act on the whole SceneGraph.

Definition at line 82 of file scene_graph_commands.h.

Member Function Documentation

◆ disable_verbose()

void OGF::SceneGraphSceneCommands::disable_verbose ( )

Disables logger messages.

\menu System/Logger

◆ display_current_attributes()

void OGF::SceneGraphSceneCommands::display_current_attributes ( )

Displays the attributes of the current object.

\menu Current

◆ display_current_dimensions()

void OGF::SceneGraphSceneCommands::display_current_dimensions ( )

Displays the bounding box and dimensions of the current object.

\menu Current

◆ enable_verbose()

void OGF::SceneGraphSceneCommands::enable_verbose ( )

Enables logger messages.

\menu System/Logger

◆ list_parameters()

void OGF::SceneGraphSceneCommands::list_parameters ( )

Lists all the parameters and their values.

\menu System/Parameters

◆ rename_current()

void OGF::SceneGraphSceneCommands::rename_current ( const std::string &  new_name)

Remanes the current object.

Parameters
[in]new_namethe new name.

◆ set_parameter()

void OGF::SceneGraphSceneCommands::set_parameter ( const std::string &  name,
const std::string &  value 
)

Sets a global parameter.

\menu System/Parameters

Parameters
[in]namename of the parameter.
[in]valuenew value for the parameter.

Member Data Documentation

◆ name

const std::string& OGF::SceneGraphSceneCommands::name
Initial value:
="new_object"
)

Definition at line 103 of file scene_graph_commands.h.


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