Layout Macros

Detailed Description

This group lists macros for accessing data of the GlgGraphLayout object.

Macros
#define	GlgGraphDefEdgeIcon()
	Gets or sets the default edge icon to use if no palette is defined (GlgObject). More...
#define	GlgGraphDefNodeIcons()
	Gets or sets the group of default node icons to use if no palette is defined (GlgObject). More...
#define	GlgGraphDimensions(graph)
	Provides access to the dimensions of the graph rendering in the GLG world coordinates. More...
#define	GlgGraphEdgeArray(graph)
	Returns an array of all graph's edges. More...
#define	GlgGraphEndTemperature(graph)
	Gets or sets the end "temperature" defining the end of the layout process (double, 0.1 by default). More...
#define	GlgGraphFinished(graph)
	Returns layout completion state. More...
#define	GlgGraphIteration(graph)
	Returns current iteration number. More...
#define	GlgGraphNodeArray(graph)
	Returns an array of all graph's nodes. More...
#define	GlgGraphNumLinks(graph)
	Returns the number of edge links in the graph. More...
#define	GlgGraphNumNodes(graph)   ;
	Returns the number of nodes in the graph. More...
#define	GlgGraphPalette(graph)
	Returns graph's palette object used to define node and edge icons. More...
#define	GlgGraphUpdateRate(graph)
	Gets or sets the graph update rate for the spring embedder layout (int). More...
#define	GlgGraphZ(graph)
	Gets or sets the Z coordinate of the graph nodes (double, 0 by default). More...

Macro Definition Documentation

GlgGraphDefEdgeIcon

#define GlgGraphDefEdgeIcon

(

)

Gets or sets the default edge icon to use if no palette is defined (GlgObject).

GlgGraphDefNodeIcons

#define GlgGraphDefNodeIcons

(

)

Gets or sets the group of default node icons to use if no palette is defined (GlgObject).

GlgGraphDimensions

#define GlgGraphDimensions

(

graph

)

Provides access to the dimensions of the graph rendering in the GLG world coordinates.

Parameters

graph

GlgGraphLayout instance.

Returns

A pointer to the GlgCube structure containing graph dimensions in the GLG world coordinates.

The graph dimensions control the extent used to position the graph's nodes during the layout ([-800; +800] by default) and may be set before performing the layout.

GlgGraphEdgeArray

#define GlgGraphEdgeArray

(

graph

)

Returns an array of all graph's edges.

Parameters

graph

GlgGraphLayout instance.

Returns

An array containing all graph's edges (GlgObject).

GlgGraphEndTemperature

#define GlgGraphEndTemperature

(

graph

)

Gets or sets the end "temperature" defining the end of the layout process (double, 0.1 by default).

When a node is created via GlgGraphAddNode, its "temperature" is set to 1. The temperature is adjusted by GlgGraphSpringIterate as it performs the layout, and the iterations stop when the average temperature of all nodes drops below the value of GlgGraphEndTemperature.

Parameters

graph

GlgGraphLayout instance.

GlgGraphFinished

#define GlgGraphFinished

(

graph

)

Returns layout completion state.

Parameters

graph

GlgGraphLayout instance.

Returns

True when graph layout finishes positioning the nodes, False otherwise.

GlgGraphIteration

#define GlgGraphIteration

(

graph

)

Returns current iteration number.

Parameters

graph

GlgGraphLayout instance.

Returns

The current value of the layout iteration counter (int).

GlgGraphNodeArray

#define GlgGraphNodeArray

(

graph

)

Returns an array of all graph's nodes.

Parameters

graph

GlgGraphLayout instance.

Returns

An array containing all graph's nodes (GlgObject).

GlgGraphNumLinks

#define GlgGraphNumLinks

(

graph

)

Returns the number of edge links in the graph.

Parameters

graph

GlgGraphLayout instance.

Returns

Number of links (int).

GlgGraphNumNodes

#define GlgGraphNumNodes

(

graph

)

;

Returns the number of nodes in the graph.

Parameters

graph

GlgGraphLayout instance.

Returns

Number of nodes (int).

GlgGraphPalette

#define GlgGraphPalette

(

graph

)

Returns graph's palette object used to define node and edge icons.

Parameters

graph

GlgGraphLayout instance.

Returns

Graph's palette (GlgObject).

GlgGraphUpdateRate

#define GlgGraphUpdateRate

(

graph

)

Gets or sets the graph update rate for the spring embedder layout (int).

The GlgGraphSpringIterate function will update the graph's rendering after every number of iterations specified by GlgGraphUpdateRate.

Parameters

graph

GlgGraphLayout instance.

GlgGraphZ

#define GlgGraphZ

(

graph

)

Gets or sets the Z coordinate of the graph nodes (double, 0 by default).

Parameters

graph

GlgGraphLayout instance.