Graphite Version 3
An experimental 3D geometry processing program
Loading...
Searching...
No Matches
OGF::SceneGraphSelectionInterface Class Reference

All SceneGraph modifications related with selection go through this Interface. More...

#include <OGF/scene_graph/interfaces/scene_graph_selection.h>

Inheritance diagram for OGF::SceneGraphSelectionInterface:
OGF::SceneGraphInterface OGF::Interface OGF::Object GEO::Counted

Public Member Functions

 SceneGraphSelectionInterface ()
 SceneGraphSelectionInterface constructor.
 
 ~SceneGraphSelectionInterface () override
 SceneGraphEditor destrutor.
 
SceneGraphscene_graph () const
 Gets the wrapped MeshGrob.
 
void unselect_object (const GrobName &grob)
 Removes an object from the selection.
 
void toggle_selection (const GrobName &grob)
 Toggles the selection flag for an object.
 
void select_all ()
 Adds all objects to selection.
 
void clear_selection ()
 Removes all objects from selection.
 
void extend_selection (const GrobName &grob)
 Extends selection.
 
index_t nb_selected () const
 Gets the number of selected objects.
 
- Public Member Functions inherited from OGF::SceneGraphInterface
 SceneGraphInterface ()
 SceneGraphInterface constructor.
 
 ~SceneGraphInterface () override
 SceneGraphInterface 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.
 
- Public Member Functions inherited from OGF::Interface
 Interface ()
 Interface constructor.
 
 ~Interface () override
 Interface destructor.
 
Grobgrob () const
 Gets the Grob.
 
SceneGraphscene_graph () const
 Gets the SceneGraph.
 
Grobget_grob () const
 Gets the current Grob.
 
- Public Member Functions inherited from OGF::Object
 Object (bool transient=false)
 Object constructor.
 
 ~Object () override
 Object destructor.
 
virtual MetaClassmeta_class () const
 Gets the meta class.
 
virtual void set_meta_class (MetaClass *mclass)
 Sets the meta class.
 
Numeric::uint32 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 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.
 
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.
 
MetaClassget_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 select_object(const GrobName& grob)
 
- 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::Object
static Objectid_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.
 
- Static Public Attributes inherited from OGF::Object
static constexpr Numeric::uint32 INVALID_ID = 0xbadbeef
 
- Protected Member Functions inherited from OGF::Object
virtual bool set_property_and_record_to_history (const std::string &name, const Any &value, Interpreter *interpreter)
 Sets an individual property and record modification to history.
 
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

All SceneGraph modifications related with selection go through this Interface.

Calls are logged to the history if called from user interaction.

Definition at line 53 of file scene_graph_selection.h.

Member Function Documentation

◆ extend_selection()

void OGF::SceneGraphSelectionInterface::extend_selection ( const GrobName grob)

Extends selection.

Selects all objects between current object and grob

◆ scene_graph()

SceneGraph * OGF::SceneGraphSelectionInterface::scene_graph ( ) const
inline

Gets the wrapped MeshGrob.

Returns
a pointer to the MeshGrob or nullptr.

Definition at line 71 of file scene_graph_selection.h.

◆ toggle_selection()

void OGF::SceneGraphSelectionInterface::toggle_selection ( const GrobName grob)

Toggles the selection flag for an object.

Parameters
[in]grobthe object or its name

◆ unselect_object()

void OGF::SceneGraphSelectionInterface::unselect_object ( const GrobName grob)

Removes an object from the selection.

Parameters
[in]grobthe object or its name

Member Data Documentation

◆ __pad0__

OGF::SceneGraphSelectionInterface::__pad0__

Definition at line 71 of file scene_graph_selection.h.


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