tulipogl module API

tlp.GlGraphRenderingParameters

class tlp.GlGraphRenderingParameters

New in version 3.8.

That class holds all the rendering parameters for a Tulip OpenGL graph drawing.

getDisplayFilteringProperty()

Returns the boolean property used to filter the rendering of graph elements.

Return type:tulip.tlp.BooleanProperty
getEdgesLabelStencil()

Returns the stencil value for edges labels.

Return type:integer
getEdgesStencil()

Returns the stencil value for edges.

Return type:integer
getElementOrderingProperty()

Returns the double property used for the ordered rendering of graph elements.

Return type:tulip.tlp.DoubleProperty
getFontsPath()

Returns the absolute path used for fonts loading (.ttf files).

Return type:string
getLabelsAreBillboarded()

Returns the state of the labels billboarding (always facing the camera).

Return type:boolean
getLabelsDensity()

Returns the labels density value.

Return type:integer
getMaxSizeOfLabel()

Returns the maximum size of labels. That value is only used if the labels are not scaled to nodes sizes.

Return type:integer
getMetaNodesLabelStencil()

Returns the stencil value for meta-nodes labels.

Return type:integer
getMetaNodesStencil()

Returns the stencil value for meta-nodes.

Return type:integer
getMinSizeOfLabel()

Returns the minimum size of labels. That value is only used if the labels are not scaled to nodes sizes.

Return type:integer
getNodesLabelStencil()

Returns the stencil value for nodes labels.

Return type:integer
getNodesStencil()

Returns the stencil value for nodes.

Return type:integer
getPointModeLOD()

Returns the Level Of Detail threshold below which point rendering for nodes and edges (typically when far from the camera) is activated.

Return type:float
getSelectedEdgesStencil()

Returns the stencil value for selected edges.

Return type:integer
getSelectedMetaNodesStencil()

Returns the stencil value for selected meta-nodes.

Return type:integer
getSelectedNodesStencil()

Returns the stencil value for selected nodes.

Return type:integer
getSelectionColor()

Returns the color of selection.

Return type:tulip.tlp.Color
getTexturePath()

Returns the absolute path used for texture loading.

Return type:string
isAntialiased()

Returns if antialiasing rendering is activated.

Return type:boolean
isDisplayEdges()

Returns the state of the displaying of edges.

Return type:boolean
isDisplayMetaNodes()

Returns the state of the displaying of meta-nodes.

Return type:boolean
isDisplayNodes()

Returns the state of the displaying of nodes.

Return type:boolean
isEdge3D()

Returns the state of the 3d edge rendering.

Return type:boolean
isEdgeColorInterpolate()

Returns the state of the edge color interpolation.

Return type:boolean
isEdgeSizeInterpolate()

Returns the state of the edge size interpolation.

Return type:boolean
isElementOrdered()

Returns the state of the ordered rendering of graph elements.

Return type:boolean
isElementZOrdered()

Returns the state of the z-ordered rendering.

Return type:boolean
isLabelScaled()

Returns the state of the scaling of labels to nodes sizes.

Return type:boolean
isViewArrow()

Returns the state of the displaying of arrows along the graph edges.

Return type:boolean
isViewEdgeLabel()

Returns the state of the displaying of edges labels.

Return type:boolean
isViewMetaLabel()

Returns the state of the displaying of labels inside meta-nodes.

Return type:boolean
isViewNodeLabel()

Returns the state of the displaying of nodes labels.

Return type:boolean
isViewOutScreenLabel()

Returns the state of the displaying of labels for elements outside the screen.

Return type:boolean
setAntialiasing()

Activates/desactivates antialiasing.

Parameters:antialiasing (boolean) – the antialiasing state
setDisplayEdges(displayEdges)

Activates / desactivates the displaying of edges.

Parameters:displayEdges (boolean) – the state of the displaying of edges.
setDisplayFilteringProperty(property)

Sets the boolean property used to filter the rendering of graph elements. If sets to None, the filtering is desactivated. If the value for a node / edge in that property is False, it will not be displayed.

Parameters:property (tulip.tlp.BooleanProperty) – the boolean property used to filter the rendering of graph elements
setDisplayMetaNodes(displayMetaNodes)

Activates / desactivates the displaying of nodes.

Parameters:displayMetaNodes (boolean) – the state of the displaying of meta-nodes.
setDisplayNodes(displayNodes)

Activates / desactivates the displaying of nodes.

Parameters:displayNodes (boolean) – the state of the displaying of nodes.
setEdge3D(edge3d)

Activates / desactivates the 3d displaying of edges instead of 2d lines.

Parameters:edge3d (boolean) – the state of the 3d edge rendering
setEdgeColorInterpolate(interpolate)

Activates / desactivates the interpolation of nodes colors along edges.

Parameters:interpolate (boolean) – the state of the edge color interpolation
setEdgeSizeInterpolate(interpolate)

Activates / desactivates the interpolation of nodes sizes along edges.

Parameters:interpolate (boolean) – the state of the edge size interpolation
setEdgesLabelStencil(stencil)

Sets the stencil value for edges labels. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255.

Parameters:stencil (integer) – a value in the range [0, 255]
setEdgesStencil(stencil)

Sets the stencil value for edges. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255.

Parameters:stencil (integer) – a value in the range [0, 255]
setElementOrdered(elementOrdered)

Activates / desactivates the ordered rendering of graph elements according to the values in the “viewMetric” double property.

Parameters:elementsOrdered – the state of the ordered rendering
setElementOrderingProperty(property)

Defines which property should be used for the ordered rendering of graph elements. Setting it to None will use the “viewMetric” property if the ordering is enabled.

Parameters:property (tulip.tlp.DoubleProperty) – the property to use to order the rendering of graph elements
setElementZOrdered(zOrdering)

Activates / desactivates the ordered rendering of elements according to their distance to the camera.

Parameters:zOrdering (boolean) – the state of the z-ordered rendering
setFontsPath(path)

Sets the absolute path for fonts loading (.ttf files).

Parameters:path (string) – the absolute path of a directory for fonts loading.
setLabelScaled(labelScaled)

Activates / desactivates the scaling of labels to nodes sizes.

Parameters:labelScaled (boolean) – the state of the scaling of labels to nodes sizes.
setLabelsAreBillboarded(billboardLabels)

Activates / desactivates labels billboarding (always facing the camera).

Parameters:billboardLabels (boolean) – the state of labels billboarding
setLabelsDensity(density)

Sets the labels density value. It must be in the range [-100, 100]. The labels are displayed according to that value :

  • -100 : no labels are displayed
  • 0 : only non overlapping labels are displayed
  • 100 : all labels are displayed
Parameters:density (integer) – a value in the range [-100, 100]
setMaxSizeOfLabel(size)

Sets the maximum size of labels. That value is only used if the labels are not scaled to nodes sizes.

Parameters:size – the maximum size of labels
Type :integer
setMetaNodesLabelStencil()

Sets the stencil value for meta-nodes labels. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255.

Parameters:stencil (integer) – a value in the range [0, 255]
setMetaNodesStencil(stencil)

Sets the stencil value for meta-nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255.

Parameters:stencil (integer) – a value in the range [0, 255]
setMinSizeOfLabel(size)

Sets the minimum size of labels. That value is only used if the labels are not scaled to nodes sizes.

Parameters:size – the minimum size of labels
Type :integer
setNodesLabelStencil(stencil)

Sets the stencil value for nodes labels. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255.

Parameters:stencil (integer) – a value in the range [0, 255]
setNodesStencil(stencil)

Sets the stencil value for nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255.

Parameters:stencil (integer) – a value in the range [0, 255]
setPointModeLOD(lod)

Sets the Level Of Detail threshold below which point rendering for nodes and edges (typically when far from the camera) is activated.

Parameters:lod (float) – the Level Of Detail threshold value
setSelectedEdgesStencil(stencil)

Sets the stencil value for selected edges. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 2.

Parameters:stencil (integer) – a value in the range [0, 255]
setSelectedMetaNodesStencil(stencil)

Sets the stencil value for selected meta-nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 2.

Parameters:stencil (integer) – a value in the range [0, 255]
setSelectedNodesStencil(stencil)

Sets the stencil value for selected nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 2.

Parameters:stencil (integer) – a value in the range [0, 255]
setSelectionColor(color)

Sets the color of selected elements.

Parameters:color (tulip.tlp.Color) – the selection color
setTexturePath(path)

Sets the absolute path for textures loading.

Parameters:path (string) – the absolute path of a directory for textures loading.
setViewArrow(arrow)

Activates / desactivates the displaying of arrows along the graph edges.

Parameters:arrow (boolean) – the state of the arrows rendering
setViewEdgeLabel(edgeLabel)

Activates / desactivates the displaying of edges labels.

Parameters:edgeLabel (boolean) – the state of the edges labels rendering
setViewMetaLabel(metaLabel)

Activates / desactivates the displaying of labels inside meta-nodes.

Parameters:metaLabel – the state of the displaying of labels inside meta-nodes.
setViewNodeLabel(nodeLabel)

Activates / desactivates the displaying of nodes labels.

Parameters:nodeLabel (boolean) – the state of the nodes labels rendering
setViewOutScreenLabel(outScreenLabel)

Activates / desactivates the displaying of labels for elements outside the screen.

Parameters:outScreenLabel (boolean) – the state of the labels rendering for elements outside the screen.

Table Of Contents

Previous topic

tulipplugins module API

Next topic

tulipgui module API

This Page