tlp::GlGraphRenderingParameters Class Reference

#include <GlGraphRenderingParameters.h>

Public Member Functions
	GlGraphRenderingParameters ()
BooleanProperty *	getDisplayFilteringProperty () const
int	getEdgesLabelStencil () const
bool	getEdgesMaxSizeToNodesSize () const
int	getEdgesStencil () const
tlp::NumericProperty *	getElementOrderingProperty () const
bool	getFeedbackRender () const
std::string	getFontsPath () const
unsigned int	getFontsType () const
bool	getLabelsAreBillboarded () const
unsigned int	getLabelsBorder () const
int	getLabelsDensity () const
int	getMaxSizeOfLabel () const
int	getMetaNodesLabelStencil () const
int	getMetaNodesStencil () const
int	getMinSizeOfLabel () const
int	getNodesLabelStencil () const
int	getNodesStencil () const
DataSet	getParameters () const
int	getSelectedEdgesStencil () const
int	getSelectedMetaNodesStencil () const
int	getSelectedNodesStencil () const
Color	getSelectionColor () const
std::string	getTexturePath () const
bool	isAntialiased () const
bool	isDisplayEdges () const
bool	isDisplayMetaNodes () const
bool	isDisplayNodes () const
bool	isEdge3D () const
bool	isEdgeColorInterpolate () const
bool	isEdgeFrontDisplay () const
bool	isEdgeSizeInterpolate () const
bool	isElementOrdered () const
bool	isElementOrderedDescending () const
bool	isElementZOrdered () const
bool	isLabelFixedFontSize () const
bool	isLabelScaled () const
bool	isViewArrow () const
bool	isViewEdgeLabel () const
bool	isViewMetaLabel () const
bool	isViewNodeLabel () const
bool	isViewOutScreenLabel () const
void	setAntialiasing (const bool state)
void	setDisplayEdges (const bool state)
void	setDisplayFilteringProperty (BooleanProperty *filteringProperty)
void	setDisplayMetaNodes (const bool state)
void	setDisplayNodes (const bool state)
void	setEdge3D (const bool state)
void	setEdgeColorInterpolate (const bool state)
void	setEdgeFrontDisplay (const bool state)
void	setEdgeSizeInterpolate (const bool state)
void	setEdgesLabelStencil (const int stencil)
void	setEdgesMaxSizeToNodesSize (const bool b)
void	setEdgesStencil (const int stencil)
void	setElementOrdered (const bool state)
void	setElementOrderedDescending (const bool state)
void	setElementOrderingProperty (tlp::NumericProperty *property)
void	setElementZOrdered (const bool state)
void	setFeedbackRender (bool feedback)
void	setFontsPath (const std::string &path)
void	setFontsType (unsigned int type)
void	setLabelFixedFontSize (bool state)
void	setLabelsAreBillboarded (bool billboarded)
void	setLabelsBorder (const unsigned int)
void	setLabelScaled (bool state)
void	setLabelsDensity (int density)
void	setMaxSizeOfLabel (int size)
void	setMetaNodesLabelStencil (const int stencil)
void	setMetaNodesStencil (const int stencil)
void	setMinSizeOfLabel (int size)
void	setNodesLabelStencil (const int stencil)
void	setNodesStencil (const int stencil)
void	setParameters (const DataSet &)
void	setSelectedEdgesStencil (const int stencil)
void	setSelectedMetaNodesStencil (const int stencil)
void	setSelectedNodesStencil (const int stencil)
void	setSelectionColor (const Color &color)
void	setTexturePath (const std::string &path)
void	setViewArrow (const bool state)
void	setViewEdgeLabel (const bool state)
void	setViewMetaLabel (const bool state)
void	setViewNodeLabel (const bool state)
void	setViewOutScreenLabel (const bool state)

Detailed Description

That class defines all the parameters used by GlGraphComposite to render a graph.

See also

GlGraphComposite

Examples:

graph_display/graph_display.cpp.

Definition at line 38 of file GlGraphRenderingParameters.h.

Constructor & Destructor Documentation

GlGraphRenderingParameters()

tlp::GlGraphRenderingParameters::GlGraphRenderingParameters

(

)

Constructor.

Member Function Documentation

getDisplayFilteringProperty()

BooleanProperty* tlp::GlGraphRenderingParameters::getDisplayFilteringProperty ( ) const

inline

Get the boolean property use to filtering displaying of nodes/edges.

Definition at line 520 of file GlGraphRenderingParameters.h.

getEdgesLabelStencil()

int tlp::GlGraphRenderingParameters::getEdgesLabelStencil

(

)

const

get stencil number for edges label

getEdgesMaxSizeToNodesSize()

bool tlp::GlGraphRenderingParameters::getEdgesMaxSizeToNodesSize

(

)

const

return if Edge max size is block to node size

getEdgesStencil()

int tlp::GlGraphRenderingParameters::getEdgesStencil

(

)

const

get stencil number for edges

getElementOrderingProperty()

tlp::NumericProperty* tlp::GlGraphRenderingParameters::getElementOrderingProperty

(

)

const

Gets the property used for element ordering. Setting it to nullptr will use viewMetric if the ordering is enabled.

Returns

:NumericProperty* The Property currently used.

getFeedbackRender()

bool tlp::GlGraphRenderingParameters::getFeedbackRender

(

)

const

return true if the graph is draw with feedback information

getFontsPath()

std::string tlp::GlGraphRenderingParameters::getFontsPath

(

)

const

Return the absolute path used for the fonts loading.

getFontsType()

unsigned int tlp::GlGraphRenderingParameters::getFontsType

(

)

const

Return the type of fonts used in the renderer(0=3D,1=bitmap,2=texture)

getLabelsAreBillboarded()

bool tlp::GlGraphRenderingParameters::getLabelsAreBillboarded ( ) const

inline

return if labels are billboarded

Definition at line 496 of file GlGraphRenderingParameters.h.

getLabelsBorder()

unsigned int tlp::GlGraphRenderingParameters::getLabelsBorder

(

)

const

Get the size of the border that is added to any label when using bitmap fonts.

Deprecated:

Use getLabelsDensity instead

getLabelsDensity()

int tlp::GlGraphRenderingParameters::getLabelsDensity

(

)

const

Return labels -density.

This density must be in interval -100 100 -100 : No labels 0 : No overlap 100 : All labels

getMaxSizeOfLabel()

int tlp::GlGraphRenderingParameters::getMaxSizeOfLabel

(

)

const

return max size of label : this max size is only used if labels are not scaled and are not rendered with a fixed font size

getMetaNodesLabelStencil()

int tlp::GlGraphRenderingParameters::getMetaNodesLabelStencil

(

)

const

get stencil number for meta-nodes label

getMetaNodesStencil()

int tlp::GlGraphRenderingParameters::getMetaNodesStencil

(

)

const

get stencil number for meta-nodes

getMinSizeOfLabel()

int tlp::GlGraphRenderingParameters::getMinSizeOfLabel

(

)

const

return min size of label : this min size is only used if labels are not scaled and are not rendered with a fixed font size

getNodesLabelStencil()

int tlp::GlGraphRenderingParameters::getNodesLabelStencil

(

)

const

get stencil number for nodes label

getNodesStencil()

int tlp::GlGraphRenderingParameters::getNodesStencil

(

)

const

get stencil number for nodes

getParameters()

DataSet tlp::GlGraphRenderingParameters::getParameters

(

)

const

Get parameters into a DataSet structure.

getSelectedEdgesStencil()

int tlp::GlGraphRenderingParameters::getSelectedEdgesStencil

(

)

const

get stencil number for selected edges

getSelectedMetaNodesStencil()

int tlp::GlGraphRenderingParameters::getSelectedMetaNodesStencil

(

)

const

get stencil number for selected meta-nodes

getSelectedNodesStencil()

int tlp::GlGraphRenderingParameters::getSelectedNodesStencil

(

)

const

get stencil number for selected nodes

getSelectionColor()

Color tlp::GlGraphRenderingParameters::getSelectionColor

(

)

const

return the selection color

getTexturePath()

std::string tlp::GlGraphRenderingParameters::getTexturePath

(

)

const

Return the absolute path used for texture loading.

isAntialiased()

bool tlp::GlGraphRenderingParameters::isAntialiased

(

)

const

Return true if antialiasing is activated else false.

isDisplayEdges()

bool tlp::GlGraphRenderingParameters::isDisplayEdges

(

)

const

Return true if edges are displayed.

isDisplayMetaNodes()

bool tlp::GlGraphRenderingParameters::isDisplayMetaNodes

(

)

const

Return true if meta-nodes are displayed.

isDisplayNodes()

bool tlp::GlGraphRenderingParameters::isDisplayNodes

(

)

const

Return true if nodes are displayed.

isEdge3D()

bool tlp::GlGraphRenderingParameters::isEdge3D

(

)

const

return true if 3D drawing of edges is activated

isEdgeColorInterpolate()

bool tlp::GlGraphRenderingParameters::isEdgeColorInterpolate

(

)

const

Return true if color interpolation is activated.

isEdgeFrontDisplay()

bool tlp::GlGraphRenderingParameters::isEdgeFrontDisplay

(

)

const

Return true if edge display in front of the scene is activated.

isEdgeSizeInterpolate()

bool tlp::GlGraphRenderingParameters::isEdgeSizeInterpolate

(

)

const

Return true if color interpolation is activated.

isElementOrdered()

bool tlp::GlGraphRenderingParameters::isElementOrdered

(

)

const

Returns true if element ordering is activated.

isElementOrderedDescending()

bool tlp::GlGraphRenderingParameters::isElementOrderedDescending

(

)

const

Returns true if the nodes and edges are sorted in descending order when the element ordering is activated.

Since

Tulip 4.8

isElementZOrdered()

bool tlp::GlGraphRenderingParameters::isElementZOrdered

(

)

const

return true if element Z ordering is activated

isLabelFixedFontSize()

bool tlp::GlGraphRenderingParameters::isLabelFixedFontSize

(

)

const

return if labels are rendered with a fixed font size (dynamic size otherwise)

isLabelScaled()

bool tlp::GlGraphRenderingParameters::isLabelScaled

(

)

const

return if labels are scaled to node size

isViewArrow()

bool tlp::GlGraphRenderingParameters::isViewArrow

(

)

const

Return true if arrows drawing is activated else false.

isViewEdgeLabel()

bool tlp::GlGraphRenderingParameters::isViewEdgeLabel

(

)

const

Return true if drawing of nodes' labels is activated.

isViewMetaLabel()

bool tlp::GlGraphRenderingParameters::isViewMetaLabel

(

)

const

Return the true if viewMetaLabels is enable else false.

isViewNodeLabel()

bool tlp::GlGraphRenderingParameters::isViewNodeLabel

(

)

const

Return true if drawing of nodes' labels is activated.

isViewOutScreenLabel()

bool tlp::GlGraphRenderingParameters::isViewOutScreenLabel

(

)

const

Return true if drawing of outscreen labels is activated.

setAntialiasing()

void tlp::GlGraphRenderingParameters::setAntialiasing

(

const bool

state

)

activate or deactivate anlialiasing

setDisplayEdges()

void tlp::GlGraphRenderingParameters::setDisplayEdges

(

const bool

state

)

If true edges are displayed.

setDisplayFilteringProperty()

void tlp::GlGraphRenderingParameters::setDisplayFilteringProperty ( BooleanProperty *  filteringProperty )

inline

This property is use to filter nodes/edges display, for a node/edge if this property is false : the node/edge will not be diplayed.

: this property will not be saved in DataSet

Definition at line 513 of file GlGraphRenderingParameters.h.

setDisplayMetaNodes()

void tlp::GlGraphRenderingParameters::setDisplayMetaNodes

(

const bool

state

)

If true meta-nodes are displayed.

setDisplayNodes()

void tlp::GlGraphRenderingParameters::setDisplayNodes

(

const bool

state

)

If true nodes are displayed.

setEdge3D()

void tlp::GlGraphRenderingParameters::setEdge3D

(

const bool

state

)

if true use 3D displaying of edges instead of 2D lines on ALL edges

setEdgeColorInterpolate()

void tlp::GlGraphRenderingParameters::setEdgeColorInterpolate

(

const bool

state

)

Activate or deactivate interpolation of nodes colors along edge.

Examples:

graph_display/graph_display.cpp.

setEdgeFrontDisplay()

void tlp::GlGraphRenderingParameters::setEdgeFrontDisplay

(

const bool

state

)

Activate or deactivate edge display in front of the scene.

setEdgeSizeInterpolate()

void tlp::GlGraphRenderingParameters::setEdgeSizeInterpolate

(

const bool

state

)

Activate or deactivate interpolation of nodes colors along edge.

Examples:

graph_display/graph_display.cpp.

setEdgesLabelStencil()

void tlp::GlGraphRenderingParameters::setEdgesLabelStencil

(

const int

stencil

)

set stencil number for edges label

See setSelectedNodesStencil() documentation for more details on stencil number

setEdgesMaxSizeToNodesSize()

void tlp::GlGraphRenderingParameters::setEdgesMaxSizeToNodesSize

(

const bool

b

)

set if Edge max size is block to node size

setEdgesStencil()

void tlp::GlGraphRenderingParameters::setEdgesStencil

(

const int

stencil

)

set stencil number for edges

See setSelectedNodesStencil() documentation for more details on stencil number

setElementOrdered()

void tlp::GlGraphRenderingParameters::setElementOrdered

(

const bool

state

)

If true node and edges are ordered according to the element ordering property (default to viewMetric)

setElementOrderedDescending()

void tlp::GlGraphRenderingParameters::setElementOrderedDescending

(

const bool

state

)

If true (default value) nodes and edges are sorted in descending order according to the element ordering property (default to viewMetric)

Since

Tulip 4.8

setElementOrderingProperty()

void tlp::GlGraphRenderingParameters::setElementOrderingProperty

(

tlp::NumericProperty *

property

)

Defines which property is used for the element ordering.

Parameters

property

The property to use to order the elements.

setElementZOrdered()

void tlp::GlGraphRenderingParameters::setElementZOrdered

(

const bool

state

)

If true node and edges are ordered according to the distance with camera.

setFeedbackRender()

void tlp::GlGraphRenderingParameters::setFeedbackRender

(

bool

feedback

)

if true draw graph with feedback information (very low)

setFontsPath()

void tlp::GlGraphRenderingParameters::setFontsPath

(

const std::string &

path

)

Set the absolute path used for the fonts loading.

setFontsType()

void tlp::GlGraphRenderingParameters::setFontsType

(

unsigned int

type

)

Set fonts type used in the renderer (0=3D,1=bitmap,2=texture)

setLabelFixedFontSize()

void tlp::GlGraphRenderingParameters::setLabelFixedFontSize

(

bool

state

)

Set if labels must be rendered with a fixed font size (dynamic size otherwise)

setLabelsAreBillboarded()

void tlp::GlGraphRenderingParameters::setLabelsAreBillboarded ( bool  billboarded )

inline

Set if labels are billboarded.

Definition at line 503 of file GlGraphRenderingParameters.h.

setLabelsBorder()

void tlp::GlGraphRenderingParameters::setLabelsBorder

(

const unsigned

int

)

Get the size of label border.

Get the size of the border that is added to any label when using bitmap fonts. Setting this parameter to a high value enables de reduce the label density in the final drawing. Default value is set to 2 which enables readable labels.

Deprecated:

Use setLabelsDensity instead

setLabelScaled()

void tlp::GlGraphRenderingParameters::setLabelScaled

(

bool

state

)

Set if labels are scaled to node size

Examples:

graph_display/graph_display.cpp.

setLabelsDensity()

void tlp::GlGraphRenderingParameters::setLabelsDensity

(

int

density

)

Set labels density.

This density must be in interval -100 100 -100 : No labels 0 : No overlap 100 : All labels

setMaxSizeOfLabel()

void tlp::GlGraphRenderingParameters::setMaxSizeOfLabel

(

int

size

)

Set max size of label : this max size is only used if labels are not scaled and are not rendered with a fixed font size.

setMetaNodesLabelStencil()

void tlp::GlGraphRenderingParameters::setMetaNodesLabelStencil

(

const int

stencil

)

set stencil number for meta-nodes label

See setSelectedNodesStencil() documentation for more details on stencil number

setMetaNodesStencil()

void tlp::GlGraphRenderingParameters::setMetaNodesStencil

(

const int

stencil

)

set stencil number for meta-nodes

See setSelectedNodesStencil() documentation for more details on stencil number

setMinSizeOfLabel()

void tlp::GlGraphRenderingParameters::setMinSizeOfLabel

(

int

size

)

Set min size of label : this min size is only used if labels are not scaled and are not rendered with a fixed font size.

setNodesLabelStencil()

void tlp::GlGraphRenderingParameters::setNodesLabelStencil

(

const int

stencil

)

set stencil number for nodes label

See setSelectedNodesStencil() documentation for more details on stencil number

setNodesStencil()

void tlp::GlGraphRenderingParameters::setNodesStencil

(

const int

stencil

)

set stencil number for nodes

See setSelectedNodesStencil() documentation for more details on stencil number

setParameters()

void tlp::GlGraphRenderingParameters::setParameters

(

const DataSet &

)

Set parameters with a DataSet structure.

setSelectedEdgesStencil()

void tlp::GlGraphRenderingParameters::setSelectedEdgesStencil

(

const int

stencil

)

set stencil number for selected edges

See setSelectedNodesStencil() documentation for more details on stencil number

setSelectedMetaNodesStencil()

void tlp::GlGraphRenderingParameters::setSelectedMetaNodesStencil

(

const int

stencil

)

set stencil number for selected meta-nodes

See setSelectedNodesStencil() documentation for more details on stencil number

setSelectedNodesStencil()

void tlp::GlGraphRenderingParameters::setSelectedNodesStencil

(

const int

stencil

)

set stencil number for selected nodes

Stencil is an OpenGl system to ensure that other entity can't be displayed above this entity. It's a "guaranted visibility" system. A small number causes a guaranted visibility Default value in Tulip is 0xFFFF (greater integer) And when we have stencil on entity value is 0x2

setSelectionColor()

void tlp::GlGraphRenderingParameters::setSelectionColor

(

const Color &

color

)

Change the selection color.

setTexturePath()

void tlp::GlGraphRenderingParameters::setTexturePath

(

const std::string &

path

)

Set the path for the texture loading.

setViewArrow()

void tlp::GlGraphRenderingParameters::setViewArrow

(

const bool

state

)

Activate or deactivate displaying of arrows along the graph's edges.

Examples:

graph_display/graph_display.cpp.

setViewEdgeLabel()

void tlp::GlGraphRenderingParameters::setViewEdgeLabel

(

const bool

state

)

Activate or deactivate displaying of labels on nodes.

setViewMetaLabel()

void tlp::GlGraphRenderingParameters::setViewMetaLabel

(

const bool

state

)

If true and if labels are activated label inside meta nodes will be displayed.

setViewNodeLabel()

void tlp::GlGraphRenderingParameters::setViewNodeLabel

(

const bool

state

)

Activate or deactivate displaying of labels on nodes.

setViewOutScreenLabel()

void tlp::GlGraphRenderingParameters::setViewOutScreenLabel

(

const bool

state

)

Activate or deactivate displaying of labels outside the screen.