IlvNodeSideFilter Class Reference

An interface used to define complex requirements concerning the connection of the links to the different sides of the nodes. More...

#include <ilviews/layout/orthlink.h>

Public Member Functions
virtual IlBoolean	accept (IlvGraphModel *graphModel, IlAny link, IlBoolean origin, IlAny node, IlUInt side)=0
	Allows or prohibits the connection of link on a given side of the node node. More...

Detailed Description

An interface used to define complex requirements concerning the connection of the links to the different sides of the nodes.

Library: ilvorthlink

The IlvNodeSideFilter can be used by the link layout algorithms to provide the user the capability to allow or prohibit the links to be connected on given sides (top/bottom/right/left) of the nodes.

See Also

IlvOrthogonalLinkLayout::setNodeSideFilter.

Member Function Documentation

virtual IlBoolean IlvNodeSideFilter::accept ( IlvGraphModel *  graphModel, IlAny  link, IlBoolean  origin, IlAny  node, IlUInt  side  )

pure virtual

Allows or prohibits the connection of link on a given side of the node node.

Returns IlTrue if the connection is allowed and IlFalse otherwise.

This method can be called by link layout algorithms. You can implement this method in order to define complex requirements concerning the connection of the links to the different sides of nodes. For example, if you want all links to be connected to any side except the top side of the nodes, you could use:
return (side != IlvTop);

Parameters

graphModel	The graph model to which the node belongs.
link	The link to be connected to the node.
origin	If IlTrue, the method determines whether the link origin can be connected. Otherwise, the method determines if the link destination can be connected.
node	The node.
side	The side of the node. Valid values are IlvTop, IlvBottom, IlvLeft, and IlvRight.

Returns

IlTrue when the specified extremity of link can be connected on node on the side defined by the argument side.