Tulip_Widgets

Classes
class	tlp::GlMainWidget
	Widget of visualisation. More...
class	tlp::GWOverviewWidget
class	PropertyWidget
class	ChooseFileNameDialog
class	tlp::SGHierarchyWidget
class	tlp::TulipTableWidget

Enumerations
enum	tlp::GlMainWidget::RenderingOption { tlp::GlMainWidget::RenderGraph = 0x1, tlp::GlMainWidget::SwapBuffers = 0x2 }
	Configure the rendering process ( see render function) More...

Functions
	tlp::GlMainWidget::GlMainWidget (QWidget *parent, View *view=NULL)
	tlp::GlMainWidget::~GlMainWidget ()
QSize	tlp::GlMainWidget::sizeHint () const
void	tlp::GlMainWidget::setData (Graph *graph, DataSet dataSet)
DataSet	tlp::GlMainWidget::getData ()
void	tlp::GlMainWidget::setGraph (Graph *graph)
Graph *	tlp::GlMainWidget::getGraph ()
View *	tlp::GlMainWidget::getView ()
tlp::GlScene *	tlp::GlMainWidget::getScene ()
void	tlp::GlMainWidget::addForegroundEntity (ForegroundEntity *entity)
void	tlp::GlMainWidget::removeForegrounEntity (ForegroundEntity *entity)
	Remove the given ForegroundEntity. If the entity don't exisits do nothing.
void	tlp::GlMainWidget::doSelect (const int x, const int y, const int width, const int height, std::vector< tlp::node > &sNode, std::vector< tlp::edge > &sEdge, tlp::GlLayer *layer=NULL)
	select nodes and edges in a region of the screen
bool	tlp::GlMainWidget::doSelect (const int x, const int y, tlp::ElementType &type, tlp::node &, tlp::edge &, tlp::GlLayer *layer=NULL)
	select a node or edge at a point select either a node or edge at point (x,y)
unsigned char *	tlp::GlMainWidget::getImage ()
bool	tlp::GlMainWidget::outputEPS (int size, int doSort, const char *filename)
bool	tlp::GlMainWidget::outputSVG (int size, const char *filename)
static void	tlp::GlMainWidget::getTextureRealSize (int width, int height, int &textureRealWidth, int &textureRealHeight)
void	tlp::GlMainWidget::getTextureShift (int width, int height, float &xTextureShift, float &yTextureShift)
QGLFramebufferObject *	tlp::GlMainWidget::createTexture (const std::string &textureName, int width, int height)
void	tlp::GlMainWidget::createPicture (const std::string &pictureName, int width, int height, bool center=true, int zoom=1, int xDec=0, int yDec=0)
QImage	tlp::GlMainWidget::createPicture (int width, int height, bool center=true, int zoom=1, int xDec=0, int yDec=0)
bool	tlp::GlMainWidget::selectGlEntities (const int x, const int y, const int width, const int height, std::vector< tlp::GlSimpleEntity * > &pickedEntities, tlp::GlLayer *layer=NULL)
bool	tlp::GlMainWidget::selectGlEntities (const int x, const int y, std::vector< tlp::GlSimpleEntity * > &pickedEntities, tlp::GlLayer *layer=NULL)
_DEPRECATED bool	tlp::GlMainWidget::selectGlEntities (const int x, const int y, const int width, const int height, std::vector< tlp::GlEntity * > &pickedEntities, tlp::GlLayer *layer=NULL)
_DEPRECATED bool	tlp::GlMainWidget::selectGlEntities (const int x, const int y, std::vector< tlp::GlEntity * > &pickedEntities, tlp::GlLayer *layer=NULL)
virtual QImage	tlp::GlMainWidget::grabFrameBuffer (bool withAlpha=false)
void	tlp::GlMainWidget::setViewLabel (bool viewLabel)
virtual void	tlp::GlMainWidget::makeCurrent ()
void	tlp::GlMainWidget::resizeGL (int w, int h)
void	tlp::GlMainWidget::computeInteractors ()
void	tlp::GlMainWidget::drawInteractors ()
void	tlp::GlMainWidget::drawForegroundEntities ()
void	tlp::GlMainWidget::useHulls (bool hasHulls)
bool	tlp::GlMainWidget::hasHulls () const
void	tlp::GlMainWidget::render (RenderingOptions options=RenderingOptions(RenderGraph|SwapBuffers))
	This function performs all the rendering process of the graph. Use this function only for advanced purpose, if you want to perform simple rendering use the draw or redraw functions instead.
static QGLWidget *	tlp::GlMainWidget::getFirstQGLWidget ()
	tlp::GWOverviewWidget::GWOverviewWidget (QWidget *parent=0, bool drawIfNotVisible=false)
	tlp::GWOverviewWidget::~GWOverviewWidget ()
bool	tlp::GWOverviewWidget::eventFilter (QObject *, QEvent *)
GlMainWidget *	tlp::GWOverviewWidget::getObservedView ()
GlMainWidget *	tlp::GWOverviewWidget::getView ()
void	tlp::GWOverviewWidget::setDrawIfNotVisible (bool drawIfNotVisible)
	tlp::TulipTableWidget::TulipTableWidget (QWidget *, const char *)
	tlp::TulipTableWidget::~TulipTableWidget ()
void	tlp::TulipTableWidget::setTulipNodeItem (const PropertyInterface *, const std::string propertyName, const node &, const int row, const int col)
QString	tlp::TulipTableWidget::getTulipNodeValue (const int row, const int col) const
void	tlp::TulipTableWidget::setTulipEdgeItem (const PropertyInterface *, const std::string propertyName, const edge &, const int row, const int col)
QString	tlp::TulipTableWidget::getTulipEdgeValue (const int row, const int col) const
QColor	tlp::TulipTableWidget::getBackColor1 () const
QColor	tlp::TulipTableWidget::getBackColor2 () const
bool	tlp::TulipTableWidget::getUpdateColumnTitle () const
QColor	tlp::TulipTableWidget::backgroundColor (const int row) const

Signals
void	tlp::GlMainWidget::closing (GlMainWidget *, QCloseEvent *)
void	tlp::GlMainWidget::graphRedrawn (GlMainWidget *glWidget, bool graphChanged)
void	tlp::GlMainWidget::viewRedrawn (GlMainWidget *glWidget)
void	tlp::GlMainWidget::viewDrawn (GlMainWidget *glWidget, bool graphChanged)
void	tlp::GWOverviewWidget::hideOverview (bool)

Public Slots
void	tlp::GlMainWidget::draw (bool graphChanged=true)
void	tlp::GlMainWidget::redraw ()
void	tlp::GlMainWidget::closeEvent (QCloseEvent *e)
void	tlp::GlMainWidget::centerScene ()
	Convinience function that call center function on the current scene and draw the view. Same thing than.
void	tlp::GWOverviewWidget::setObservedView (GlMainWidget *, GlSimpleEntity *entity)
void	tlp::GWOverviewWidget::updateView ()
void	tlp::GWOverviewWidget::show ()
void	tlp::TulipTableWidget::setBackColor1 (const QColor &)
void	tlp::TulipTableWidget::resetBackColor1 ()
void	tlp::TulipTableWidget::setBackColor2 (const QColor &)
void	tlp::TulipTableWidget::resetBackColor2 ()
void	tlp::TulipTableWidget::setUpdateColumnTitle (const bool)

Protected Slots
void	tlp::GlMainWidget::paintEvent (QPaintEvent *)
void	tlp::GlMainWidget::viewDrawnSlot (GlMainWidget *glWidget, bool graphChanged)

Properties
QColor	tlp::TulipTableWidget::backColor1
QColor	tlp::TulipTableWidget::backColor2
bool	tlp::TulipTableWidget::updateColumnTitle

Detailed Description

Enumeration Type Documentation

enum tlp::GlMainWidget::RenderingOption

Configure the rendering process ( see render function)

See Also

render

Enumerator:

RenderGraph
SwapBuffers	Force to render the graph even if there is a previous buffered render. You need to call this option if the graph is updated to regenerate the buffer. If not set try to use the last buffered graph render, if there is no valid buffer this flag is forced.

Function Documentation

void tlp::GlMainWidget::addForegroundEntity ( ForegroundEntity *  entity )

inline

add a foregroundEntity to this GlMainWidget

QColor tlp::TulipTableWidget::backgroundColor

(

const int

row

)

const

void tlp::GlMainWidget::computeInteractors

(

)

Compute interactors before drawing

void tlp::GlMainWidget::createPicture	(	const std::string &	pictureName,
		int	width,
		int	height,
		bool	center = true,
		int	zoom = 1,
		int	xDec = 0,
		int	yDec = 0
	)

Take a snapshot of the Widget and put it in a picture

QImage tlp::GlMainWidget::createPicture	(	int	width,
		int	height,
		bool	center = true,
		int	zoom = 1,
		int	xDec = 0,
		int	yDec = 0
	)

Take a snapshot of the Widget and return it

QGLFramebufferObject* tlp::GlMainWidget::createTexture	(	const std::string &	textureName,
		int	width,
		int	height
	)

Take a snapshot of the Widget and put it in an OpenGl texture

void tlp::GlMainWidget::doSelect	(	const int	x,
		const int	y,
		const int	width,
		const int	height,
		std::vector< tlp::node > &	sNode,
		std::vector< tlp::edge > &	sEdge,
		tlp::GlLayer *	layer = NULL
	)

select nodes and edges in a region of the screen

select all nodes and edges lying in the area of the screen of given width and height, and with its upper-left corner at (x,y)

Parameters

sNode	filled by the method with the nodes found in the region
sEdge	filled by the method with the edges found in the region

bool tlp::GlMainWidget::doSelect	(	const int	x,
		const int	y,
		tlp::ElementType &	type,
		tlp::node &	,
		tlp::edge &	,
		tlp::GlLayer *	layer = NULL
	)

select a node or edge at a point select either a node or edge at point (x,y)

Parameters

type	tells what has been found: NODE, EDGE

Returns

true if something has been found, false otherwise

void tlp::GlMainWidget::drawForegroundEntities

(

)

Draw foreground entities

void tlp::GlMainWidget::drawInteractors

(

)

Draw interactors

bool tlp::GWOverviewWidget::eventFilter	(	QObject *	,
		QEvent *
	)

QColor tlp::TulipTableWidget::getBackColor1

(

)

const

QColor tlp::TulipTableWidget::getBackColor2

(

)

const

DataSet tlp::GlMainWidget::getData

(

)

Get data of GlMainWidget

static QGLWidget* tlp::GlMainWidget::getFirstQGLWidget ( )

static

This function return the first QGLWidget created This function is use to share OpenGL context

Graph* tlp::GlMainWidget::getGraph

(

)

GetGraph of GlMainWidget

unsigned char* tlp::GlMainWidget::getImage

(

)

Take a snapshot of the Widget

Returns

an array of dimension width*height*3 char (8bits per color RGB). The pointer has to be freed after (with free, not delete)

GlMainWidget* tlp::GWOverviewWidget::getObservedView

(

)

tlp::GlScene* tlp::GlMainWidget::getScene ( )

inline

Get the scene of this glMainWidget

static void tlp::GlMainWidget::getTextureRealSize ( int  width, int  height, int &  textureRealWidth, int &  textureRealHeight  )

static

Compute real texture size with given height and width

void tlp::GlMainWidget::getTextureShift	(	int	width,
		int	height,
		float &	xTextureShift,
		float &	yTextureShift
	)

QString tlp::TulipTableWidget::getTulipEdgeValue	(	const int	row,
		const int	col
	)		const

QString tlp::TulipTableWidget::getTulipNodeValue	(	const int	row,
		const int	col
	)		const

bool tlp::TulipTableWidget::getUpdateColumnTitle

(

)

const

GlMainWidget* tlp::GWOverviewWidget::getView

(

)

View* tlp::GlMainWidget::getView ( )

inline

Get the view who use this GlMainWidget

tlp::GlMainWidget::GlMainWidget	(	QWidget *	parent,
		View *	view = NULL
	)

Construct the GlMainWidget

virtual QImage tlp::GlMainWidget::grabFrameBuffer ( bool  withAlpha = false )

virtual

Grab the image of this widget

tlp::GWOverviewWidget::GWOverviewWidget	(	QWidget *	parent = 0,
		bool	drawIfNotVisible = false
	)

bool tlp::GlMainWidget::hasHulls

(

)

const

virtual void tlp::GlMainWidget::makeCurrent ( )

virtual

Extend makeCurrent function of QGLWidget to inform TextureManager and DisplayListManager of context changement

bool tlp::GlMainWidget::outputEPS	(	int	size,
		int	doSort,
		const char *	filename
	)

bool tlp::GlMainWidget::outputSVG	(	int	size,
		const char *	filename
	)

void tlp::GlMainWidget::removeForegrounEntity

(

ForegroundEntity *

entity

)

Remove the given ForegroundEntity. If the entity don't exisits do nothing.

void tlp::GlMainWidget::render

(

RenderingOptions

options = RenderingOptions(RenderGraph|SwapBuffers)

)

This function performs all the rendering process of the graph. Use this function only for advanced purpose, if you want to perform simple rendering use the draw or redraw functions instead.

Parameters

options

Configure the rendering process, see the RenderingOption documentation for more informations on each rendering option effect.

See Also

RenderingOption

void tlp::GlMainWidget::resizeGL	(	int	w,
		int	h
	)

Resize openGL view

bool tlp::GlMainWidget::selectGlEntities	(	const int	x,
		const int	y,
		const int	width,
		const int	height,
		std::vector< tlp::GlSimpleEntity * > &	pickedEntities,
		tlp::GlLayer *	layer = NULL
	)

Function to do picking on entities. It just calls selectEntities on the GlScene instance.

bool tlp::GlMainWidget::selectGlEntities	(	const int	x,
		const int	y,
		std::vector< tlp::GlSimpleEntity * > &	pickedEntities,
		tlp::GlLayer *	layer = NULL
	)

Function to do picking on entities. It just calls selectEntities on the GlScene instance with a small window of twelve pixels.

_DEPRECATED bool tlp::GlMainWidget::selectGlEntities	(	const int	x,
		const int	y,
		const int	width,
		const int	height,
		std::vector< tlp::GlEntity * > &	pickedEntities,
		tlp::GlLayer *	layer = NULL
	)

Deprecated, see others selectGlEntities functions.

_DEPRECATED bool tlp::GlMainWidget::selectGlEntities	(	const int	x,
		const int	y,
		std::vector< tlp::GlEntity * > &	pickedEntities,
		tlp::GlLayer *	layer = NULL
	)

Deprecated, see others selectGlEntities functions.

void tlp::GlMainWidget::setData	(	Graph *	graph,
		DataSet	dataSet
	)

Set graph and data of GlMainWidget

void tlp::GWOverviewWidget::setDrawIfNotVisible ( bool  drawIfNotVisible )

inline

void tlp::GlMainWidget::setGraph

(

Graph *

graph

)

Set the graph

void tlp::TulipTableWidget::setTulipEdgeItem	(	const PropertyInterface *	,
		const std::string	propertyName,
		const edge &	,
		const int	row,
		const int	col
	)

void tlp::TulipTableWidget::setTulipNodeItem	(	const PropertyInterface *	,
		const std::string	propertyName,
		const node &	,
		const int	row,
		const int	col
	)

void tlp::GlMainWidget::setViewLabel ( bool  viewLabel )

inline

set if the label is rendered in this widget

QSize tlp::GlMainWidget::sizeHint

(

)

const

tlp::TulipTableWidget::TulipTableWidget	(	QWidget *	,
		const char *
	)

void tlp::GlMainWidget::useHulls

(

bool

hasHulls

)

tlp::GlMainWidget::~GlMainWidget

(

)

tlp::GWOverviewWidget::~GWOverviewWidget

(

)

tlp::TulipTableWidget::~TulipTableWidget

(

)

Signals

void tlp::GlMainWidget::closing ( GlMainWidget *  , QCloseEvent *    )

signal

This signal is emit when the GlMainWidget will be deleted

void tlp::GlMainWidget::graphRedrawn ( GlMainWidget *  glWidget, bool  graphChanged  )

signal

This signal is here for compatibility with old code This signal is emit when viewDrawn is emit

void tlp::GWOverviewWidget::hideOverview ( bool  )

signal

void tlp::GlMainWidget::viewDrawn ( GlMainWidget *  glWidget, bool  graphChanged  )

signal

This signal is emit when GlMainWidget::draw() is call

void tlp::GlMainWidget::viewRedrawn ( GlMainWidget *  glWidget )

signal

This signal is emit when GlMainWidget::redraw() is call

Public Slots

void tlp::GlMainWidget::centerScene ( )

slot

Convinience function that call center function on the current scene and draw the view. Same thing than.

getScene()->centerScene();
draw();

void tlp::GlMainWidget::closeEvent ( QCloseEvent *  e )

slot

void tlp::GlMainWidget::draw ( bool  graphChanged = true )

slot

Draw the graph, the augmented dispaly and the interactors

void tlp::GlMainWidget::redraw ( )

slot

That function is given for optimisation purpose. If the hardware enable it, it enables to redraw only the Augmented display and the interactors and not the graph it is really usefull for interactors such as zoom box etc.. Warning, if you change the graph or the porperties of element (Colors, size, etc...) applying that fonction will not display the change, in that case, use the draw function.

void tlp::TulipTableWidget::resetBackColor1 ( )

slot

void tlp::TulipTableWidget::resetBackColor2 ( )

slot

void tlp::TulipTableWidget::setBackColor1 ( const QColor &  )

slot

void tlp::TulipTableWidget::setBackColor2 ( const QColor &  )

slot

void tlp::GWOverviewWidget::setObservedView ( GlMainWidget *  , GlSimpleEntity *  entity  )

slot

void tlp::TulipTableWidget::setUpdateColumnTitle ( const bool  )

slot

void tlp::GWOverviewWidget::show ( )

slot

void tlp::GWOverviewWidget::updateView ( )

slot

Protected Slots

void tlp::GlMainWidget::paintEvent ( QPaintEvent *  )

protectedslot

void tlp::GlMainWidget::viewDrawnSlot ( GlMainWidget *  glWidget, bool  graphChanged  )

inlineprotectedslot

Properties

QColor tlp::TulipTableWidget::backColor1

readwrite

QColor tlp::TulipTableWidget::backColor2

readwrite

bool tlp::TulipTableWidget::updateColumnTitle

readwrite