Edge Macros

Detailed Description

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

Macros
#define	GlgEdgeData(edge)
	Return data associated with the edge. More...
#define	GlgEdgeEndNode(edge)
	Return the edge's end node. More...
#define	GlgEdgeExternal(node)
	Returns the edge's external flag. More...
#define	GlgEdgeGraphics(edge)
	Returns the graphic object used to render the edge. More...
#define	GlgEdgeStartNode(edge)
	Return the edge's start node. More...
#define	GlgEdgeType(edge)
	Returns edge type. More...

Macro Definition Documentation

GlgEdgeData

#define GlgEdgeData

(

edge

)

Return data associated with the edge.

Parameters

edge	GlgGraphEdge instance.

Returns

Data attached to the edge (void*).

GlgEdgeEndNode

#define GlgEdgeEndNode

(

edge

)

Return the edge's end node.

Parameters

edge	GlgGraphEdge instance.

Returns

The edge's end node (GlgGraphNode).

GlgEdgeExternal

#define GlgEdgeExternal

(

node

)

Returns the edge's external flag.

Parameters

node	GlgGraphEdge instance.

Returns

True if the edge is external, False otherwise.

External edges are created by passing edge_type=-1 to the GlgGraphAddEdge function, see GlgGraphAddEdge.

GlgEdgeGraphics

#define GlgEdgeGraphics

(

edge

)

Returns the graphic object used to render the edge.

Parameters

edge	GlgGraphEdge instance.

Returns

The graphic object used to render the edge (GlgObject).

GlgEdgeStartNode

#define GlgEdgeStartNode

(

edge

)

Return the edge's start node.

Parameters

edge	GlgGraphEdge instance.

Returns

The edge's start node (GlgGraphNode).

GlgEdgeType

#define GlgEdgeType

(

edge

)

Returns edge type.

It is a palette index used for selecting different edge icons from the palette.

Parameters

edge	GlgGraphEdge instance.

Returns

Edge type (int).