Tulip  6.0.0
Large graphs analysis and drawing
tlp::SelectedEntity Struct Reference

#include <GlScene.h>

Public Types

enum  SelectedEntityType { UNKNOW_SELECTED = 0 , NODE_SELECTED = 1 , EDGE_SELECTED = 2 , SIMPLE_ENTITY_SELECTED = 3 }
 

Public Member Functions

 SelectedEntity (GlSimpleEntity *entity)
 
 SelectedEntity (Graph *graph, unsigned int id, SelectedEntityType type)
 
GraphgetComplexEntityGraph () const
 
unsigned int getComplexEntityId () const
 
edge getEdge () const
 
SelectedEntityType getEntityType () const
 
node getNode () const
 
GlSimpleEntitygetSimpleEntity () const
 

Protected Attributes

union {
GraphcomplexEntityGraph
 
GlSimpleEntitysimpleEntity
 
}; 
 
unsigned int complexEntityId
 
SelectedEntityType entityType
 

Detailed Description

Structure to store selected entities.

After a selection, objects of SelectedEntity is returned To use this object the first thing to do is to call getEntity type to know the type of Entity After that you can :

  • Get the GlSimpleEntity pointer (getSimpleEntity())
  • Get the id of node/edge and the graph associated (getComplexEntityId() and getComplexEntityGraph())

Definition at line 50 of file GlScene.h.

Member Function Documentation

◆ getEdge()

edge tlp::SelectedEntity::getEdge ( ) const
inline
Returns
the selected edge if the entity type is correct or an invalid edge else.

Definition at line 97 of file GlScene.h.

◆ getNode()

node tlp::SelectedEntity::getNode ( ) const
inline
Returns
the selected node if the entity type is correct or an invalid node else.

Definition at line 89 of file GlScene.h.