tlp::SelectedEntity Struct Reference

#include <GlScene.h>

Collaboration diagram for tlp::SelectedEntity:

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)
Graph *	getComplexEntityGraph () const
unsigned int	getComplexEntityId () const
edge	getEdge () const
SelectedEntityType	getEntityType () const
node	getNode () const
GlSimpleEntity *	getSimpleEntity () const

Protected Attributes
Graph *	complexEntityGraph
unsigned int	complexEntityId
SelectedEntityType	entityType
GlSimpleEntity *	simpleEntity

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 GlSimpleEnity pointer (getSimpleEntity())
• Get the id of node/edge and the graph associated (getComplexEntityId() and getComplexEntityGraph())

Examples:

interactor_plugin/interactor_plugin.cpp.

Definition at line 48 of file GlScene.h.

Member Function Documentation

getEdge()

edge tlp::SelectedEntity::getEdge ( ) const

inline

getEdge is a convenience method to perform the check on the selected element type and return the corresponding edge object. It's equivalent to

if(getComplexEntityType()==EDGE_SELECTED){
   return edge(getComplexEntityId())
}

Returns

the selected edge if the entity type is correct or an invalid edge else.

Definition at line 112 of file GlScene.h.

getNode()

node tlp::SelectedEntity::getNode ( ) const

inline

getNode is a convenience method to perform the check on the selected element type and return the corresponding node object. It's equivalent to

if(getComplexEntityType()==NODE_SELECTED){
   return node(getComplexEntityId())
}

Returns

the selected node if the entity type is correct or an invalid node else.

Definition at line 94 of file GlScene.h.