IlvDoubleLinkImage Class Reference

Implementation of links drawn with 3 orthogonal segments. More...

#include <ilviews/grapher/links.h>

Inheritance diagram for IlvDoubleLinkImage:

List of all members.

Public Member Functions
	IlvDoubleLinkImage (IlvDisplay *display, IlvLinkOrientation orientation, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
	Constructor.
	IlvDoubleLinkImage (IlvDisplay *display, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
	Constructor.
IlBoolean	getFixedOrientation (IlvLinkOrientation &orient) const
	Returns the orientation mode of the link.
virtual IlvPoint *	getLinkPoints (IlUInt &nPoints, const IlvTransformer *t=0) const
	Returns the points defining the shape of the link.
void	setFixedOrientation (IlBoolean fixed, IlvLinkOrientation orient=IlvHorizontal)
	Modifies the orientation mode of the link.

---

Detailed Description

Implementation of links drawn with 3 orthogonal segments.

Library: ilvgrapher

Links of the IlvDoubleLinkImage class are made of three lines forming two right angles to connect nodes of the grapher, as shown in the following figure:

- IlvDoubleLinkImage -

The layout of the three segments can follow two modes that can be set by the IlvDoubleLinkImage::setFixedOrientation method:

• Automatic: The orientation of the segments depends on the vertical and horizontal separation between the two nodes. The middle segment takes the orientation of the largest separation.
• Fixed: The orientation of the link is fixed and specifies the direction (horizontal or vertical) the link takes upon leaving the starting node.

---

Constructor & Destructor Documentation

IlvDoubleLinkImage::IlvDoubleLinkImage	(	IlvDisplay *	display,
		IlBoolean	oriented,
		IlvGraphic *	from,
		IlvGraphic *	to,
		IlvPalette *	palette = 0
	)

Constructor.

The constructor initializes a new instance of the IlvDoubleLinkImage class with an automatic orientation layout.

Parameters:

	display	The display connection that handles the drawing of the object.
	oriented	A Boolean indicating whether an arrowhead is to be drawn at the end of the link.
	from	The IlvGraphic object representing the start node of the link.
	to	The IlvGraphic object representing the end node of the link.
	palette	The palette used to draw the link.

IlvDoubleLinkImage::IlvDoubleLinkImage	(	IlvDisplay *	display,
		IlvLinkOrientation	orientation,
		IlBoolean	oriented,
		IlvGraphic *	from,
		IlvGraphic *	to,
		IlvPalette *	palette = 0
	)

Constructor.

The constructor initializes a new instance of the IlvDoubleLinkImage class with an orientation fixed to orientation.

Parameters:

	display	The display connection that handles the drawing of this object.
	orientation	The fixed orientation for the link.
	oriented	A Boolean indicating whether an arrowhead is to be drawn at the end of the link.
	from	The IlvGraphic object representing the start node of the link.
	to	The IlvGraphic object representing the end node of the link.
	palette	The palette used to draw the link.

See also:

IlvDoubleLinkImage::setFixedOrientation.

---

Member Function Documentation

IlBoolean IlvDoubleLinkImage::getFixedOrientation

(

IlvLinkOrientation &

orient

)

const

Returns the orientation mode of the link.

Parameters:

orient

Returns the value of the fixed orientation (relevant only if the method returns IlTrue).

Returns:

fixed IlFalse if the orientation is automatic or IlTrue if it is fixed.

See also:

setFixedOrientation.

virtual IlvPoint* IlvDoubleLinkImage::getLinkPoints	(	IlUInt &	nPoints,
		const IlvTransformer *	t = 0
	)			const [virtual]

Returns the points defining the shape of the link.

Returns an array of points defining the shape of the link when it is drawn with the transformer t. The size of the resulting array of points is returned in the nPoints parameter. The array is stored in an IlPoolOf(IlvPoint) and should not be deleted or modified.
This method is internally used by the methods draw, contains, and boundingBox. It is meant to replace various methods defined in subclasses in previous releases of Rogue Wave Views; like the obsolete IlvOneLinkImage::getPoints.
This function is overloaded by subclasses defining a specific shape for links. The default implementation returns an array of two points computed with the IlvLinkImage::computePoints method.

Parameters:

	nPoints	The number of points in the returned array.
	t	The transformer applied to the link.

Returns:

The points defining the shape of the link.

Reimplemented from IlvLinkImage.

void IlvDoubleLinkImage::setFixedOrientation	(	IlBoolean	fixed,
		IlvLinkOrientation	orient = IlvHorizontal
	)

Modifies the orientation mode of the link.

If fixed is IlFalse, the orientation will be computed from the relative position of the nodes. If it is IlTrue, the orientation will be fixed by the value orient (either IlvHorizontalLink or IlvVerticalLink).

Parameters:

	fixed	IlFalse if the orientation is automatic or IlTrue if it is fixed.
	orient	The new fixed orientation (relevant only if fixed is IlTrue).