tlp::GlGraphComposite Class Reference

#include <GlGraphComposite.h>

Inheritance diagram for tlp::GlGraphComposite:

Collaboration diagram for tlp::GlGraphComposite:

List of all members.

Public Member Functions
	GlGraphComposite (Graph *graph, GlGraphRenderer *graphRenderer=NULL)
	GlGraphComposite (Graph *graph, GlScene *scene)
	~GlGraphComposite ()
Graph *	getGraph ()
GlGraphInputData *	getInputData ()
const GlGraphRenderingParameters &	getRenderingParameters ()
GlGraphRenderingParameters *	getRenderingParametersPointer ()
virtual void	getXML (std::string &outString)
void	setRenderingParameters (const GlGraphRenderingParameters &parameter)
virtual void	setWithXML (const std::string &inString, unsigned int &currentPosition)
Protected Attributes
GlGraphRenderer *	graphRenderer
GlGraphInputData	inputData
std::set< node >	metaNodes
bool	nodesModified
GlGraphRenderingParameters	parameters
Graph *	rootGraph

---

Detailed Description

Class use to visualize graph in OpenGL Tulip engine.

GlSimpleEntity specialisation used to visualize graph in GlScene system

See also:

GlSimpleEntity

GlScene

To visualize graph you have to create a new GlGraphComposite and add it to a GlLayer of a GlScene After that you can change some visualize parameters throw GlGraphRenderingParameters class

See also:

GlGraphRenderingParameters

getRenderingParametersPointer()

To render the graph in OpenGL, GlGraphComposite use a GlGraphRenderer. So if you want to change the system to render the graph, you have to create a new GlGraphRender

See also:

GlGraphRenderer

Examples:

graph_display/graph_display.cpp.

Definition at line 50 of file GlGraphComposite.h.

---

Constructor & Destructor Documentation

tlp::GlGraphComposite::GlGraphComposite	(	Graph *	graph,
		GlGraphRenderer *	graphRenderer = NULL
	)

Build a GlGraphComposite with the graph data.

You can specify a GlGraphRenderer, if you don't do this a GlGraphHighDetailsRenderer will be used to display the graph

tlp::GlGraphComposite::GlGraphComposite	(	Graph *	graph,
		GlScene *	scene
	)

Build a GlGraphComposite with the graph data.

Is better to use the other one constructor

This graph composite is associated to the scene passed in parameter

tlp::GlGraphComposite::~GlGraphComposite

(

)

Destructor.

---

Member Function Documentation

Graph* tlp::GlGraphComposite::getGraph

(

)

[inline]

Return the graph used by this GlGraphComposite.

Definition at line 103 of file GlGraphComposite.h.

GlGraphInputData* tlp::GlGraphComposite::getInputData

(

)

Return the inputData use by the composite.

In GlGraphInputData you have properties used to render the graph

const GlGraphRenderingParameters& tlp::GlGraphComposite::getRenderingParameters

(

)

Return a copy of rendering parameters use for rendering.

So after you have to call setRenderingParameters

GlGraphRenderingParameters* tlp::GlGraphComposite::getRenderingParametersPointer

(

)

Return a pointer on rendering parameters used for rendering.

With this function you don't have to call setRenderingParameters() function

Examples:

graph_display/graph_display.cpp.

virtual void tlp::GlGraphComposite::getXML

(

std::string &

outString

)

[virtual]

Function to export data in outString (in XML format)

Reimplemented from tlp::GlComposite.

void tlp::GlGraphComposite::setRenderingParameters

(

const GlGraphRenderingParameters &

parameter

)

Set the rendering parameters use for rendering.

virtual void tlp::GlGraphComposite::setWithXML	(	const std::string &	inString,
		unsigned int &	currentPosition
	)		[virtual]

Function to set data with inString (in XML format)

Reimplemented from tlp::GlComposite.